wiki.techinc.nl/includes/api/ApiQueryPageProps.php
Thiemo Kreuz 734a969d55 Safe replacement of a lot of !count() with === []
This was originally a global search and replace. I manually checked all
replacements and reverted them if (due to the lack of type hints) either
null (that would be 0 when counted) or a Countable object can end in the
variable or property in question.

Now this patch only touches places where I'm sure nothing can break.

For the sanity of the honorable reviewers this patch is exclusively touching
negated counts. You should not find a single `!== []` in this patch, that
would be a mistake.

Change-Id: I5eafd4d8fccdb53a668be8e6f25a566f9c3a0a95
2019-01-15 17:28:49 +01:00

121 lines
3.1 KiB
PHP

<?php
/**
* Copyright © 2010 soxred93, Bryan Tong Minh
*
* 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 show basic page information.
*
* @ingroup API
*/
class ApiQueryPageProps extends ApiQueryBase {
private $params;
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'pp' );
}
public function execute() {
# Only operate on existing pages
$pages = $this->getPageSet()->getGoodTitles();
$this->params = $this->extractRequestParams();
if ( $this->params['continue'] ) {
$continueValue = intval( $this->params['continue'] );
$this->dieContinueUsageIf( strval( $continueValue ) !== $this->params['continue'] );
$filteredPages = [];
foreach ( $pages as $id => $page ) {
if ( $id >= $continueValue ) {
$filteredPages[$id] = $page;
}
}
$pages = $filteredPages;
}
if ( $pages === [] ) {
# Nothing to do
return;
}
$pageProps = PageProps::getInstance();
$result = $this->getResult();
if ( $this->params['prop'] ) {
$propnames = $this->params['prop'];
$properties = $pageProps->getProperties( $pages, $propnames );
} else {
$properties = $pageProps->getAllProperties( $pages );
}
ksort( $properties );
foreach ( $properties as $page => $props ) {
if ( !$this->addPageProps( $result, $page, $props ) ) {
break;
}
}
}
/**
* Add page properties to an ApiResult, adding a continue
* parameter if it doesn't fit.
*
* @param ApiResult $result
* @param int $page
* @param array $props
* @return bool True if it fits in the result
*/
private function addPageProps( $result, $page, $props ) {
ApiResult::setArrayType( $props, 'assoc' );
$fit = $result->addValue( [ 'query', 'pages', $page ], 'pageprops', $props );
if ( !$fit ) {
$this->setContinueEnumParameter( 'continue', $page );
}
return $fit;
}
public function getCacheMode( $params ) {
return 'public';
}
public function getAllowedParams() {
return [
'continue' => [
ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
],
'prop' => [
ApiBase::PARAM_ISMULTI => true,
],
];
}
protected function getExamplesMessages() {
return [
'action=query&prop=pageprops&titles=Main%20Page|MediaWiki'
=> 'apihelp-query+pageprops-example-simple',
];
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Pageprops';
}
}