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

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

↳ Parent: ApiQueryIWBacklinks

Complexity

Conditions	1
Paths	1

Size

Total Lines	32
Code Lines	24

Duplication

Lines	32
Ratio	100 %

Importance

Changes

Metric	Value
cc	1
eloc	24
nc	1
nop	0
dl	32
loc	32
rs	8.8571
c	0
b	0
f	0

<?php
/**
 * API for MediaWiki 1.17+
 *
 * Created on May 14, 2010
 *
 * Copyright © 2010 Sam Reed
 * 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
 */

/**
 * This gives links pointing to the given interwiki
 * @ingroup API
 */
class ApiQueryIWBacklinks extends ApiQueryGeneratorBase {


	public function __construct( ApiQuery $query, $moduleName ) {
		parent::__construct( $query, $moduleName, 'iwbl' );
	}

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

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

	/**
	 * @param ApiPageSet $resultPageSet
	 * @return void
	 */
	public function run( $resultPageSet = null ) {
		$params = $this->extractRequestParams();

		if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
			$this->dieUsageMsg( [ 'missingparam', 'prefix' ] );
		}

		if ( !is_null( $params['continue'] ) ) {
			$cont = explode( '|', $params['continue'] );
			$this->dieContinueUsageIf( count( $cont ) != 3 );

			$db = $this->getDB();
			$op = $params['dir'] == 'descending' ? '<' : '>';
			$prefix = $db->addQuotes( $cont[0] );
			$title = $db->addQuotes( $cont[1] );
			$from = intval( $cont[2] );
			$this->addWhere(
				"iwl_prefix $op $prefix OR " .
				"(iwl_prefix = $prefix AND " .
				"(iwl_title $op $title OR " .
				"(iwl_title = $title AND " .
				"iwl_from $op= $from)))"
			);
		}

		$prop = array_flip( $params['prop'] );
		$iwprefix = isset( $prop['iwprefix'] );
		$iwtitle = isset( $prop['iwtitle'] );

		$this->addTables( [ 'iwlinks', 'page' ] );
		$this->addWhere( 'iwl_from = page_id' );

		$this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
			'iwl_from', 'iwl_prefix', 'iwl_title' ] );

		$sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
		if ( isset( $params['prefix'] ) ) {
			$this->addWhereFld( 'iwl_prefix', $params['prefix'] );
			if ( isset( $params['title'] ) ) {
				$this->addWhereFld( 'iwl_title', $params['title'] );
				$this->addOption( 'ORDER BY', 'iwl_from' . $sort );
			} else {
				$this->addOption( 'ORDER BY', [
					'iwl_title' . $sort,
					'iwl_from' . $sort
				] );
			}
		} else {
			$this->addOption( 'ORDER BY', [
				'iwl_prefix' . $sort,
				'iwl_title' . $sort,
				'iwl_from' . $sort
			] );
		}

		$this->addOption( 'LIMIT', $params['limit'] + 1 );

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

		$pages = [];

		$count = 0;
		$result = $this->getResult();
		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...
				// Continue string preserved in case the redirect query doesn't
				// pass the limit
				$this->setContinueEnumParameter(
					'continue',
					"{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}"
				);
				break;
			}

			if ( !is_null( $resultPageSet ) ) {
				$pages[] = Title::newFromRow( $row );
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
			} else {
				$entry = [ 'pageid' => $row->page_id ];

				$title = Title::makeTitle( $row->page_namespace, $row->page_title );
				ApiQueryBase::addTitleInfo( $entry, $title );

				if ( $row->page_is_redirect ) {
					$entry['redirect'] = true;
				}

				if ( $iwprefix ) {
					$entry['iwprefix'] = $row->iwl_prefix;
				}

				if ( $iwtitle ) {
					$entry['iwtitle'] = $row->iwl_title;
				}

				$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
				if ( !$fit ) {
					$this->setContinueEnumParameter(
						'continue',
						"{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}"
					);
					break;
				}
			}
		}

		if ( is_null( $resultPageSet ) ) {
			$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'iw' );
		} else {
			$resultPageSet->populateFromTitles( $pages );
		}
	}

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

	public function getAllowedParams() {
		return [
			'prefix' => null,
			'title' => null,
			'continue' => [
				ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
			],
			'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
			],
			'prop' => [
				ApiBase::PARAM_ISMULTI => true,
				ApiBase::PARAM_DFLT => '',
				ApiBase::PARAM_TYPE => [
					'iwprefix',
					'iwtitle',
				],
				ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
			],
			'dir' => [
				ApiBase::PARAM_DFLT => 'ascending',
				ApiBase::PARAM_TYPE => [
					'ascending',
					'descending'
				]
			],
		];
	}

	protected function getExamplesMessages() {
		return [
			'action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks'
				=> 'apihelp-query+iwbacklinks-example-simple',
			'action=query&generator=iwbacklinks&giwbltitle=Test&giwblprefix=wikibooks&prop=info'
				=> 'apihelp-query+iwbacklinks-example-generator',
		];
	}

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


1		<?php
2		/**
3		* API for MediaWiki 1.17+
4		*
5		* Created on May 14, 2010
6		*
7		* Copyright © 2010 Sam Reed
8		* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
9		*
10		* This program is free software; you can redistribute it and/or modify
11		* it under the terms of the GNU General Public License as published by
12		* the Free Software Foundation; either version 2 of the License, or
13		* (at your option) any later version.
14		*
15		* This program is distributed in the hope that it will be useful,
16		* but WITHOUT ANY WARRANTY; without even the implied warranty of
17		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18		* GNU General Public License for more details.
19		*
20		* You should have received a copy of the GNU General Public License along
21		* with this program; if not, write to the Free Software Foundation, Inc.,
22		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23		* http://www.gnu.org/copyleft/gpl.html
24		*
25		* @file
26		*/
27
28		/**
29		* This gives links pointing to the given interwiki
30		* @ingroup API
31		*/
32	View Code Duplication	class ApiQueryIWBacklinks extends ApiQueryGeneratorBase {
		0 ignored issues – show Duplication introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
33
34		public function __construct( ApiQuery $query, $moduleName ) {
35		parent::__construct( $query, $moduleName, 'iwbl' );
36		}
37
38		public function execute() {
39		$this->run();
40		}
41
42		public function executeGenerator( $resultPageSet ) {
43		$this->run( $resultPageSet );
44		}
45
46		/**
47		* @param ApiPageSet $resultPageSet
48		* @return void
49		*/
50		public function run( $resultPageSet = null ) {
51		$params = $this->extractRequestParams();
52
53		if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
54		$this->dieUsageMsg( [ 'missingparam', 'prefix' ] );
55		}
56
57		if ( !is_null( $params['continue'] ) ) {
58		$cont = explode( '\|', $params['continue'] );
59		$this->dieContinueUsageIf( count( $cont ) != 3 );
60
61		$db = $this->getDB();
62		$op = $params['dir'] == 'descending' ? '<' : '>';
63		$prefix = $db->addQuotes( $cont[0] );
64		$title = $db->addQuotes( $cont[1] );
65		$from = intval( $cont[2] );
66		$this->addWhere(
67		"iwl_prefix $op $prefix OR " .
68		"(iwl_prefix = $prefix AND " .
69		"(iwl_title $op $title OR " .
70		"(iwl_title = $title AND " .
71		"iwl_from $op= $from)))"
72		);
73		}
74
75		$prop = array_flip( $params['prop'] );
76		$iwprefix = isset( $prop['iwprefix'] );
77		$iwtitle = isset( $prop['iwtitle'] );
78
79		$this->addTables( [ 'iwlinks', 'page' ] );
80		$this->addWhere( 'iwl_from = page_id' );
81
82		$this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
83		'iwl_from', 'iwl_prefix', 'iwl_title' ] );
84
85		$sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
86		if ( isset( $params['prefix'] ) ) {
87		$this->addWhereFld( 'iwl_prefix', $params['prefix'] );
88		if ( isset( $params['title'] ) ) {
89		$this->addWhereFld( 'iwl_title', $params['title'] );
90		$this->addOption( 'ORDER BY', 'iwl_from' . $sort );
91		} else {
92		$this->addOption( 'ORDER BY', [
93		'iwl_title' . $sort,
94		'iwl_from' . $sort
95		] );
96		}
97		} else {
98		$this->addOption( 'ORDER BY', [
99		'iwl_prefix' . $sort,
100		'iwl_title' . $sort,
101		'iwl_from' . $sort
102		] );
103		}
104
105		$this->addOption( 'LIMIT', $params['limit'] + 1 );
106
107		$res = $this->select( __METHOD__ );
108
109		$pages = [];
110
111		$count = 0;
112		$result = $this->getResult();
113		foreach ( $res as $row ) {
114		if ( ++$count > $params['limit'] ) {
115		// We've reached the one extra which shows that there are
116		// additional pages to be had. Stop here...
117		// Continue string preserved in case the redirect query doesn't
118		// pass the limit
119		$this->setContinueEnumParameter(
120		'continue',
121		"{$row->iwl_prefix}\|{$row->iwl_title}\|{$row->iwl_from}"
122		);
123		break;
124		}
125
126		if ( !is_null( $resultPageSet ) ) {
127		$pages[] = Title::newFromRow( $row );
		0 ignored issues – show Bug introduced 2016-09-19 18:26 UTC by Report Bug Copy Issue Report It seems like `$row` defined by `$row` on line `113` can be `null`; however, `Title::newFromRow()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
128		} else {
129		$entry = [ 'pageid' => $row->page_id ];
130
131		$title = Title::makeTitle( $row->page_namespace, $row->page_title );
132		ApiQueryBase::addTitleInfo( $entry, $title );
133
134		if ( $row->page_is_redirect ) {
135		$entry['redirect'] = true;
136		}
137
138		if ( $iwprefix ) {
139		$entry['iwprefix'] = $row->iwl_prefix;
140		}
141
142		if ( $iwtitle ) {
143		$entry['iwtitle'] = $row->iwl_title;
144		}
145
146		$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
147		if ( !$fit ) {
148		$this->setContinueEnumParameter(
149		'continue',
150		"{$row->iwl_prefix}\|{$row->iwl_title}\|{$row->iwl_from}"
151		);
152		break;
153		}
154		}
155		}
156
157		if ( is_null( $resultPageSet ) ) {
158		$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'iw' );
159		} else {
160		$resultPageSet->populateFromTitles( $pages );
161		}
162		}
163
164		public function getCacheMode( $params ) {
165		return 'public';
166		}
167
168		public function getAllowedParams() {
169		return [
170		'prefix' => null,
171		'title' => null,
172		'continue' => [
173		ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
174		],
175		'limit' => [
176		ApiBase::PARAM_DFLT => 10,
177		ApiBase::PARAM_TYPE => 'limit',
178		ApiBase::PARAM_MIN => 1,
179		ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
180		ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
181		],
182		'prop' => [
183		ApiBase::PARAM_ISMULTI => true,
184		ApiBase::PARAM_DFLT => '',
185		ApiBase::PARAM_TYPE => [
186		'iwprefix',
187		'iwtitle',
188		],
189		ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
190		],
191		'dir' => [
192		ApiBase::PARAM_DFLT => 'ascending',
193		ApiBase::PARAM_TYPE => [
194		'ascending',
195		'descending'
196		]
197		],
198		];
199		}
200
201		protected function getExamplesMessages() {
202		return [
203		'action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks'
204		=> 'apihelp-query+iwbacklinks-example-simple',
205		'action=query&generator=iwbacklinks&giwbltitle=Test&giwblprefix=wikibooks&prop=info'
206		=> 'apihelp-query+iwbacklinks-example-generator',
207		];
208		}
209
210		public function getHelpUrls() {
211		return 'https://www.mediawiki.org/wiki/API:Iwbacklinks';
212		}
213		}
214

wikimedia / mediawiki

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

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

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