MediaWiki  master
MediaWiki\Actions\ActionFactory Class Reference

Public Member Functions

 __construct (array $actionsConfig, LoggerInterface $logger, ObjectFactory $objectFactory, HookContainer $hookContainer)
 
 getAction (string $actionName, $article, IContextSource $context)
 Get an appropriate Action subclass for the given action, taking into account Article-specific overrides. More...
 
 getActionInfo (string $name, $target=null)
 Returns an object containing information about the given action, or null if the action is not known. More...
 
 getActionName (IContextSource $context)
 Get the name of the action that will be executed, not necessarily the one passed through the "action" request parameter. More...
 

Protected Member Functions

 getArticle (IContextSource $context)
 Protected to allow overriding with a partial mock in unit tests. More...
 

Detailed Description

Since
1.37
Author
DannyS712

Definition at line 47 of file ActionFactory.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Actions\ActionFactory::__construct ( array  $actionsConfig,
LoggerInterface  $logger,
ObjectFactory  $objectFactory,
HookContainer  $hookContainer 
)
Parameters
array$actionsConfigConfigured actions (eg those added by extensions to $wgActions)
LoggerInterface$logger
ObjectFactory$objectFactory
HookContainer$hookContainer

Definition at line 186 of file ActionFactory.php.

Member Function Documentation

◆ getAction()

MediaWiki\Actions\ActionFactory::getAction ( string  $actionName,
  $article,
IContextSource  $context 
)

Get an appropriate Action subclass for the given action, taking into account Article-specific overrides.

Parameters
string$actionName
Article | PageIdentity$articleThe target on which the action is to be performed.
IContextSource$context
Returns
Action|false|null False if the action is disabled, null if not recognized

Definition at line 227 of file ActionFactory.php.

References MediaWiki\Title\Title\newFromPageIdentity(), and Article\newFromTitle().

◆ getActionInfo()

MediaWiki\Actions\ActionFactory::getActionInfo ( string  $name,
  $target = null 
)

Returns an object containing information about the given action, or null if the action is not known.

Currently, this will also return null if the action is known but disabled. This may change in the future.

Parameters
string$name
Article | PageIdentity | null$targetThe target on which the action is to be performed, if known. This is used to apply page-specific action overrides.
Returns
?ActionInfo
Since
1.41

Definition at line 315 of file ActionFactory.php.

References MediaWiki\Title\Title\newMainPage().

◆ getActionName()

MediaWiki\Actions\ActionFactory::getActionName ( IContextSource  $context)

Get the name of the action that will be executed, not necessarily the one passed through the "action" request parameter.

Actions disabled in $wgActions will be replaced by "nosuchaction".

Parameters
IContextSource$context
Returns
string Action name

Definition at line 350 of file ActionFactory.php.

◆ getArticle()

MediaWiki\Actions\ActionFactory::getArticle ( IContextSource  $context)
protected

Protected to allow overriding with a partial mock in unit tests.

Parameters
IContextSource$context
Returns
Article

Definition at line 407 of file ActionFactory.php.


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