MediaWiki  1.23.2
Go to the documentation of this file.
1 <?php
32 class ApiRsd extends ApiBase {
34  public function execute() {
35  $result = $this->getResult();
37  $result->addValue( null, 'version', '1.0' );
38  $result->addValue( null, 'xmlns', '' );
40  $service = array( 'apis' => $this->formatRsdApiList() );
41  ApiResult::setContent( $service, 'MediaWiki', 'engineName' );
42  ApiResult::setContent( $service, '', 'engineLink' );
43  ApiResult::setContent( $service, Title::newMainPage()->getCanonicalURL(), 'homePageLink' );
45  $result->setIndexedTagName( $service['apis'], 'api' );
47  $result->addValue( null, 'service', $service );
48  }
50  public function getCustomPrinter() {
51  return new ApiFormatXmlRsd( $this->getMain(), 'xml' );
52  }
54  public function getAllowedParams() {
55  return array();
56  }
58  public function getParamDescription() {
59  return array();
60  }
62  public function getDescription() {
63  return 'Export an RSD (Really Simple Discovery) schema.';
64  }
66  public function getExamples() {
67  return array(
68  'api.php?action=rsd'
69  );
70  }
89  protected function getRsdApiList() {
90  $apis = array(
91  'MediaWiki' => array(
92  // The API link is required for all RSD API entries.
93  'apiLink' => wfExpandUrl( wfScript( 'api' ), PROTO_CURRENT ),
95  // Docs link is optional, but recommended.
96  'docs' => '',
98  // Some APIs may need a blog ID, but it may be left blank.
99  'blogID' => '',
101  // Additional settings are optional.
102  'settings' => array(
103  // Change this to true in the future as an aid to
104  // machine discovery of OAuth for API access.
105  'OAuth' => false,
106  )
107  ),
108  );
109  wfRunHooks( 'ApiRsdServiceApis', array( &$apis ) );
111  return $apis;
112  }
120  protected function formatRsdApiList() {
121  $apis = $this->getRsdApiList();
123  $outputData = array();
124  foreach ( $apis as $name => $info ) {
125  $data = array(
126  'name' => $name,
127  'preferred' => wfBoolToStr( $name == 'MediaWiki' ),
128  'apiLink' => $info['apiLink'],
129  'blogID' => isset( $info['blogID'] ) ? $info['blogID'] : '',
130  );
131  $settings = array();
132  if ( isset( $info['docs'] ) ) {
133  ApiResult::setContent( $settings, $info['docs'], 'docs' );
134  }
135  if ( isset( $info['settings'] ) ) {
136  foreach ( $info['settings'] as $setting => $val ) {
137  if ( is_bool( $val ) ) {
138  $xmlVal = wfBoolToStr( $val );
139  } else {
140  $xmlVal = $val;
141  }
142  $setting = array( 'name' => $setting );
143  ApiResult::setContent( $setting, $xmlVal );
144  $settings[] = $setting;
145  }
146  }
147  if ( count( $settings ) ) {
148  $this->getResult()->setIndexedTagName( $settings, 'setting' );
149  $data['settings'] = $settings;
150  }
151  $outputData[] = $data;
152  }
154  return $outputData;
155  }
156 }
158 class ApiFormatXmlRsd extends ApiFormatXml {
159  public function __construct( $main, $format ) {
160  parent::__construct( $main, $format );
161  $this->setRootElement( 'rsd' );
162  }
164  public function getMimeType() {
165  return 'application/rsd+xml';
166  }
167 }
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
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiRsd.php:54
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
static setContent(&$arr, $value, $subElemName=null)
Adds a content element to an array.
Definition: ApiResult.php:201
If the module may only be used with a certain format module, it should override this method to return...
Definition: ApiRsd.php:50
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:441
Formats the internal list of exposed APIs into an array suitable to pass to the API's XML formatter.
Definition: ApiRsd.php:120
Get the result object.
Definition: ApiBase.php:205
Definition: ApiRsd.php:164
Definition: ApiRsd.php:158
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:42
wfBoolToStr( $value)
Convenience function converts boolean values into "true" or "false" (string) values.
Definition: GlobalFunctions.php:3771
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:3730
Definition: Defines.php:270
wfRunHooks( $event, array $args=array(), $deprecatedVersion=null)
Call hook functions defined in $wgHooks.
Definition: GlobalFunctions.php:4001
Returns the description string for this module.
Definition: ApiRsd.php:62
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiRsd.php:34
Builds an internal list of APIs to expose information about.
Definition: ApiRsd.php:89
API module for sending out RSD information.
Definition: ApiRsd.php:32
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:336
Returns usage examples for this module.
Definition: ApiRsd.php:66
Returns an array of parameter descriptions.
Definition: ApiRsd.php:58
__construct( $main, $format)
Definition: ApiRsd.php:159
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
Get the main module.
Definition: ApiBase.php:188
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Definition: GlobalFunctions.php:497