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

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

↳ Parent: ApiQueryAllRevisions

Complexity

Conditions	2
Paths	2

Size

Total Lines	43
Code Lines	28

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	28
nc	2
nop	0
dl	0
loc	43
rs	8.8571
c	0
b	0
f	0

<?php
/**
 * Created on Sep 27, 2015
 *
 * Copyright © 2015 Brad Jorsch "[email protected]"
 *
 * 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
 */

/**
 * Query module to enumerate all revisions.
 *
 * @ingroup API
 * @since 1.27
 */
class ApiQueryAllRevisions extends ApiQueryRevisionsBase {

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

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

		$result = $this->getResult();

		$this->requireMaxOneParameter( $params, 'user', 'excludeuser' );

		// Namespace check is likely to be desired, but can't be done
		// efficiently in SQL.
		$miser_ns = null;
		$needPageTable = false;
		if ( $params['namespace'] !== null ) {
			$params['namespace'] = array_unique( $params['namespace'] );
			sort( $params['namespace'] );
			if ( $params['namespace'] != MWNamespace::getValidNamespaces() ) {
				$needPageTable = true;
				if ( $this->getConfig()->get( 'MiserMode' ) ) {
					$miser_ns = $params['namespace'];
				} else {
					$this->addWhere( [ 'page_namespace' => $params['namespace'] ] );
				}
			}
		}

		$this->addTables( 'revision' );
		if ( $resultPageSet === null ) {
			$this->parseParameters( $params );
			$this->addTables( 'page' );
			$this->addJoinConds(
				[ 'page' => [ 'INNER JOIN', [ 'rev_page = page_id' ] ] ]
			);
			$this->addFields( Revision::selectFields() );
			$this->addFields( Revision::selectPageFields() );

			// Review this depeneding on the outcome of T113901
			$this->addOption( 'STRAIGHT_JOIN' );
		} else {
			$this->limit = $this->getParameter( 'limit' ) ?: 10;
			$this->addFields( [ 'rev_timestamp', 'rev_id' ] );
			if ( $params['generatetitles'] ) {
				$this->addFields( [ 'rev_page' ] );
			}

			if ( $needPageTable ) {
				$this->addTables( 'page' );
				$this->addJoinConds(
					[ 'page' => [ 'INNER JOIN', [ 'rev_page = page_id' ] ] ]
				);
				$this->addFieldsIf( [ 'page_namespace' ], (bool)$miser_ns );

				// Review this depeneding on the outcome of T113901
				$this->addOption( 'STRAIGHT_JOIN' );
			}
		}

		$dir = $params['dir'];
		$this->addTimestampWhereRange( 'rev_timestamp', $dir, $params['start'], $params['end'] );

		if ( $this->fld_tags ) {
			$this->addTables( 'tag_summary' );
			$this->addJoinConds(
				[ 'tag_summary' => [ 'LEFT JOIN', [ 'rev_id=ts_rev_id' ] ] ]
			);
			$this->addFields( 'ts_tags' );
		}

		if ( $this->fetchContent ) {
			$this->addTables( 'text' );
			$this->addJoinConds(
				[ 'text' => [ 'INNER JOIN', [ 'rev_text_id=old_id' ] ] ]
			);
			$this->addFields( 'old_id' );
			$this->addFields( Revision::selectTextFields() );
		}

		if ( $params['user'] !== null ) {
			$id = User::idFromName( $params['user'] );
			if ( $id ) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
				$this->addWhereFld( 'rev_user', $id );
			} else {
				$this->addWhereFld( 'rev_user_text', $params['user'] );
			}
		} elseif ( $params['excludeuser'] !== null ) {
			$id = User::idFromName( $params['excludeuser'] );
			if ( $id ) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
				$this->addWhere( 'rev_user != ' . $id );
			} else {
				$this->addWhere( 'rev_user_text != ' . $db->addQuotes( $params['excludeuser'] ) );
			}
		}

		if ( $params['user'] !== null || $params['excludeuser'] !== null ) {
			// Paranoia: avoid brute force searches (bug 17342)
			if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
				$bitmask = Revision::DELETED_USER;
			} elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
				$bitmask = Revision::DELETED_USER | Revision::DELETED_RESTRICTED;
			} else {
				$bitmask = 0;
			}
			if ( $bitmask ) {
				$this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
			}
		}

		if ( $params['continue'] !== null ) {
			$op = ( $dir == 'newer' ? '>' : '<' );
			$cont = explode( '|', $params['continue'] );
			$this->dieContinueUsageIf( count( $cont ) != 2 );
			$ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
			$rev_id = (int)$cont[1];
			$this->dieContinueUsageIf( strval( $rev_id ) !== $cont[1] );
			$this->addWhere( "rev_timestamp $op $ts OR " .
				"(rev_timestamp = $ts AND " .
				"rev_id $op= $rev_id)" );
		}

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

		$sort = ( $dir == 'newer' ? '' : ' DESC' );
		$orderby = [];
		// Targeting index rev_timestamp, user_timestamp, or usertext_timestamp
		// But 'user' is always constant for the latter two, so it doesn't matter here.
		$orderby[] = "rev_timestamp $sort";
		$orderby[] = "rev_id $sort";
		$this->addOption( 'ORDER BY', $orderby );

		$hookData = [];
		$res = $this->select( __METHOD__, [], $hookData );
		$pageMap = []; // Maps rev_page to array index
		$count = 0;
		$nextIndex = 0;
		$generated = [];
		foreach ( $res as $row ) {
			if ( $count === 0 && $resultPageSet !== null ) {
				// Set the non-continue since the list of all revisions is
				// prone to having entries added at the start frequently.
				$this->getContinuationManager()->addGeneratorNonContinueParam(
					$this, 'continue', "$row->rev_timestamp|$row->rev_id"
				);
			}
			if ( ++$count > $this->limit ) {
				// We've had enough
				$this->setContinueEnumParameter( 'continue', "$row->rev_timestamp|$row->rev_id" );
				break;
			}

			// Miser mode namespace check
			if ( $miser_ns !== null && !in_array( $row->page_namespace, $miser_ns ) ) {
				continue;
			}

			if ( $resultPageSet !== null ) {
				if ( $params['generatetitles'] ) {
					$generated[$row->rev_page] = $row->rev_page;
				} else {
					$generated[] = $row->rev_id;
				}
			} else {
				$revision = Revision::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);
    }
}
				$rev = $this->extractRevisionInfo( $revision, $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);
    }
}

				if ( !isset( $pageMap[$row->rev_page] ) ) {
					$index = $nextIndex++;
					$pageMap[$row->rev_page] = $index;
					$title = $revision->getTitle();
					$a = [
						'pageid' => $title->getArticleID(),
						'revisions' => [ $rev ],
					];
					ApiResult::setIndexedTagName( $a['revisions'], 'rev' );
					ApiQueryBase::addTitleInfo( $a, $title );
/** @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);
    }
}
					$fit = $this->processRow( $row, $a['revisions'][0], $hookData ) &&
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
						$result->addValue( [ 'query', $this->getModuleName() ], $index, $a );
				} else {
					$index = $pageMap[$row->rev_page];
					$fit = $this->processRow( $row, $rev, $hookData ) &&
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
						$result->addValue( [ 'query', $this->getModuleName(), $index, 'revisions' ], null, $rev );
				}
				if ( !$fit ) {
					$this->setContinueEnumParameter( 'continue', "$row->rev_timestamp|$row->rev_id" );
					break;
				}
			}
		}

		if ( $resultPageSet !== null ) {
			if ( $params['generatetitles'] ) {
				$resultPageSet->populateFromPageIDs( $generated );
			} else {
				$resultPageSet->populateFromRevisionIDs( $generated );
			}
		} else {
			$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
		}
	}

	public function getAllowedParams() {
		$ret = parent::getAllowedParams() + [
			'user' => [
				ApiBase::PARAM_TYPE => 'user',
			],
			'namespace' => [
				ApiBase::PARAM_ISMULTI => true,
				ApiBase::PARAM_TYPE => 'namespace',
				ApiBase::PARAM_DFLT => null,
			],
			'start' => [
				ApiBase::PARAM_TYPE => 'timestamp',
			],
			'end' => [
				ApiBase::PARAM_TYPE => 'timestamp',
			],
			'dir' => [
				ApiBase::PARAM_TYPE => [
					'newer',
					'older'
				],
				ApiBase::PARAM_DFLT => 'older',
				ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
			],
			'excludeuser' => [
				ApiBase::PARAM_TYPE => 'user',
			],
			'continue' => [
				ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
			],
			'generatetitles' => [
				ApiBase::PARAM_DFLT => false,
			],
		];

		if ( $this->getConfig()->get( 'MiserMode' ) ) {
			$ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
				'api-help-param-limited-in-miser-mode',
			];
		}

		return $ret;
	}

	protected function getExamplesMessages() {
		return [
			'action=query&list=allrevisions&arvuser=Example&arvlimit=50'
				=> 'apihelp-query+allrevisions-example-user',
			'action=query&list=allrevisions&arvdir=newer&arvlimit=50'
				=> 'apihelp-query+allrevisions-example-ns-main',
		];
	}

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


1		<?php
2		/**
3		* Created on Sep 27, 2015
4		*
5		* Copyright © 2015 Brad Jorsch "[email protected]"
6		*
7		* This program is free software; you can redistribute it and/or modify
8		* it under the terms of the GNU General Public License as published by
9		* the Free Software Foundation; either version 2 of the License, or
10		* (at your option) any later version.
11		*
12		* This program is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		* GNU General Public License for more details.
16		*
17		* You should have received a copy of the GNU General Public License along
18		* with this program; if not, write to the Free Software Foundation, Inc.,
19		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20		* http://www.gnu.org/copyleft/gpl.html
21		*
22		* @file
23		*/
24
25		/**
26		* Query module to enumerate all revisions.
27		*
28		* @ingroup API
29		* @since 1.27
30		*/
31		class ApiQueryAllRevisions extends ApiQueryRevisionsBase {
32
33		public function __construct( ApiQuery $query, $moduleName ) {
34		parent::__construct( $query, $moduleName, 'arv' );
35		}
36
37		/**
38		* @param ApiPageSet $resultPageSet
39		* @return void
40		*/
41		protected function run( ApiPageSet $resultPageSet = null ) {
42		$db = $this->getDB();
43		$params = $this->extractRequestParams( false );
44
45		$result = $this->getResult();
46
47		$this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
48
49		// Namespace check is likely to be desired, but can't be done
50		// efficiently in SQL.
51		$miser_ns = null;
52		$needPageTable = false;
53		if ( $params['namespace'] !== null ) {
54		$params['namespace'] = array_unique( $params['namespace'] );
55		sort( $params['namespace'] );
56		if ( $params['namespace'] != MWNamespace::getValidNamespaces() ) {
57		$needPageTable = true;
58	View Code Duplication	if ( $this->getConfig()->get( 'MiserMode' ) ) {
59		$miser_ns = $params['namespace'];
60		} else {
61		$this->addWhere( [ 'page_namespace' => $params['namespace'] ] );
62		}
63		}
64		}
65
66		$this->addTables( 'revision' );
67		if ( $resultPageSet === null ) {
68		$this->parseParameters( $params );
69		$this->addTables( 'page' );
70		$this->addJoinConds(
71		[ 'page' => [ 'INNER JOIN', [ 'rev_page = page_id' ] ] ]
72		);
73		$this->addFields( Revision::selectFields() );
74		$this->addFields( Revision::selectPageFields() );
75
76		// Review this depeneding on the outcome of T113901
77		$this->addOption( 'STRAIGHT_JOIN' );
78		} else {
79		$this->limit = $this->getParameter( 'limit' ) ?: 10;
80		$this->addFields( [ 'rev_timestamp', 'rev_id' ] );
81		if ( $params['generatetitles'] ) {
82		$this->addFields( [ 'rev_page' ] );
83		}
84
85		if ( $needPageTable ) {
86		$this->addTables( 'page' );
87		$this->addJoinConds(
88		[ 'page' => [ 'INNER JOIN', [ 'rev_page = page_id' ] ] ]
89		);
90		$this->addFieldsIf( [ 'page_namespace' ], (bool)$miser_ns );
91
92		// Review this depeneding on the outcome of T113901
93		$this->addOption( 'STRAIGHT_JOIN' );
94		}
95		}
96
97		$dir = $params['dir'];
98		$this->addTimestampWhereRange( 'rev_timestamp', $dir, $params['start'], $params['end'] );
99
100	View Code Duplication	if ( $this->fld_tags ) {
101		$this->addTables( 'tag_summary' );
102		$this->addJoinConds(
103		[ 'tag_summary' => [ 'LEFT JOIN', [ 'rev_id=ts_rev_id' ] ] ]
104		);
105		$this->addFields( 'ts_tags' );
106		}
107
108		if ( $this->fetchContent ) {
109		$this->addTables( 'text' );
110		$this->addJoinConds(
111		[ 'text' => [ 'INNER JOIN', [ 'rev_text_id=old_id' ] ] ]
112		);
113		$this->addFields( 'old_id' );
114		$this->addFields( Revision::selectTextFields() );
115		}
116
117		if ( $params['user'] !== null ) {
118		$id = User::idFromName( $params['user'] );
119		if ( $id ) {
		0 ignored issues – show Bug Best Practice introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The expression `$id` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
120		$this->addWhereFld( 'rev_user', $id );
121		} else {
122		$this->addWhereFld( 'rev_user_text', $params['user'] );
123		}
124	View Code Duplication	} elseif ( $params['excludeuser'] !== null ) {
125		$id = User::idFromName( $params['excludeuser'] );
126		if ( $id ) {
		0 ignored issues – show Bug Best Practice introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The expression `$id` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
127		$this->addWhere( 'rev_user != ' . $id );
128		} else {
129		$this->addWhere( 'rev_user_text != ' . $db->addQuotes( $params['excludeuser'] ) );
130		}
131		}
132
133	View Code Duplication	if ( $params['user'] !== null \|\| $params['excludeuser'] !== null ) {
134		// Paranoia: avoid brute force searches (bug 17342)
135		if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
136		$bitmask = Revision::DELETED_USER;
137		} elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
138		$bitmask = Revision::DELETED_USER \| Revision::DELETED_RESTRICTED;
139		} else {
140		$bitmask = 0;
141		}
142		if ( $bitmask ) {
143		$this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
144		}
145		}
146
147		if ( $params['continue'] !== null ) {
148		$op = ( $dir == 'newer' ? '>' : '<' );
149		$cont = explode( '\|', $params['continue'] );
150		$this->dieContinueUsageIf( count( $cont ) != 2 );
151		$ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
152		$rev_id = (int)$cont[1];
153		$this->dieContinueUsageIf( strval( $rev_id ) !== $cont[1] );
154		$this->addWhere( "rev_timestamp $op $ts OR " .
155		"(rev_timestamp = $ts AND " .
156		"rev_id $op= $rev_id)" );
157		}
158
159		$this->addOption( 'LIMIT', $this->limit + 1 );
160
161		$sort = ( $dir == 'newer' ? '' : ' DESC' );
162		$orderby = [];
163		// Targeting index rev_timestamp, user_timestamp, or usertext_timestamp
164		// But 'user' is always constant for the latter two, so it doesn't matter here.
165		$orderby[] = "rev_timestamp $sort";
166		$orderby[] = "rev_id $sort";
167		$this->addOption( 'ORDER BY', $orderby );
168
169		$hookData = [];
170		$res = $this->select( __METHOD__, [], $hookData );
171		$pageMap = []; // Maps rev_page to array index
172		$count = 0;
173		$nextIndex = 0;
174		$generated = [];
175		foreach ( $res as $row ) {
176		if ( $count === 0 && $resultPageSet !== null ) {
177		// Set the non-continue since the list of all revisions is
178		// prone to having entries added at the start frequently.
179		$this->getContinuationManager()->addGeneratorNonContinueParam(
180		$this, 'continue', "$row->rev_timestamp\|$row->rev_id"
181		);
182		}
183		if ( ++$count > $this->limit ) {
184		// We've had enough
185		$this->setContinueEnumParameter( 'continue', "$row->rev_timestamp\|$row->rev_id" );
186		break;
187		}
188
189		// Miser mode namespace check
190		if ( $miser_ns !== null && !in_array( $row->page_namespace, $miser_ns ) ) {
191		continue;
192		}
193
194		if ( $resultPageSet !== null ) {
195		if ( $params['generatetitles'] ) {
196		$generated[$row->rev_page] = $row->rev_page;
197		} else {
198		$generated[] = $row->rev_id;
199		}
200		} else {
201		$revision = Revision::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 `175` can be `null`; however, `Revision::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...
202		$rev = $this->extractRevisionInfo( $revision, $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 `175` can be `null`; however, `ApiQueryRevisionsBase::extractRevisionInfo()` 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...
203
204		if ( !isset( $pageMap[$row->rev_page] ) ) {
205		$index = $nextIndex++;
206		$pageMap[$row->rev_page] = $index;
207		$title = $revision->getTitle();
208		$a = [
209		'pageid' => $title->getArticleID(),
210		'revisions' => [ $rev ],
211		];
212		ApiResult::setIndexedTagName( $a['revisions'], 'rev' );
213		ApiQueryBase::addTitleInfo( $a, $title );
		0 ignored issues – show Bug introduced 2016-02-23 18:13 UTC by Report Bug Copy Issue Report It seems like `$title` defined by `$revision->getTitle()` on line `207` can be `null`; however, `ApiQueryBase::addTitleInfo()` 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...
214		$fit = $this->processRow( $row, $a['revisions'][0], $hookData ) &&
		0 ignored issues – show Bug introduced 2016-10-07 17:33 UTC by Report Bug Copy Issue Report It seems like `$hookData` can also be of type `null`; however, `ApiQueryBase::processRow()` does only seem to accept `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...
215		$result->addValue( [ 'query', $this->getModuleName() ], $index, $a );
216	View Code Duplication	} else {
217		$index = $pageMap[$row->rev_page];
218		$fit = $this->processRow( $row, $rev, $hookData ) &&
		0 ignored issues – show Bug introduced 2016-10-07 17:33 UTC by Report Bug Copy Issue Report It seems like `$hookData` can also be of type `null`; however, `ApiQueryBase::processRow()` does only seem to accept `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...
219		$result->addValue( [ 'query', $this->getModuleName(), $index, 'revisions' ], null, $rev );
220		}
221		if ( !$fit ) {
222		$this->setContinueEnumParameter( 'continue', "$row->rev_timestamp\|$row->rev_id" );
223		break;
224		}
225		}
226		}
227
228		if ( $resultPageSet !== null ) {
229		if ( $params['generatetitles'] ) {
230		$resultPageSet->populateFromPageIDs( $generated );
231		} else {
232		$resultPageSet->populateFromRevisionIDs( $generated );
233		}
234		} else {
235		$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
236		}
237		}
238
239		public function getAllowedParams() {
240		$ret = parent::getAllowedParams() + [
241		'user' => [
242		ApiBase::PARAM_TYPE => 'user',
243		],
244		'namespace' => [
245		ApiBase::PARAM_ISMULTI => true,
246		ApiBase::PARAM_TYPE => 'namespace',
247		ApiBase::PARAM_DFLT => null,
248		],
249		'start' => [
250		ApiBase::PARAM_TYPE => 'timestamp',
251		],
252		'end' => [
253		ApiBase::PARAM_TYPE => 'timestamp',
254		],
255		'dir' => [
256		ApiBase::PARAM_TYPE => [
257		'newer',
258		'older'
259		],
260		ApiBase::PARAM_DFLT => 'older',
261		ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
262		],
263		'excludeuser' => [
264		ApiBase::PARAM_TYPE => 'user',
265		],
266		'continue' => [
267		ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
268		],
269		'generatetitles' => [
270		ApiBase::PARAM_DFLT => false,
271		],
272		];
273
274		if ( $this->getConfig()->get( 'MiserMode' ) ) {
275		$ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
276		'api-help-param-limited-in-miser-mode',
277		];
278		}
279
280		return $ret;
281		}
282
283		protected function getExamplesMessages() {
284		return [
285		'action=query&list=allrevisions&arvuser=Example&arvlimit=50'
286		=> 'apihelp-query+allrevisions-example-user',
287		'action=query&list=allrevisions&arvdir=newer&arvlimit=50'
288		=> 'apihelp-query+allrevisions-example-ns-main',
289		];
290		}
291
292		public function getHelpUrls() {
293		return 'https://www.mediawiki.org/wiki/API:Allrevisions';
294		}
295		}
296

wikimedia / mediawiki

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

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

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