ApiAggregateGroups Class Reference

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

List of all members.

Public Member Functions
	execute ()
	isWriteMode ()
	getTokenSalt ()
	needsToken ()
	getAllowedParams ()
	getParamDescription ()
	getDescription ()
	getPossibleErrors ()
	getExamples ()
	getVersion ()
Static Public Member Functions
static	getAllPages ()
static	getToken ()
static	injectTokenFunction (&$list)
static	getRight ()
Protected Member Functions
	generateAggregateGroupId ($aggregateGroupName, $prefix="agg-")
Static Protected Attributes
static	$right = 'translate-manage'
static	$salt = '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.

Definition at line 18 of file ApiAggregateGroups.php.

---

Member Function Documentation

ApiAggregateGroups::execute

(

)

Definition at line 22 of file ApiAggregateGroups.php.

Here is the call graph for this function:

ApiAggregateGroups::generateAggregateGroupId	(	$	aggregateGroupName,
		$	prefix = "agg-"
	)			[protected]

Definition at line 136 of file ApiAggregateGroups.php.

Referenced by execute().

ApiAggregateGroups::getAllowedParams

(

)

Definition at line 158 of file ApiAggregateGroups.php.

static ApiAggregateGroups::getAllPages

(

)

[static]

Definition at line 220 of file ApiAggregateGroups.php.

Referenced by execute().

Here is the call graph for this function:

ApiAggregateGroups::getDescription

(

)

Definition at line 197 of file ApiAggregateGroups.php.

ApiAggregateGroups::getExamples

(

)

Definition at line 210 of file ApiAggregateGroups.php.

ApiAggregateGroups::getParamDescription

(

)

Definition at line 184 of file ApiAggregateGroups.php.

Here is the call graph for this function:

ApiAggregateGroups::getPossibleErrors

(

)

Definition at line 202 of file ApiAggregateGroups.php.

static ApiAggregateGroups::getRight

(

)

[static]

Definition at line 247 of file ApiAggregateGroups.php.

static ApiAggregateGroups::getToken

(

)

[static]

Definition at line 232 of file ApiAggregateGroups.php.

ApiAggregateGroups::getTokenSalt

(

)

Definition at line 150 of file ApiAggregateGroups.php.

ApiAggregateGroups::getVersion

(

)

Definition at line 216 of file ApiAggregateGroups.php.

static ApiAggregateGroups::injectTokenFunction

(

&$

list

)

[static]

Definition at line 241 of file ApiAggregateGroups.php.

ApiAggregateGroups::isWriteMode

(

)

Definition at line 146 of file ApiAggregateGroups.php.

ApiAggregateGroups::needsToken

(

)

Definition at line 154 of file ApiAggregateGroups.php.

---

Member Data Documentation

ApiAggregateGroups::$right = 'translate-manage' [static, protected]

Definition at line 19 of file ApiAggregateGroups.php.

Referenced by getPossibleErrors().

ApiAggregateGroups::$salt = 'translate-manage' [static, protected]

Definition at line 20 of file ApiAggregateGroups.php.

---

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

• Translate/api/ApiAggregateGroups.php