MediaWiki  1.23.2
ApiQueryFileRepoInfo.php
Go to the documentation of this file.
1 <?php
31 
32  public function __construct( $query, $moduleName ) {
33  parent::__construct( $query, $moduleName, 'fri' );
34  }
35 
36  protected function getInitialisedRepoGroup() {
37  $repoGroup = RepoGroup::singleton();
38  $repoGroup->initialiseRepos();
39 
40  return $repoGroup;
41  }
42 
43  public function execute() {
44  $params = $this->extractRequestParams();
45  $props = array_flip( $params['prop'] );
46 
47  $repos = array();
48 
49  $repoGroup = $this->getInitialisedRepoGroup();
50 
51  $repoGroup->forEachForeignRepo( function ( $repo ) use ( &$repos, $props ) {
52  $repos[] = array_intersect_key( $repo->getInfo(), $props );
53  } );
54 
55  $repos[] = array_intersect_key( $repoGroup->getLocalRepo()->getInfo(), $props );
56 
57  $result = $this->getResult();
58  $result->setIndexedTagName( $repos, 'repo' );
59  $result->addValue( array( 'query' ), 'repos', $repos );
60  }
61 
62  public function getCacheMode( $params ) {
63  return 'public';
64  }
65 
66  public function getAllowedParams() {
67  $props = $this->getProps();
68 
69  return array(
70  'prop' => array(
71  ApiBase::PARAM_DFLT => join( '|', $props ),
72  ApiBase::PARAM_ISMULTI => true,
73  ApiBase::PARAM_TYPE => $props,
74  ),
75  );
76  }
77 
78  public function getProps() {
79  $props = array();
80  $repoGroup = $this->getInitialisedRepoGroup();
81 
82  $repoGroup->forEachForeignRepo( function ( $repo ) use ( &$props ) {
83  $props = array_merge( $props, array_keys( $repo->getInfo() ) );
84  } );
85 
86  return array_values( array_unique( array_merge(
87  $props,
88  array_keys( $repoGroup->getLocalRepo()->getInfo() )
89  ) ) );
90  }
91 
92  public function getParamDescription() {
93  return array(
94  'prop' => array(
95  'Which repository properties to get (there may be more available on some wikis):',
96  ' apiurl - URL to the repository API - helpful for getting image info from the host.',
97  ' name - The key of the repository - used in e.g. ' .
98  '$wgForeignFileRepos and imageinfo return values.',
99  ' displayname - The human-readable name of the repository wiki.',
100  ' rooturl - Root URL for image paths.',
101  ' local - Whether that repository is the local one or not.',
102  ),
103  );
104  }
105 
106  public function getDescription() {
107  return 'Return meta information about image repositories configured on the wiki.';
108  }
109 
110  public function getExamples() {
111  return array(
112  'api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname',
113  );
114  }
115 }
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1528
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:53
ApiQueryFileRepoInfo\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryFileRepoInfo.php:43
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
ApiQueryFileRepoInfo\getProps
getProps()
Definition: ApiQueryFileRepoInfo.php:78
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
$params
$params
Definition: styleTest.css.php:40
ApiQueryFileRepoInfo\getDescription
getDescription()
Returns the description string for this module.
Definition: ApiQueryFileRepoInfo.php:106
ApiQueryBase
This is a base class for all Query modules.
Definition: ApiQueryBase.php:34
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
ApiQueryFileRepoInfo\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryFileRepoInfo.php:66
ApiQueryFileRepoInfo\__construct
__construct( $query, $moduleName)
Definition: ApiQueryFileRepoInfo.php:32
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
ApiQueryFileRepoInfo
A query action to return meta information about the foreign file repos configured on the wiki.
Definition: ApiQueryFileRepoInfo.php:30
ApiQueryFileRepoInfo\getInitialisedRepoGroup
getInitialisedRepoGroup()
Definition: ApiQueryFileRepoInfo.php:36
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:46
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:48
ApiQueryFileRepoInfo\getParamDescription
getParamDescription()
Returns an array of parameter descriptions.
Definition: ApiQueryFileRepoInfo.php:92
ApiQueryFileRepoInfo\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryFileRepoInfo.php:62
ApiQueryFileRepoInfo\getExamples
getExamples()
Returns usage examples for this module.
Definition: ApiQueryFileRepoInfo.php:110
$query
return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1105