ApiQueryLinks::getAllowedParams() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

ApiQueryLinks::getAllowedParams() B
last analyzed 2016-11-13 17:42 UTC

↳ Parent: ApiQueryLinks

Complexity

Conditions	1
Paths	1

Size

Total Lines	28
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	20
nc	1
nop	0
dl	0
loc	28
rs	8.8571
c	0
b	0
f	0

<?php
/**
 *
 *
 * Created on May 12, 2007
 *
 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
 *
 * 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
 */

/**
 * A query module to list all wiki links on a given set of pages.
 *
 * @ingroup API
 */
class ApiQueryLinks extends ApiQueryGeneratorBase {

	const LINKS = 'links';
	const TEMPLATES = 'templates';

	private $table, $prefix, $helpUrl;


	public function __construct( ApiQuery $query, $moduleName ) {
		switch ( $moduleName ) {
			case self::LINKS:
				$this->table = 'pagelinks';
				$this->prefix = 'pl';
				$this->titlesParam = 'titles';
class MyClass { }

$x = new MyClass();
$x->foo = true;
				$this->helpUrl = 'https://www.mediawiki.org/wiki/API:Links';
				break;
			case self::TEMPLATES:
				$this->table = 'templatelinks';
				$this->prefix = 'tl';
				$this->titlesParam = 'templates';
				$this->helpUrl = 'https://www.mediawiki.org/wiki/API:Templates';
				break;
			default:
				ApiBase::dieDebug( __METHOD__, 'Unknown module name' );
		}

		parent::__construct( $query, $moduleName, $this->prefix );
	}

	public function execute() {
		$this->run();
	}

	public function getCacheMode( $params ) {
		return 'public';
	}

	public function executeGenerator( $resultPageSet ) {
		$this->run( $resultPageSet );
	}

	/**
	 * @param ApiPageSet $resultPageSet
	 */
	private function run( $resultPageSet = null ) {
		if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
			return; // nothing to do
		}

		$params = $this->extractRequestParams();

		$this->addFields( [
			'pl_from' => $this->prefix . '_from',
			'pl_namespace' => $this->prefix . '_namespace',
			'pl_title' => $this->prefix . '_title'
		] );

		$this->addTables( $this->table );
		$this->addWhereFld( $this->prefix . '_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
		$this->addWhereFld( $this->prefix . '_namespace', $params['namespace'] );

		if ( !is_null( $params[$this->titlesParam] ) ) {
			$lb = new LinkBatch;
			foreach ( $params[$this->titlesParam] as $t ) {
				$title = Title::newFromText( $t );
				if ( !$title ) {
					$this->setWarning( "\"$t\" is not a valid title" );
				} else {
					$lb->addObj( $title );
				}
			}
			$cond = $lb->constructSet( $this->prefix, $this->getDB() );
			if ( $cond ) {
				$this->addWhere( $cond );
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
			}
		}

		if ( !is_null( $params['continue'] ) ) {
			$cont = explode( '|', $params['continue'] );
			$this->dieContinueUsageIf( count( $cont ) != 3 );
			$op = $params['dir'] == 'descending' ? '<' : '>';
			$plfrom = intval( $cont[0] );
			$plns = intval( $cont[1] );
			$pltitle = $this->getDB()->addQuotes( $cont[2] );
			$this->addWhere(
				"{$this->prefix}_from $op $plfrom OR " .
				"({$this->prefix}_from = $plfrom AND " .
				"({$this->prefix}_namespace $op $plns OR " .
				"({$this->prefix}_namespace = $plns AND " .
				"{$this->prefix}_title $op= $pltitle)))"
			);
		}

		$sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
		// Here's some MySQL craziness going on: if you use WHERE foo='bar'
		// and later ORDER BY foo MySQL doesn't notice the ORDER BY is pointless
		// but instead goes and filesorts, because the index for foo was used
		// already. To work around this, we drop constant fields in the WHERE
		// clause from the ORDER BY clause
		$order = [];
		if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
			$order[] = $this->prefix . '_from' . $sort;
		}
		if ( count( $params['namespace'] ) != 1 ) {
			$order[] = $this->prefix . '_namespace' . $sort;
		}

		$order[] = $this->prefix . '_title' . $sort;
		$this->addOption( 'ORDER BY', $order );
		$this->addOption( 'USE INDEX', $this->prefix . '_from' );
		$this->addOption( 'LIMIT', $params['limit'] + 1 );

		$res = $this->select( __METHOD__ );

		if ( is_null( $resultPageSet ) ) {
			$count = 0;
			foreach ( $res as $row ) {
				if ( ++$count > $params['limit'] ) {
					// We've reached the one extra which shows that
					// there are additional pages to be had. Stop here...
					$this->setContinueEnumParameter( 'continue',
						"{$row->pl_from}|{$row->pl_namespace}|{$row->pl_title}" );
					break;
				}
				$vals = [];
				ApiQueryBase::addTitleInfo( $vals, Title::makeTitle( $row->pl_namespace, $row->pl_title ) );
				$fit = $this->addPageSubItem( $row->pl_from, $vals );
				if ( !$fit ) {
					$this->setContinueEnumParameter( 'continue',
						"{$row->pl_from}|{$row->pl_namespace}|{$row->pl_title}" );
					break;
				}
			}
		} else {
			$titles = [];
			$count = 0;
			foreach ( $res as $row ) {
				if ( ++$count > $params['limit'] ) {
					// We've reached the one extra which shows that
					// there are additional pages to be had. Stop here...
					$this->setContinueEnumParameter( 'continue',
						"{$row->pl_from}|{$row->pl_namespace}|{$row->pl_title}" );
					break;
				}
				$titles[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
			}
			$resultPageSet->populateFromTitles( $titles );
		}
	}

	public function getAllowedParams() {
		return [
			'namespace' => [
				ApiBase::PARAM_TYPE => 'namespace',
				ApiBase::PARAM_ISMULTI => true
			],
			'limit' => [
				ApiBase::PARAM_DFLT => 10,
				ApiBase::PARAM_TYPE => 'limit',
				ApiBase::PARAM_MIN => 1,
				ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
				ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
			],
			'continue' => [
				ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
			],
			$this->titlesParam => [
				ApiBase::PARAM_ISMULTI => true,
			],
			'dir' => [
				ApiBase::PARAM_DFLT => 'ascending',
				ApiBase::PARAM_TYPE => [
					'ascending',
					'descending'
				]
			],
		];
	}

	protected function getExamplesMessages() {
		$name = $this->getModuleName();
		$path = $this->getModulePath();

		return [
			"action=query&prop={$name}&titles=Main%20Page"
				=> "apihelp-{$path}-example-simple",
			"action=query&generator={$name}&titles=Main%20Page&prop=info"
				=> "apihelp-{$path}-example-generator",
			"action=query&prop={$name}&titles=Main%20Page&{$this->prefix}namespace=2|10"
				=> "apihelp-{$path}-example-namespaces",
		];
	}

	public function getHelpUrls() {
		return $this->helpUrl;
	}
}


1		<?php
2		/**
3		*
4		*
5		* Created on May 12, 2007
6		*
7		* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
8		*
9		* This program is free software; you can redistribute it and/or modify
10		* it under the terms of the GNU General Public License as published by
11		* the Free Software Foundation; either version 2 of the License, or
12		* (at your option) any later version.
13		*
14		* This program is distributed in the hope that it will be useful,
15		* but WITHOUT ANY WARRANTY; without even the implied warranty of
16		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17		* GNU General Public License for more details.
18		*
19		* You should have received a copy of the GNU General Public License along
20		* with this program; if not, write to the Free Software Foundation, Inc.,
21		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22		* http://www.gnu.org/copyleft/gpl.html
23		*
24		* @file
25		*/
26
27		/**
28		* A query module to list all wiki links on a given set of pages.
29		*
30		* @ingroup API
31		*/
32		class ApiQueryLinks extends ApiQueryGeneratorBase {
33
34		const LINKS = 'links';
35		const TEMPLATES = 'templates';
36
37		private $table, $prefix, $helpUrl;
		0 ignored issues – show Coding Style introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It is generally advisable to only define one property per statement. Only declaring a single property per statement allows you to later on add doc comments more easily. It is also recommended by PSR2, so it is a common style that many people expect. Loading history...
38
39		public function __construct( ApiQuery $query, $moduleName ) {
40		switch ( $moduleName ) {
41		case self::LINKS:
42		$this->table = 'pagelinks';
43		$this->prefix = 'pl';
44		$this->titlesParam = 'titles';
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `titlesParam` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
45		$this->helpUrl = 'https://www.mediawiki.org/wiki/API:Links';
46		break;
47		case self::TEMPLATES:
48		$this->table = 'templatelinks';
49		$this->prefix = 'tl';
50		$this->titlesParam = 'templates';
51		$this->helpUrl = 'https://www.mediawiki.org/wiki/API:Templates';
52		break;
53		default:
54		ApiBase::dieDebug( __METHOD__, 'Unknown module name' );
55		}
56
57		parent::__construct( $query, $moduleName, $this->prefix );
58		}
59
60		public function execute() {
61		$this->run();
62		}
63
64		public function getCacheMode( $params ) {
65		return 'public';
66		}
67
68		public function executeGenerator( $resultPageSet ) {
69		$this->run( $resultPageSet );
70		}
71
72		/**
73		* @param ApiPageSet $resultPageSet
74		*/
75		private function run( $resultPageSet = null ) {
76		if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
77		return; // nothing to do
78		}
79
80		$params = $this->extractRequestParams();
81
82		$this->addFields( [
83		'pl_from' => $this->prefix . '_from',
84		'pl_namespace' => $this->prefix . '_namespace',
85		'pl_title' => $this->prefix . '_title'
86		] );
87
88		$this->addTables( $this->table );
89		$this->addWhereFld( $this->prefix . '_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
90		$this->addWhereFld( $this->prefix . '_namespace', $params['namespace'] );
91
92		if ( !is_null( $params[$this->titlesParam] ) ) {
93		$lb = new LinkBatch;
94		foreach ( $params[$this->titlesParam] as $t ) {
95		$title = Title::newFromText( $t );
96		if ( !$title ) {
97		$this->setWarning( "\"$t\" is not a valid title" );
98		} else {
99		$lb->addObj( $title );
100		}
101		}
102		$cond = $lb->constructSet( $this->prefix, $this->getDB() );
103		if ( $cond ) {
104		$this->addWhere( $cond );
		0 ignored issues – show Bug introduced 2016-02-23 18:13 UTC by Report Bug Copy Issue Report It seems like `$cond` defined by `$lb->constructSet($this->prefix, $this->getDB())` on line `102` can also be of type `boolean`; however, `ApiQueryBase::addWhere()` does only seem to accept `string\|array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
105		}
106		}
107
108		if ( !is_null( $params['continue'] ) ) {
109		$cont = explode( '\|', $params['continue'] );
110		$this->dieContinueUsageIf( count( $cont ) != 3 );
111		$op = $params['dir'] == 'descending' ? '<' : '>';
112		$plfrom = intval( $cont[0] );
113		$plns = intval( $cont[1] );
114		$pltitle = $this->getDB()->addQuotes( $cont[2] );
115		$this->addWhere(
116		"{$this->prefix}_from $op $plfrom OR " .
117		"({$this->prefix}_from = $plfrom AND " .
118		"({$this->prefix}_namespace $op $plns OR " .
119		"({$this->prefix}_namespace = $plns AND " .
120		"{$this->prefix}_title $op= $pltitle)))"
121		);
122		}
123
124		$sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
125		// Here's some MySQL craziness going on: if you use WHERE foo='bar'
126		// and later ORDER BY foo MySQL doesn't notice the ORDER BY is pointless
127		// but instead goes and filesorts, because the index for foo was used
128		// already. To work around this, we drop constant fields in the WHERE
129		// clause from the ORDER BY clause
130		$order = [];
131		if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
132		$order[] = $this->prefix . '_from' . $sort;
133		}
134		if ( count( $params['namespace'] ) != 1 ) {
135		$order[] = $this->prefix . '_namespace' . $sort;
136		}
137
138		$order[] = $this->prefix . '_title' . $sort;
139		$this->addOption( 'ORDER BY', $order );
140		$this->addOption( 'USE INDEX', $this->prefix . '_from' );
141		$this->addOption( 'LIMIT', $params['limit'] + 1 );
142
143		$res = $this->select( __METHOD__ );
144
145		if ( is_null( $resultPageSet ) ) {
146		$count = 0;
147		foreach ( $res as $row ) {
148	View Code Duplication	if ( ++$count > $params['limit'] ) {
149		// We've reached the one extra which shows that
150		// there are additional pages to be had. Stop here...
151		$this->setContinueEnumParameter( 'continue',
152		"{$row->pl_from}\|{$row->pl_namespace}\|{$row->pl_title}" );
153		break;
154		}
155		$vals = [];
156		ApiQueryBase::addTitleInfo( $vals, Title::makeTitle( $row->pl_namespace, $row->pl_title ) );
157		$fit = $this->addPageSubItem( $row->pl_from, $vals );
158		if ( !$fit ) {
159		$this->setContinueEnumParameter( 'continue',
160		"{$row->pl_from}\|{$row->pl_namespace}\|{$row->pl_title}" );
161		break;
162		}
163		}
164		} else {
165		$titles = [];
166		$count = 0;
167		foreach ( $res as $row ) {
168	View Code Duplication	if ( ++$count > $params['limit'] ) {
169		// We've reached the one extra which shows that
170		// there are additional pages to be had. Stop here...
171		$this->setContinueEnumParameter( 'continue',
172		"{$row->pl_from}\|{$row->pl_namespace}\|{$row->pl_title}" );
173		break;
174		}
175		$titles[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
176		}
177		$resultPageSet->populateFromTitles( $titles );
178		}
179		}
180
181		public function getAllowedParams() {
182		return [
183		'namespace' => [
184		ApiBase::PARAM_TYPE => 'namespace',
185		ApiBase::PARAM_ISMULTI => true
186		],
187		'limit' => [
188		ApiBase::PARAM_DFLT => 10,
189		ApiBase::PARAM_TYPE => 'limit',
190		ApiBase::PARAM_MIN => 1,
191		ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
192		ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
193		],
194		'continue' => [
195		ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
196		],
197		$this->titlesParam => [
198		ApiBase::PARAM_ISMULTI => true,
199		],
200		'dir' => [
201		ApiBase::PARAM_DFLT => 'ascending',
202		ApiBase::PARAM_TYPE => [
203		'ascending',
204		'descending'
205		]
206		],
207		];
208		}
209
210		protected function getExamplesMessages() {
211		$name = $this->getModuleName();
212		$path = $this->getModulePath();
213
214		return [
215		"action=query&prop={$name}&titles=Main%20Page"
216		=> "apihelp-{$path}-example-simple",
217		"action=query&generator={$name}&titles=Main%20Page&prop=info"
218		=> "apihelp-{$path}-example-generator",
219		"action=query&prop={$name}&titles=Main%20Page&{$this->prefix}namespace=2\|10"
220		=> "apihelp-{$path}-example-namespaces",
221		];
222		}
223
224		public function getHelpUrls() {
225		return $this->helpUrl;
226		}
227		}
228

wikimedia / mediawiki

ApiQueryLinks::getAllowedParams() B last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ApiQueryLinks::getAllowedParams() B
last analyzed 2016-11-13 17:42 UTC