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)

	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

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 64 of file SpecialPageFactory.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ServiceOptions	$options
Language	$contLang
ObjectFactory	$objectFactory

Definition at line 276 of file SpecialPageFactory.php.

References MediaWiki\SpecialPage\SpecialPageFactory\$contLang, 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 643 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 559 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 426 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.