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, MessageGroupMetadata $messageGroupMetadata, AggregateGroupManager $aggregateGroupManager)
	execute ()
	isWriteMode ()
	needsToken ()

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

Static Protected Attributes
static string	$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

Copyright

Copyright © 2012-2013, Santhosh Thottingal @license GPL-2.0-or-later

Definition at line 26 of file AggregateGroupsActionApi.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 33 of file AggregateGroupsActionApi.php.

Member Function Documentation

execute()

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

(

)

Definition at line 46 of file AggregateGroupsActionApi.php.

generateAggregateGroupId()

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

protected

Definition at line 277 of file AggregateGroupsActionApi.php.

getAllowedParams()

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

protected

Definition at line 295 of file AggregateGroupsActionApi.php.

getExamplesMessages()

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

protected

Definition at line 325 of file AggregateGroupsActionApi.php.

isWriteMode()

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

(

)

Definition at line 287 of file AggregateGroupsActionApi.php.

needsToken()

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

(

)

Definition at line 291 of file AggregateGroupsActionApi.php.

Member Data Documentation

$right

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

staticprotected

Definition at line 28 of file AggregateGroupsActionApi.php.

---

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

• src/MessageGroupProcessing/AggregateGroupsActionApi.php