summaryrefslogtreecommitdiff
path: root/www/wiki/includes/api/ApiQueryPrefixSearch.php
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/includes/api/ApiQueryPrefixSearch.php')
-rw-r--r--www/wiki/includes/api/ApiQueryPrefixSearch.php132
1 files changed, 132 insertions, 0 deletions
diff --git a/www/wiki/includes/api/ApiQueryPrefixSearch.php b/www/wiki/includes/api/ApiQueryPrefixSearch.php
new file mode 100644
index 00000000..2fbc518b
--- /dev/null
+++ b/www/wiki/includes/api/ApiQueryPrefixSearch.php
@@ -0,0 +1,132 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @since 1.23
+ */
+
+/**
+ * @ingroup API
+ */
+class ApiQueryPrefixSearch extends ApiQueryGeneratorBase {
+ use SearchApi;
+
+ /** @var array list of api allowed params */
+ private $allowedParams;
+
+ public function __construct( $query, $moduleName ) {
+ parent::__construct( $query, $moduleName, 'ps' );
+ }
+
+ public function execute() {
+ $this->run();
+ }
+
+ public function executeGenerator( $resultPageSet ) {
+ $this->run( $resultPageSet );
+ }
+
+ /**
+ * @param ApiPageSet $resultPageSet
+ */
+ private function run( $resultPageSet = null ) {
+ $params = $this->extractRequestParams();
+ $search = $params['search'];
+ $limit = $params['limit'];
+ $offset = $params['offset'];
+
+ $searchEngine = $this->buildSearchEngine( $params );
+ $titles = $searchEngine->extractTitles( $searchEngine->completionSearchWithVariants( $search ) );
+
+ if ( $resultPageSet ) {
+ $resultPageSet->setRedirectMergePolicy( function ( array $current, array $new ) {
+ if ( !isset( $current['index'] ) || $new['index'] < $current['index'] ) {
+ $current['index'] = $new['index'];
+ }
+ return $current;
+ } );
+ if ( count( $titles ) > $limit ) {
+ $this->setContinueEnumParameter( 'offset', $offset + $limit );
+ array_pop( $titles );
+ }
+ $resultPageSet->populateFromTitles( $titles );
+ foreach ( $titles as $index => $title ) {
+ $resultPageSet->setGeneratorData( $title, [ 'index' => $index + $offset + 1 ] );
+ }
+ } else {
+ $result = $this->getResult();
+ $count = 0;
+ foreach ( $titles as $title ) {
+ if ( ++$count > $limit ) {
+ $this->setContinueEnumParameter( 'offset', $offset + $limit );
+ break;
+ }
+ $vals = [
+ 'ns' => intval( $title->getNamespace() ),
+ 'title' => $title->getPrefixedText(),
+ ];
+ if ( $title->isSpecialPage() ) {
+ $vals['special'] = true;
+ } else {
+ $vals['pageid'] = intval( $title->getArticleID() );
+ }
+ $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
+ if ( !$fit ) {
+ $this->setContinueEnumParameter( 'offset', $offset + $count - 1 );
+ break;
+ }
+ }
+ $result->addIndexedTagName(
+ [ 'query', $this->getModuleName() ], $this->getModulePrefix()
+ );
+ }
+ }
+
+ public function getCacheMode( $params ) {
+ return 'public';
+ }
+
+ public function getAllowedParams() {
+ if ( $this->allowedParams !== null ) {
+ return $this->allowedParams;
+ }
+ $this->allowedParams = $this->buildCommonApiParams();
+
+ return $this->allowedParams;
+ }
+
+ public function getSearchProfileParams() {
+ return [
+ 'profile' => [
+ 'profile-type' => SearchEngine::COMPLETION_PROFILE_TYPE,
+ 'help-message' => 'apihelp-query+prefixsearch-param-profile',
+ ],
+ ];
+ }
+
+ protected function getExamplesMessages() {
+ return [
+ 'action=query&list=prefixsearch&pssearch=meaning'
+ => 'apihelp-query+prefixsearch-example-simple',
+ ];
+ }
+
+ public function getHelpUrls() {
+ return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Prefixsearch';
+ }
+}