ApiRsd.php

Go to the documentation of this file.

<?php

class ApiRsd extends ApiBase {

        public function __construct( $main, $action ) {
                parent::__construct( $main, $action );
        }

        public function execute() {
                $result = $this->getResult();

                $result->addValue( null, 'version', '1.0' );
                $result->addValue( null, 'xmlns', 'http://archipelago.phrasewise.com/rsd' );

                $service = array( 'apis' => $this->formatRsdApiList() );
                ApiResult::setContent( $service, 'MediaWiki', 'engineName' );
                ApiResult::setContent( $service, 'https://www.mediawiki.org/', 'engineLink' );
                ApiResult::setContent( $service, Title::newMainPage()->getCanonicalUrl(), 'homePageLink' );

                $result->setIndexedTagName( $service['apis'], 'api' );

                $result->addValue( null, 'service', $service );
        }

        public function getCustomPrinter() {
                return new ApiFormatXmlRsd( $this->getMain(), 'xml' );
        }

        public function getAllowedParams() {
                return array();
        }

        public function getParamDescription() {
                return array();
        }

        public function getDescription() {
                return 'Export an RSD (Really Simple Discovery) schema';
        }

        public function getExamples() {
                return array(
                        'api.php?action=rsd'
                );
        }

        protected function getRsdApiList() {
                $apis = array(
                        'MediaWiki' => array(
                                // The API link is required for all RSD API entries.
                                'apiLink' => wfExpandUrl( wfScript( 'api' ), PROTO_CURRENT ),

                                // Docs link is optional, but recommended.
                                'docs' => 'https://www.mediawiki.org/wiki/API',

                                // Some APIs may need a blog ID, but it may be left blank.
                                'blogID' => '',

                                // Additional settings are optional.
                                'settings' => array(
                                        // Change this to true in the future as an aid to
                                        // machine discovery of OAuth for API access.
                                        'OAuth' => false,
                                )
                        ),
                );
                wfRunHooks( 'ApiRsdServiceApis', array( &$apis ) );
                return $apis;
        }

        protected function formatRsdApiList() {
                $apis = $this->getRsdApiList();

                $outputData = array();
                foreach ( $apis as $name => $info ) {
                        $data = array(
                                'name' => $name,
                                'preferred' => wfBoolToStr( $name == 'MediaWiki' ),
                                'apiLink' => $info['apiLink'],
                                'blogID' => isset( $info['blogID'] ) ? $info['blogID'] : '',
                        );
                        $settings = array();
                        if ( isset( $info['docs'] ) ) {
                                ApiResult::setContent( $settings, $info['docs'], 'docs' );
                        }
                        if ( isset( $info['settings'] ) ) {
                                foreach ( $info['settings'] as $setting => $val ) {
                                        if ( is_bool( $val ) ) {
                                                $xmlVal = wfBoolToStr( $val );
                                        } else {
                                                $xmlVal = $val;
                                        }
                                        $setting = array( 'name' => $setting );
                                        ApiResult::setContent( $setting, $xmlVal );
                                        $settings[] = $setting;
                                }
                        }
                        if ( count( $settings ) ) {
                                $this->getResult()->setIndexedTagName( $settings, 'setting' );
                                $data['settings'] = $settings;
                        }
                        $outputData[] = $data;
                }
                return $outputData;
        }

        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
}

class ApiFormatXmlRsd extends ApiFormatXml {
        public function __construct( $main, $format ) {
                parent::__construct( $main, $format );
                $this->setRootElement( 'rsd' );
        }

        public function getMimeType() {
                return 'application/rsd+xml';
        }

        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
}