Page MenuHomeWickedGov Phorge
Files F5977380

ApiQueryPageProps.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ApiQueryPageProps.php
View Options

<?php
/**
* Copyright © 2010 soxred93, Bryan Tong Minh
*
* @license GPL-2.0-or-later
* @file
*/
namespace MediaWiki\Api;
use MediaWiki\Page\PageProps;
use MediaWiki\Title\Title;
use Wikimedia\ParamValidator\ParamValidator;
/**
* A query module to show basic page information.
*
* @ingroup API
*/
class ApiQueryPageProps extends ApiQueryBase {
private PageProps $pageProps;
public function __construct(
ApiQuery $query,
string $moduleName,
PageProps $pageProps
) {
parent::__construct( $query, $moduleName, 'pp' );
$this->pageProps = $pageProps;
}
public function execute() {
# Only operate on existing pages
$pages = $this->getPageSet()->getGoodPages();
$params = $this->extractRequestParams();
if ( $params['continue'] ) {
$cont = $this->parseContinueParamOrDie( $params['continue'], [ 'int' ] );
$continueValue = $cont[0];
$filteredPages = [];
foreach ( $pages as $id => $page ) {
if ( $id >= $continueValue ) {
$filteredPages[$id] = $page;
}
}
$pages = $filteredPages;
}
if ( $pages === [] ) {
# Nothing to do
return;
}
if ( $params['prop'] ) {
$properties = $this->pageProps->getProperties( $pages, $params['prop'] );
} else {
$properties = $this->pageProps->getAllProperties( $pages );
}
ksort( $properties );
$result = $this->getResult();
foreach ( $properties as $pageid => $props ) {
if ( !$this->addPageProps( $result, $pageid, $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;
}
/** @inheritDoc */
public function getCacheMode( $params ) {
return 'public';
}
/** @inheritDoc */
public function getAllowedParams() {
return [
'continue' => [
ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
],
'prop' => [
ParamValidator::PARAM_ISMULTI => true,
],
];
}
/** @inheritDoc */
protected function getExamplesMessages() {
$title = Title::newMainPage()->getPrefixedText();
$mp = rawurlencode( $title );
return [
"action=query&prop=pageprops&titles={$mp}|MediaWiki"
=> 'apihelp-query+pageprops-example-simple',
];
}
/** @inheritDoc */
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Pageprops';
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiQueryPageProps::class, 'ApiQueryPageProps' );

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 19:53 (4 d, 2 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
87/e6/da8dd3024a64bd8f86fba97c3b3e
Default Alt Text
ApiQueryPageProps.php (2 KB)

Event Timeline