MediaWiki  1.28.1
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 = [
41  'apis' => $this->formatRsdApiList(),
42  'engineName' => 'MediaWiki',
43  'engineLink' => '',
44  'homePageLink' => Title::newMainPage()->getCanonicalURL(),
45  ];
47  ApiResult::setSubelementsList( $service, [ 'engineName', 'engineLink', 'homePageLink' ] );
48  ApiResult::setIndexedTagName( $service['apis'], 'api' );
50  $result->addValue( null, 'service', $service );
51  }
53  public function getCustomPrinter() {
54  return new ApiFormatXmlRsd( $this->getMain(), 'xml' );
55  }
57  protected function getExamplesMessages() {
58  return [
59  'action=rsd'
60  => 'apihelp-rsd-example-simple',
61  ];
62  }
64  public function isReadMode() {
65  return false;
66  }
85  protected function getRsdApiList() {
86  $apis = [
87  'MediaWiki' => [
88  // The API link is required for all RSD API entries.
89  'apiLink' => wfExpandUrl( wfScript( 'api' ), PROTO_CURRENT ),
91  // Docs link is optional, but recommended.
92  'docs' => '',
94  // Some APIs may need a blog ID, but it may be left blank.
95  'blogID' => '',
97  // Additional settings are optional.
98  'settings' => [
99  // Change this to true in the future as an aid to
100  // machine discovery of OAuth for API access.
101  'OAuth' => false,
102  ]
103  ],
104  ];
105  Hooks::run( 'ApiRsdServiceApis', [ &$apis ] );
107  return $apis;
108  }
116  protected function formatRsdApiList() {
117  $apis = $this->getRsdApiList();
119  $outputData = [];
120  foreach ( $apis as $name => $info ) {
121  $data = [
122  'name' => $name,
123  'preferred' => wfBoolToStr( $name == 'MediaWiki' ),
124  'apiLink' => $info['apiLink'],
125  'blogID' => isset( $info['blogID'] ) ? $info['blogID'] : '',
126  ];
127  $settings = [];
128  if ( isset( $info['docs'] ) ) {
129  $settings['docs'] = $info['docs'];
130  ApiResult::setSubelementsList( $settings, 'docs' );
131  }
132  if ( isset( $info['settings'] ) ) {
133  foreach ( $info['settings'] as $setting => $val ) {
134  if ( is_bool( $val ) ) {
135  $xmlVal = wfBoolToStr( $val );
136  } else {
137  $xmlVal = $val;
138  }
139  $setting = [ 'name' => $setting ];
140  ApiResult::setContentValue( $setting, 'value', $xmlVal );
141  $settings[] = $setting;
142  }
143  }
144  if ( count( $settings ) ) {
145  ApiResult::setIndexedTagName( $settings, 'setting' );
146  $data['settings'] = $settings;
147  }
148  $outputData[] = $data;
149  }
151  return $outputData;
152  }
153 }
156  public function __construct( ApiMain $main, $format ) {
157  parent::__construct( $main, $format );
158  $this->setRootElement( 'rsd' );
159  }
161  public function getMimeType() {
162  return 'application/rsd+xml';
163  }
165  public static function recXmlPrint( $name, $value, $indent, $attributes = [] ) {
166  unset( $attributes['_idx'] );
167  return parent::recXmlPrint( $name, $value, $indent, $attributes );
168  }
169 }
Builds an internal list of APIs to expose information about.
Definition: ApiRsd.php:85
API XML output formatter.
Get the result object.
Definition: ApiBase.php:584
wfScript($script= 'index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:556
Get the main module.
Definition: ApiBase.php:480
__construct(ApiMain $main, $format)
Definition: ApiRsd.php:156
Definition: Defines.php:226
wfExpandUrl($url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Convenience function converts boolean values into "true" or "false" (string) values.
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
Definition: ApiResult.php:480
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:618
Definition: ApiRsd.php:64
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.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. '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 '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 '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 '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. '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 IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() '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 Sanitizer::validateEmail(), 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. '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) '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 '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. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.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:1934
Definition: ApiRsd.php:53
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:43
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
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
static setSubelementsList(array &$arr, $names)
Causes the elements with the specified names to be output as subelements rather than attributes...
Definition: ApiResult.php:567
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
Definition: ApiRsd.php:34
Formats the internal list of exposed APIs into an array suitable to pass to the API's XML formatter...
Definition: ApiRsd.php:116
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:39
API module for sending out RSD information.
Definition: ApiRsd.php:32
Definition: ApiRsd.php:57
static recXmlPrint($name, $value, $indent, $attributes=[])
Definition: ApiRsd.php:165
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300