ApiQueryFileRepoInfo.php

Go to the documentation of this file.

<?php
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();
        $result->setIndexedTagName( $repos, 'repo' );
        $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() )
        ) ) );
    }

    public function getParamDescription() {
        return array(
            'prop' => array(
                'Which repository properties to get (there may be more available on some wikis):',
                ' apiurl      - URL to the repository API - helpful for getting image info from the host.',
                ' name        - The key of the repository - used in e.g. ' .
                    '$wgForeignFileRepos and imageinfo return values.',
                ' displayname - The human-readable name of the repository wiki.',
                ' rooturl     - Root URL for image paths.',
                ' local       - Whether that repository is the local one or not.',
            ),
        );
    }

    public function getDescription() {
        return 'Return meta information about image repositories configured on the wiki.';
    }

    public function getExamples() {
        return array(
            'api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname',
        );
    }
}