MediaWiki  master
MediaWiki\Actions\ActionFactory Class Reference

Public Member Functions

 __construct (array $actionsConfig, LoggerInterface $logger, ObjectFactory $objectFactory, HookContainer $hookContainer)
 
 actionExists (string $actionName)
 
 getAction (string $actionName, Article $article, IContextSource $context)
 Get an appropriate Action subclass for the given action, taking into account Article-specific overrides. 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 45 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 209 of file ActionFactory.php.

Member Function Documentation

◆ actionExists()

MediaWiki\Actions\ActionFactory::actionExists ( string  $actionName)
Deprecated:
since 1.38
Parameters
string$actionName
Returns
bool

Definition at line 387 of file ActionFactory.php.

◆ getAction()

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

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

Parameters
string$actionName
Article$article
IContextSource$context
Returns
Action|false|null False if the action is disabled, null if not recognized

Definition at line 250 of file ActionFactory.php.

References Article\getActionOverrides().

◆ 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 327 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 404 of file ActionFactory.php.


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