REL1_33/php/SpecialApiSandbox_8php_source.html

<?php


class SpecialApiSandbox extends SpecialPage {


    public function __construct() {

        parent::__construct( 'ApiSandbox' );

    }


    public function execute( $par ) {

        $this->setHeaders();

        $out = $this->getOutput();

        $this->addHelpLink( 'Help:ApiSandbox' );


        $out->addJsConfigVars( 'apihighlimits', $this->getUser()->isAllowed( 'apihighlimits' ) );

        $out->addModuleStyles( [

            'mediawiki.special',

        ] );

        $out->addModules( [

            'mediawiki.special.apisandbox',

            'mediawiki.apipretty',

        ] );

        $out->wrapWikiMsg(

            "<div id='mw-apisandbox'><div class='mw-apisandbox-nojs error'>\n$1\n</div></div>",

            'apisandbox-jsonly'

        );

    }


    protected function getGroupName() {

        return 'wiki';

    }


}


SpecialApiSandbox
Definition SpecialApiSandbox.php:28

SpecialApiSandbox\execute
execute( $par)
Default execute method Checks user permissions.
Definition SpecialApiSandbox.php:33

SpecialApiSandbox\__construct
__construct()
Definition SpecialApiSandbox.php:29

SpecialApiSandbox\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition SpecialApiSandbox.php:52

SpecialPage
Parent class for all special pages.
Definition SpecialPage.php:36

SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition SpecialPage.php:531

SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition SpecialPage.php:725

SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition SpecialPage.php:735

SpecialPage\addHelpLink
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition SpecialPage.php:832

$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:855

php
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:37