ApiRsd.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Api;
 
use MediaWiki\MediaWikiServices;
use MediaWiki\Title\Title;
 
class ApiRsd extends ApiBase {
    public function execute() {
        $result = $this->getResult();
 
        $result->addValue( null, 'version', '1.0' );
        $result->addValue( null, 'xmlns', 'http://archipelago.phrasewise.com/rsd' );
 
        $service = [
            'apis' => $this->formatRsdApiList(),
            'engineName' => 'MediaWiki',
            'engineLink' => 'https://www.mediawiki.org/',
            'homePageLink' => Title::newMainPage()->getCanonicalURL(),
        ];
 
        ApiResult::setSubelementsList( $service, [ 'engineName', 'engineLink', 'homePageLink' ] );
        ApiResult::setIndexedTagName( $service['apis'], 'api' );
 
        $result->addValue( null, 'service', $service );
    }
 
    public function getCustomPrinter() {
        return new ApiFormatXmlRsd( $this->getMain(), 'xml' );
    }
 
    protected function getExamplesMessages() {
        return [
            'action=rsd'
                => 'apihelp-rsd-example-simple',
        ];
    }
 
    public function isReadMode() {
        return false;
    }
 
    protected function getRsdApiList() {
        // Loaded here rather than injected due to the direct extension of ApiBase.
        $urlUtils = MediaWikiServices::getInstance()->getUrlUtils();
        $apis = [
            'MediaWiki' => [
                // The API link is required for all RSD API entries.
                'apiLink' => (string)$urlUtils->expand( wfScript( 'api' ), PROTO_CURRENT ),
 
                // Docs link is optional, but recommended.
                'docs' => 'https://www.mediawiki.org/wiki/Special:MyLanguage/API',
 
                // Some APIs may need a blog ID, but it may be left blank.
                'blogID' => '',
 
                // Additional settings are optional.
                'settings' => [
                    // Change this to true in the future as an aid to
                    // machine discovery of OAuth for API access.
                    'OAuth' => false,
                ]
            ],
        ];
        $this->getHookRunner()->onApiRsdServiceApis( $apis );
 
        return $apis;
    }
 
    protected function formatRsdApiList() {
        $apis = $this->getRsdApiList();
 
        $outputData = [];
        foreach ( $apis as $name => $info ) {
            $data = [
                'name' => $name,
                'preferred' => wfBoolToStr( $name == 'MediaWiki' ),
                'apiLink' => $info['apiLink'],
                'blogID' => $info['blogID'] ?? '',
            ];
            $settings = [];
            if ( isset( $info['docs'] ) ) {
                $settings['docs'] = $info['docs'];
                ApiResult::setSubelementsList( $settings, 'docs' );
            }
            if ( isset( $info['settings'] ) ) {
                foreach ( $info['settings'] as $setting => $val ) {
                    if ( is_bool( $val ) ) {
                        $xmlVal = wfBoolToStr( $val );
                    } else {
                        $xmlVal = $val;
                    }
                    $setting = [ 'name' => $setting ];
                    ApiResult::setContentValue( $setting, 'value', $xmlVal );
                    $settings[] = $setting;
                }
            }
            if ( count( $settings ) ) {
                ApiResult::setIndexedTagName( $settings, 'setting' );
                $data['settings'] = $settings;
            }
            $outputData[] = $data;
        }
 
        return $outputData;
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Rsd';
    }
}
 
class_alias( ApiRsd::class, 'ApiRsd' );