ApiQueryPrefixSearch::run() - Code Metrics - Inspection of "Daily Inspection: mediawiki.jqueryMsg: Add @since..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (02e057)

unknown

created 2016-06-02 17:36 UTC

ApiQueryPrefixSearch::run() C

↳ Parent: ApiQueryPrefixSearch

Complexity

Conditions	10
Paths	10

Size

Total Lines	52
Code Lines	38

Duplication

Lines	6
Ratio	11.54 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	10
eloc	38
c	1
b	0
f	0
nc	10
nop	1
dl	6
loc	52
rs	6.2553

How to fix Long Method Complexity

<?php
use MediaWiki\MediaWikiServices;

/**
 * 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 = [
			'search' => [
				ApiBase::PARAM_TYPE => 'string',
				ApiBase::PARAM_REQUIRED => true,
			],
			'namespace' => [
				ApiBase::PARAM_DFLT => NS_MAIN,
				ApiBase::PARAM_TYPE => 'namespace',
				ApiBase::PARAM_ISMULTI => true,
			],
			'limit' => [
				ApiBase::PARAM_DFLT => 10,
				ApiBase::PARAM_TYPE => 'limit',
				ApiBase::PARAM_MIN => 1,
				// Non-standard value for compatibility with action=opensearch
				ApiBase::PARAM_MAX => 100,
				ApiBase::PARAM_MAX2 => 200,
			],
			'offset' => [
				ApiBase::PARAM_DFLT => 0,
				ApiBase::PARAM_TYPE => 'integer',
			],
		];
		$profileParam = $this->buildProfileApiParam( SearchEngine::COMPLETION_PROFILE_TYPE,
			'apihelp-query+prefixsearch-param-profile' );
		if ( $profileParam ) {
			$this->allowedParams['profile'] = $profileParam;
		}
		return $this->allowedParams;
	}

	public function getSearchProfileParams() {
		if ( isset( $this->getAllowedParams()['profile'] ) ) {
			return [ SearchEngine::COMPLETION_PROFILE_TYPE => 'profile' ];
		}
		return [];
	}

	protected function getExamplesMessages() {
		return [
			'action=query&list=prefixsearch&pssearch=meaning'
				=> 'apihelp-query+prefixsearch-example-simple',
		];
	}

	public function getHelpUrls() {
		return 'https://www.mediawiki.org/wiki/API:Prefixsearch';
	}
}


1		<?php
2		use MediaWiki\MediaWikiServices;
3
4		/**
5		* This program is free software; you can redistribute it and/or modify
6		* it under the terms of the GNU General Public License as published by
7		* the Free Software Foundation; either version 2 of the License, or
8		* (at your option) any later version.
9		*
10		* This program is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13		* GNU General Public License for more details.
14		*
15		* You should have received a copy of the GNU General Public License along
16		* with this program; if not, write to the Free Software Foundation, Inc.,
17		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18		* http://www.gnu.org/copyleft/gpl.html
19		*
20		* @file
21		* @since 1.23
22		*/
23
24		/**
25		* @ingroup API
26		*/
27		class ApiQueryPrefixSearch extends ApiQueryGeneratorBase {
28		use SearchApi;
29
30		/** @var array list of api allowed params */
31		private $allowedParams;
32
33		public function __construct( $query, $moduleName ) {
34		parent::__construct( $query, $moduleName, 'ps' );
35		}
36
37		public function execute() {
38		$this->run();
39		}
40
41		public function executeGenerator( $resultPageSet ) {
42		$this->run( $resultPageSet );
43		}
44
45		/**
46		* @param ApiPageSet $resultPageSet
47		*/
48		private function run( $resultPageSet = null ) {
49		$params = $this->extractRequestParams();
50		$search = $params['search'];
51		$limit = $params['limit'];
52		$offset = $params['offset'];
53
54		$searchEngine = $this->buildSearchEngine( $params );
55		$titles = $searchEngine->extractTitles( $searchEngine->completionSearchWithVariants( $search ) );
56
57		if ( $resultPageSet ) {
58	View Code Duplication	$resultPageSet->setRedirectMergePolicy( function( array $current, array $new ) {
59		if ( !isset( $current['index'] ) \|\| $new['index'] < $current['index'] ) {
60		$current['index'] = $new['index'];
61		}
62		return $current;
63		} );
64		if ( count( $titles ) > $limit ) {
65		$this->setContinueEnumParameter( 'offset', $offset + $limit );
66		array_pop( $titles );
67		}
68		$resultPageSet->populateFromTitles( $titles );
69		foreach ( $titles as $index => $title ) {
70		$resultPageSet->setGeneratorData( $title, [ 'index' => $index + $offset + 1 ] );
71		}
72		} else {
73		$result = $this->getResult();
74		$count = 0;
75		foreach ( $titles as $title ) {
76		if ( ++$count > $limit ) {
77		$this->setContinueEnumParameter( 'offset', $offset + $limit );
78		break;
79		}
80		$vals = [
81		'ns' => intval( $title->getNamespace() ),
82		'title' => $title->getPrefixedText(),
83		];
84		if ( $title->isSpecialPage() ) {
85		$vals['special'] = true;
86		} else {
87		$vals['pageid'] = intval( $title->getArticleID() );
88		}
89		$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
90		if ( !$fit ) {
91		$this->setContinueEnumParameter( 'offset', $offset + $count - 1 );
92		break;
93		}
94		}
95		$result->addIndexedTagName(
96		[ 'query', $this->getModuleName() ], $this->getModulePrefix()
97		);
98		}
99		}
100
101		public function getCacheMode( $params ) {
102		return 'public';
103		}
104
105		public function getAllowedParams() {
106		if ( $this->allowedParams !== null ) {
107		return $this->allowedParams;
108		}
109		$this->allowedParams = [
110		'search' => [
111		ApiBase::PARAM_TYPE => 'string',
112		ApiBase::PARAM_REQUIRED => true,
113		],
114		'namespace' => [
115		ApiBase::PARAM_DFLT => NS_MAIN,
116		ApiBase::PARAM_TYPE => 'namespace',
117		ApiBase::PARAM_ISMULTI => true,
118		],
119		'limit' => [
120		ApiBase::PARAM_DFLT => 10,
121		ApiBase::PARAM_TYPE => 'limit',
122		ApiBase::PARAM_MIN => 1,
123		// Non-standard value for compatibility with action=opensearch
124		ApiBase::PARAM_MAX => 100,
125		ApiBase::PARAM_MAX2 => 200,
126		],
127		'offset' => [
128		ApiBase::PARAM_DFLT => 0,
129		ApiBase::PARAM_TYPE => 'integer',
130		],
131		];
132		$profileParam = $this->buildProfileApiParam( SearchEngine::COMPLETION_PROFILE_TYPE,
133		'apihelp-query+prefixsearch-param-profile' );
134		if ( $profileParam ) {
135		$this->allowedParams['profile'] = $profileParam;
136		}
137		return $this->allowedParams;
138		}
139
140		public function getSearchProfileParams() {
141		if ( isset( $this->getAllowedParams()['profile'] ) ) {
142		return [ SearchEngine::COMPLETION_PROFILE_TYPE => 'profile' ];
143		}
144		return [];
145		}
146
147		protected function getExamplesMessages() {
148		return [
149		'action=query&list=prefixsearch&pssearch=meaning'
150		=> 'apihelp-query+prefixsearch-example-simple',
151		];
152		}
153
154		public function getHelpUrls() {
155		return 'https://www.mediawiki.org/wiki/API:Prefixsearch';
156		}
157		}
158

wikimedia / mediawiki

Branch — master (02e057)

ApiQueryPrefixSearch::run() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like