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

Collaboration diagram for MediaWiki\SpecialPage\SpecialPageFactory:

[legend]

Public Member Functions
	__construct (ServiceOptions $options, Language $contLang, ObjectFactory $objectFactory, HookContainer $hookContainer)

	capturePath (Title $title, IContextSource $context, LinkRenderer $linkRenderer=null)
	Just like executePath() but will override global variables and execute the page in "inclusion" mode. More...

	executePath (Title &$title, IContextSource &$context, $including=false, LinkRenderer $linkRenderer=null)
	Execute a special page path. More...

	exists ( $name)
	Check if a given name exist as a special page or as a special page alias. More...

	getLocalNameFor ( $name, $subpage=false)
	Get the local name for a specified canonical name. More...

	getNames ()
	Returns a list of canonical special page names. More...

	getPage ( $name)
	Find the object with a given name and return it (or NULL) More...

	getRegularPages ()
	Return categorised listable special pages for all users. More...

	getRestrictedPages (User $user)
	Return categorised listable special pages which are available for the current user, but not for everyone. More...

	getTitleForAlias ( $alias)
	Get a title for a given alias. More...

	getUsablePages (User $user)
	Return categorised listable special pages which are available for the current user, and everyone. More...

	resolveAlias ( $alias)
	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. More...

Private Member Functions
	getAliasList ()
	Initialise and return the list of special page aliases. More...

	getPageList ()
	Get the special page list as an array. More...

Private Attributes
array	$aliases

Language	$contLang

HookContainer	$hookContainer

HookRunner	$hookRunner

array	$list
	Special page name => class name. More...

ObjectFactory	$objectFactory

ServiceOptions	$options

const	CORE_LIST
	List of special page names to the subclass of SpecialPage which handles them. More...

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.

Note: There are two classes called SpecialPageFactory. You should use this first one, in namespace MediaWiki\Special, which is a service. \SpecialPageFactory is a deprecated collection of static methods that forwards to the global service.

Since: 1.17

Definition at line 65 of file SpecialPageFactory.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\SpecialPage\SpecialPageFactory::__construct	(	ServiceOptions	$options,
		Language	$contLang,
		ObjectFactory	$objectFactory,
		HookContainer	$hookContainer
	)

Parameters

ServiceOptions	$options
Language	$contLang
ObjectFactory	$objectFactory
HookContainer	$hookContainer

Definition at line 320 of file SpecialPageFactory.php.

References MediaWiki\SpecialPage\SpecialPageFactory\$contLang, MediaWiki\SpecialPage\SpecialPageFactory\$hookContainer, MediaWiki\SpecialPage\SpecialPageFactory\$objectFactory, MediaWiki\SpecialPage\SpecialPageFactory\$options, and MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ capturePath()

MediaWiki\SpecialPage\SpecialPageFactory::capturePath	(	Title	$title,
		IContextSource	$context,
		LinkRenderer	$linkRenderer = `null`
	)

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

Definition at line 701 of file SpecialPageFactory.php.

References MediaWiki\$context, $title, $wgLang, $wgOut, $wgRequest, $wgTitle, MediaWiki\SpecialPage\SpecialPageFactory\executePath(), IContextSource\getLanguage(), RequestContext\getMain(), IContextSource\getOutput(), IContextSource\getRequest(), and IContextSource\getUser().

◆ executePath()

MediaWiki\SpecialPage\SpecialPageFactory::executePath	(	Title &	$title,
		IContextSource &	$context,
			$including = `false`,
		LinkRenderer	$linkRenderer = `null`
	)

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	$including	Bool output is being captured for use in {{special:whatever}}
LinkRenderer \| null	$linkRenderer	(since 1.28)

Returns: bool|Title

Definition at line 617 of file SpecialPageFactory.php.

References MediaWiki\$context, $title, $wgSend404Code, IContextSource\getConfig(), IContextSource\getOutput(), MediaWiki\SpecialPage\SpecialPageFactory\getPage(), IContextSource\getRequest(), and Profiler\instance().

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\capturePath().

◆ exists()

MediaWiki\SpecialPage\SpecialPageFactory::exists ( $name )

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

Parameters

string $name Name of a special page

Returns: bool True if a special page exists with this name

Definition at line 482 of file SpecialPageFactory.php.

References $title, MediaWiki\SpecialPage\SpecialPageFactory\getPageList(), and MediaWiki\SpecialPage\SpecialPageFactory\resolveAlias().

◆ getAliasList()

MediaWiki\SpecialPage\SpecialPageFactory::getAliasList ( )

private

Initialise and return the list of special page aliases.

Returns an array where the key is an alias, and the value is the canonical name of the special page. All registered special pages are guaranteed to map to themselves.

Returns: array

Definition at line 405 of file SpecialPageFactory.php.

References MediaWiki\SpecialPage\SpecialPageFactory\$aliases, MediaWiki\SpecialPage\SpecialPageFactory\getPageList(), and wfWarn().

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\getLocalNameFor(), and MediaWiki\SpecialPage\SpecialPageFactory\resolveAlias().

◆ getLocalNameFor()

MediaWiki\SpecialPage\SpecialPageFactory::getLocalNameFor	(	$name,
		$subpage = `false`
	)

Get the local name for a specified canonical name.

Parameters

string	$name
string \| bool	$subpage

Returns: string

Definition at line 766 of file SpecialPageFactory.php.

References MediaWiki\SpecialPage\SpecialPageFactory\$aliases, MediaWiki\SpecialPage\SpecialPageFactory\getAliasList(), and wfWarn().

◆ getNames()

MediaWiki\SpecialPage\SpecialPageFactory::getNames ( )

Returns a list of canonical special page names.

May be used to iterate over all registered special pages.

Returns: string[]

Definition at line 340 of file SpecialPageFactory.php.

References MediaWiki\SpecialPage\SpecialPageFactory\getPageList().

◆ getPage()

MediaWiki\SpecialPage\SpecialPageFactory::getPage ( $name )

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

Parameters

string $name Special page name, may be localised and/or an alias

Returns: SpecialPage|null SpecialPage object or null if the page doesn't exist

Definition at line 495 of file SpecialPageFactory.php.

References MediaWiki\SpecialPage\SpecialPageFactory\getPageList(), MediaWiki\SpecialPage\SpecialPageFactory\resolveAlias(), wfDeprecatedMsg(), and wfLogWarning().

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\executePath(), MediaWiki\SpecialPage\SpecialPageFactory\getRegularPages(), MediaWiki\SpecialPage\SpecialPageFactory\getRestrictedPages(), and MediaWiki\SpecialPage\SpecialPageFactory\getUsablePages().

◆ getPageList()

MediaWiki\SpecialPage\SpecialPageFactory::getPageList ( )

private

Get the special page list as an array.

Returns: array

Definition at line 349 of file SpecialPageFactory.php.

References MediaWiki\SpecialPage\SpecialPageFactory\$list, and MediaWiki\SpecialPage\SpecialPageFactory\CORE_LIST.

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\exists(), MediaWiki\SpecialPage\SpecialPageFactory\getAliasList(), MediaWiki\SpecialPage\SpecialPageFactory\getNames(), MediaWiki\SpecialPage\SpecialPageFactory\getPage(), MediaWiki\SpecialPage\SpecialPageFactory\getRegularPages(), MediaWiki\SpecialPage\SpecialPageFactory\getRestrictedPages(), and MediaWiki\SpecialPage\SpecialPageFactory\getUsablePages().

◆ getRegularPages()

MediaWiki\SpecialPage\SpecialPageFactory::getRegularPages ( )

Return categorised listable special pages for all users.

Returns: array ( string => Specialpage )

Definition at line 567 of file SpecialPageFactory.php.

References MediaWiki\SpecialPage\SpecialPageFactory\getPage(), and MediaWiki\SpecialPage\SpecialPageFactory\getPageList().

◆ getRestrictedPages()

MediaWiki\SpecialPage\SpecialPageFactory::getRestrictedPages ( User $user )

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

Parameters

User $user User object to use

Returns: array ( string => Specialpage )

Definition at line 586 of file SpecialPageFactory.php.

References MediaWiki\SpecialPage\SpecialPageFactory\getPage(), and MediaWiki\SpecialPage\SpecialPageFactory\getPageList().

◆ getTitleForAlias()

MediaWiki\SpecialPage\SpecialPageFactory::getTitleForAlias ( $alias )

Get a title for a given alias.

Parameters

string $alias

Returns: Title|null Title or null if there is no such alias

Definition at line 819 of file SpecialPageFactory.php.

References SpecialPage\getTitleFor(), and MediaWiki\SpecialPage\SpecialPageFactory\resolveAlias().

◆ getUsablePages()

MediaWiki\SpecialPage\SpecialPageFactory::getUsablePages ( User $user )

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

Parameters

User $user User object to check permissions provided

Returns: array ( string => Specialpage )

Definition at line 545 of file SpecialPageFactory.php.

References RequestContext\getMain(), MediaWiki\SpecialPage\SpecialPageFactory\getPage(), and MediaWiki\SpecialPage\SpecialPageFactory\getPageList().

◆ resolveAlias()

MediaWiki\SpecialPage\SpecialPageFactory::resolveAlias ( $alias )

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 [ String, String|null ], or [ null, null ] if the page is invalid

Definition at line 461 of file SpecialPageFactory.php.

References MediaWiki\SpecialPage\SpecialPageFactory\$aliases, and MediaWiki\SpecialPage\SpecialPageFactory\getAliasList().

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\exists(), MediaWiki\SpecialPage\SpecialPageFactory\getPage(), and MediaWiki\SpecialPage\SpecialPageFactory\getTitleForAlias().

Member Data Documentation

◆ $aliases

array MediaWiki\SpecialPage\SpecialPageFactory::$aliases

private

Definition at line 283 of file SpecialPageFactory.php.

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\getAliasList(), MediaWiki\SpecialPage\SpecialPageFactory\getLocalNameFor(), and MediaWiki\SpecialPage\SpecialPageFactory\resolveAlias().

◆ $contLang

Language MediaWiki\SpecialPage\SpecialPageFactory::$contLang

private

Definition at line 289 of file SpecialPageFactory.php.

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\__construct().

◆ $hookContainer

HookContainer MediaWiki\SpecialPage\SpecialPageFactory::$hookContainer

private

Definition at line 295 of file SpecialPageFactory.php.

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\__construct().

◆ $hookRunner

HookRunner MediaWiki\SpecialPage\SpecialPageFactory::$hookRunner

private

Definition at line 298 of file SpecialPageFactory.php.

◆ $list

array MediaWiki\SpecialPage\SpecialPageFactory::$list

private

Special page name => class name.

Definition at line 280 of file SpecialPageFactory.php.

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\getPageList().

◆ $objectFactory

ObjectFactory MediaWiki\SpecialPage\SpecialPageFactory::$objectFactory

private

Definition at line 292 of file SpecialPageFactory.php.

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\__construct().

◆ $options

ServiceOptions MediaWiki\SpecialPage\SpecialPageFactory::$options

private

Definition at line 286 of file SpecialPageFactory.php.

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\__construct().

◆ CORE_LIST

const MediaWiki\SpecialPage\SpecialPageFactory::CORE_LIST

private

List of special page names to the subclass of SpecialPage which handles them.

Definition at line 69 of file SpecialPageFactory.php.

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\getPageList().

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

includes/specialpage/SpecialPageFactory.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ capturePath()

◆ executePath()

◆ exists()

◆ getAliasList()

◆ getLocalNameFor()

◆ getNames()

◆ getPage()

◆ getPageList()

◆ getRegularPages()

◆ getRestrictedPages()

◆ getTitleForAlias()

◆ getUsablePages()

◆ resolveAlias()

Member Data Documentation

◆ $aliases

◆ $contLang

◆ $hookContainer

◆ $hookRunner

◆ $list

◆ $objectFactory

◆ $options

◆ CORE_LIST