wiki.techinc.nl/includes/api/ApiQueryFileRepoInfo.php
Brad Jorsch beab6b009e Change API result data structure to be cleaner in new formats
Nothing in this patch should result in changed output for format=json or
format=php except as noted in RELEASE-NOTES-1.25, and changed output for
format=xml should be similar or cosmetic. However, other code accessing
the result data directly may need to be updated.

Bug: T87053
Bug: T12887
Change-Id: I3500708965cb8869b5aed1543381aad208dadd13
2015-04-20 17:49:37 -04:00

100 lines
2.8 KiB
PHP

<?php
/**
* Copyright © 2013 Mark Holmquist <mtraceur@member.fsf.org>
*
* 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
* @since 1.22
*/
/**
* A query action to return meta information about the foreign file repos
* configured on the wiki.
*
* @ingroup API
*/
class ApiQueryFileRepoInfo extends ApiQueryBase {
public function __construct( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'fri' );
}
protected function getInitialisedRepoGroup() {
$repoGroup = RepoGroup::singleton();
$repoGroup->initialiseRepos();
return $repoGroup;
}
public function execute() {
$params = $this->extractRequestParams();
$props = array_flip( $params['prop'] );
$repos = array();
$repoGroup = $this->getInitialisedRepoGroup();
$repoGroup->forEachForeignRepo( function ( $repo ) use ( &$repos, $props ) {
$repos[] = array_intersect_key( $repo->getInfo(), $props );
} );
$repos[] = array_intersect_key( $repoGroup->getLocalRepo()->getInfo(), $props );
$result = $this->getResult();
ApiResult::setIndexedTagName( $repos, 'repo' );
ApiResult::setArrayTypeRecursive( $repos, 'assoc' );
ApiResult::setArrayType( $repos, 'array' );
$result->addValue( array( 'query' ), 'repos', $repos );
}
public function getCacheMode( $params ) {
return 'public';
}
public function getAllowedParams() {
$props = $this->getProps();
return array(
'prop' => array(
ApiBase::PARAM_DFLT => join( '|', $props ),
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_TYPE => $props,
),
);
}
public function getProps() {
$props = array();
$repoGroup = $this->getInitialisedRepoGroup();
$repoGroup->forEachForeignRepo( function ( $repo ) use ( &$props ) {
$props = array_merge( $props, array_keys( $repo->getInfo() ) );
} );
return array_values( array_unique( array_merge(
$props,
array_keys( $repoGroup->getLocalRepo()->getInfo() )
) ) );
}
protected function getExamplesMessages() {
return array(
'action=query&meta=filerepoinfo&friprop=apiurl|name|displayname'
=> 'apihelp-query+filerepoinfo-example-simple',
);
}
}