BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
SpecialPageFactory Class Reference

Static Public Member Functions

static resetList ()
 
static getNames ()
 
static resolveAlias ($alias)
 
static exists ($name)
 
static getPage ($name)
 
static getUsablePages (User $user=null)
 
static getRegularPages ()
 
static getRestrictedPages (User $user=null)
 
static executePath (Title &$title, IContextSource &$context, $including=false, LinkRenderer $linkRenderer=null)
 
static capturePath (Title $title, IContextSource $context, LinkRenderer $linkRenderer=null)
 
static getLocalNameFor ($name, $subpage=false)
 
static getTitleForAlias ($alias)
 

Detailed Description

Factory for handling the special page list and generating SpecialPage objects.

To add a special page in an extension, add to $wgSpecialPages either an object instance or an array containing the name and constructor parameters. The latter is preferred for performance reasons.

The object instantiated must be either an instance of SpecialPage or a sub-class thereof. It must have an execute() method, which sends the HTML for the special page to $wgOut. The parent class has an execute() method which distributes the call to the historical global functions. Additionally, execute() also checks if the user has the necessary access privileges and bails out if not.

To add a core special page, use the similar static list in SpecialPageFactory::$list. To remove a core static special page at runtime, use a SpecialPage_initList hook.

Since
1.17

Member Function Documentation

static SpecialPageFactory::capturePath ( Title  $title,
IContextSource  $context,
LinkRenderer  $linkRenderer = null 
)
static

Just like executePath() but will override global variables and execute the page in "inclusion" mode. Returns true if the execution was successful or false if there was no such special page, or a title object if it was a redirect.

Also saves the current $wgTitle, $wgOut, $wgRequest, $wgUser and $wgLang variables so that the special page will get the context it'd expect on a normal request, and then restores them to their previous values after.

Parameters
Title$title
IContextSource$context
LinkRenderer | null$linkRenderer(since 1.28)
Returns
string HTML fragment
static SpecialPageFactory::executePath ( Title $title,
IContextSource $context,
  $including = false,
LinkRenderer  $linkRenderer = null 
)
static

Execute a special page path. The path may contain parameters, e.g. Special:Name/Params Extracts the special page name and call the execute method, passing the parameters

Returns a title object if the page is redirected, false if there was no such special page, and true if it was successful.

Parameters
Title&$title
IContextSource&$context
bool$includingBool output is being captured for use in {{special:whatever}}
LinkRenderer | null$linkRenderer(since 1.28)
Returns
bool|Title
static SpecialPageFactory::exists (   $name)
static

Check if a given name exist as a special page or as a special page alias

Parameters
string$nameName of a special page
Returns
bool True if a special page exists with this name
static SpecialPageFactory::getLocalNameFor (   $name,
  $subpage = false 
)
static

Get the local name for a specified canonical name

Parameters
string$name
string | bool$subpage
Returns
string
static SpecialPageFactory::getNames ( )
static

Returns a list of canonical special page names. May be used to iterate over all registered special pages.

Returns
string[]
static SpecialPageFactory::getPage (   $name)
static

Find the object with a given name and return it (or NULL)

Parameters
string$nameSpecial page name, may be localised and/or an alias
Returns
SpecialPage|null SpecialPage object or null if the page doesn't exist
static SpecialPageFactory::getRegularPages ( )
static

Return categorised listable special pages for all users

Returns
array ( string => Specialpage )
static SpecialPageFactory::getRestrictedPages ( User  $user = null)
static

Return categorised listable special pages which are available for the current user, but not for everyone

Parameters
User | null$userUser object to use or null for $wgUser
Returns
array ( string => Specialpage )
static SpecialPageFactory::getTitleForAlias (   $alias)
static

Get a title for a given alias

Parameters
string$alias
Returns
Title|null Title or null if there is no such alias
static SpecialPageFactory::getUsablePages ( User  $user = null)
static

Return categorised listable special pages which are available for the current user, and everyone.

Parameters
User$userUser object to check permissions, $wgUser will be used if not provided
Returns
array ( string => Specialpage )
static SpecialPageFactory::resetList ( )
static

Reset the internal list of special pages. Useful when changing $wgSpecialPages after the internal list has already been initialized, e.g. during testing.

static SpecialPageFactory::resolveAlias (   $alias)
static

Given a special page name with a possible subpage, return an array where the first element is the special page name and the second is the subpage.

Parameters
string$alias
Returns
array Array( String, String|null ), or array( null, null ) if the page is invalid

The documentation for this class was generated from the following file: