Translate extension for MediaWiki
 
Loading...
Searching...
No Matches
MediaWiki\Extension\Translate\MessageGroupProcessing\AggregateGroupsActionApi Class Reference

API module for managing aggregate message groups Only supports aggregate message groups defined inside the wiki. More...

Inheritance diagram for MediaWiki\Extension\Translate\MessageGroupProcessing\AggregateGroupsActionApi:

Public Member Functions

 __construct (ApiMain $main, string $action, JobQueueGroup $jobQueueGroup)
 
 execute ()
 
 isWriteMode ()
 
 needsToken ()
 

Static Public Member Functions

static getAllPages ()
 

Protected Member Functions

 generateAggregateGroupId (string $aggregateGroupName, string $prefix='agg-')
 
 getAllowedParams ()
 
 getExamplesMessages ()
 

Static Protected Attributes

static $right = 'translate-manage'
 

Detailed Description

API module for managing aggregate message groups Only supports aggregate message groups defined inside the wiki.

Aggregate message group defined in YAML configuration cannot be altered.

Author
Santhosh Thottingal
Niklas Laxström

Definition at line 28 of file AggregateGroupsActionApi.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Extension\Translate\MessageGroupProcessing\AggregateGroupsActionApi::__construct ( ApiMain $main,
string $action,
JobQueueGroup $jobQueueGroup )

Definition at line 35 of file AggregateGroupsActionApi.php.

Member Function Documentation

◆ execute()

MediaWiki\Extension\Translate\MessageGroupProcessing\AggregateGroupsActionApi::execute ( )

Definition at line 44 of file AggregateGroupsActionApi.php.

◆ generateAggregateGroupId()

MediaWiki\Extension\Translate\MessageGroupProcessing\AggregateGroupsActionApi::generateAggregateGroupId ( string $aggregateGroupName,
string $prefix = 'agg-' )
protected

Definition at line 274 of file AggregateGroupsActionApi.php.

◆ getAllowedParams()

MediaWiki\Extension\Translate\MessageGroupProcessing\AggregateGroupsActionApi::getAllowedParams ( )
protected

Definition at line 292 of file AggregateGroupsActionApi.php.

◆ getAllPages()

static MediaWiki\Extension\Translate\MessageGroupProcessing\AggregateGroupsActionApi::getAllPages ( )
static

Definition at line 328 of file AggregateGroupsActionApi.php.

◆ getExamplesMessages()

MediaWiki\Extension\Translate\MessageGroupProcessing\AggregateGroupsActionApi::getExamplesMessages ( )
protected

Definition at line 321 of file AggregateGroupsActionApi.php.

◆ isWriteMode()

MediaWiki\Extension\Translate\MessageGroupProcessing\AggregateGroupsActionApi::isWriteMode ( )

Definition at line 284 of file AggregateGroupsActionApi.php.

◆ needsToken()

MediaWiki\Extension\Translate\MessageGroupProcessing\AggregateGroupsActionApi::needsToken ( )

Definition at line 288 of file AggregateGroupsActionApi.php.

Member Data Documentation

◆ $right

MediaWiki\Extension\Translate\MessageGroupProcessing\AggregateGroupsActionApi::$right = 'translate-manage'
staticprotected

Definition at line 32 of file AggregateGroupsActionApi.php.


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