MediaWiki  1.23.12
SpecialJavaScriptTest Class Reference
Inheritance diagram for SpecialJavaScriptTest:
Collaboration diagram for SpecialJavaScriptTest:

Public Member Functions

 __construct ()
 
 execute ( $par)
 Default execute method Checks user permissions, calls the function given in mFunction. More...
 
- Public Member Functions inherited from SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='default', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 getDescription ()
 Returns the name that goes in the <h1> in the special page itself, and also the name that will be listed in Special:Specialpages. More...
 
 getFile ()
 Get the file which will be included by SpecialPage::execute() if your extension is still stuck in the past and hasn't overridden the execute() method. More...
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLang ()
 Shortcut to get user's language. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLocalName ()
 Get the localised name of the special page. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 msg ()
 Wrapper around wfMessage that sets the current context. More...
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...
 
 requireLogin ( $reasonMsg=null, $titleMsg=null)
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Protected Member Functions

 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More...
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 

Private Member Functions

 exportQUnit ()
 Generate self-sufficient JavaScript payload to run the tests elsewhere. More...
 
 getFrameworkListHtml ()
 Get a list of frameworks (including introduction paragraph and links to the framework run pages) More...
 
 plainQUnit ()
 
 viewQUnit ()
 Run the test suite on the Special page. More...
 
 wrapSummaryHtml ( $html)
 Wrap HTML contents in a summary container. More...
 

Static Private Attributes

static $frameworks
 

Additional Inherited Members

- Static Public Member Functions inherited from SpecialPage
static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage. More...
 
static getTitleFor ( $name, $subpage=false, $fragment='')
 Get a localised Title object for a specified special page name. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 

Detailed Description

Definition at line 27 of file SpecialJavaScriptTest.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialJavaScriptTest::__construct ( )

Definition at line 36 of file SpecialJavaScriptTest.php.

Member Function Documentation

◆ execute()

SpecialJavaScriptTest::execute (   $subPage)

Default execute method Checks user permissions, calls the function given in mFunction.

This must be overridden by subclasses; it will be made abstract in a future version

Parameters
string | null$subPage

Reimplemented from SpecialPage.

Definition at line 40 of file SpecialJavaScriptTest.php.

References $out, array(), getFrameworkListHtml(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), Linker\linkKnown(), SpecialPage\msg(), and SpecialPage\setHeaders().

◆ exportQUnit()

SpecialJavaScriptTest::exportQUnit ( )
private

Generate self-sufficient JavaScript payload to run the tests elsewhere.

Includes startup module to request modules from ResourceLoader.

Note: This modifies the registry to replace 'jquery.qunit' with an empty module to allow external environment to preload QUnit with any neccecary framework adapters (e.g. Karma). Loading it again would re-define QUnit and dereference event handlers from Karma.

Definition at line 204 of file SpecialJavaScriptTest.php.

References $out, $query, array(), Xml\encodeJsCall(), SpecialPage\getLanguage(), SpecialPage\getOutput(), SpecialPage\getSkin(), ResourceLoader\inDebugMode(), Html\inlineScript(), and ResourceLoader\makeConfigSetScript().

◆ getFrameworkListHtml()

SpecialJavaScriptTest::getFrameworkListHtml ( )
private

Get a list of frameworks (including introduction paragraph and links to the framework run pages)

Returns
string HTML

Definition at line 118 of file SpecialJavaScriptTest.php.

References array(), as, SpecialPage\getPageTitle(), Linker\link(), SpecialPage\msg(), and Html\rawElement().

Referenced by execute().

◆ getGroupName()

SpecialJavaScriptTest::getGroupName ( )
protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 274 of file SpecialJavaScriptTest.php.

◆ plainQUnit()

◆ viewQUnit()

SpecialJavaScriptTest::viewQUnit ( )
private

◆ wrapSummaryHtml()

SpecialJavaScriptTest::wrapSummaryHtml (   $html)
private

Wrap HTML contents in a summary container.

Parameters
string$htmlHTML contents to be wrapped
Returns
string HTML

Definition at line 143 of file SpecialJavaScriptTest.php.

Referenced by viewQUnit().

Member Data Documentation

◆ $frameworks

SpecialJavaScriptTest::$frameworks
staticprivate
Initial value:
'qunit',
)

Definition at line 32 of file SpecialJavaScriptTest.php.


The documentation for this class was generated from the following file:
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.