ApiQueryMessageGroups Class Reference

Api module for querying MessageGroups. More...

List of all members.

Public Member Functions
	__construct ($query, $moduleName)
	getAllowedParams ()
	getParamDescription ()
	getDescription ()
	getVersion ()
Protected Member Functions
	formatGroup ($mixed, $props, $depth=0)
	getWorkflowStates (MessageGroup $group)
	Get the workflow states applicable to the given message group.
	getExamples ()
Static Protected Member Functions
static	getPropertyList ()
	Returns array of key value pairs of properties and their descriptions.

---

Detailed Description

Api module for querying MessageGroups.

Definition at line 18 of file ApiQueryMessageGroups.php.

---

Constructor & Destructor Documentation

ApiQueryMessageGroups::__construct	(	$	query,
		$	moduleName
	)

Definition at line 20 of file ApiQueryMessageGroups.php.

---

Member Function Documentation

ApiQueryMessageGroups::formatGroup	(	$	mixed,
		$	props,
		$	depth = 0
	)			[protected]

Parameters:

	array|MessageGroup	$mixed
	array	$props List of props as the array keys
	int	$depth

Returns:

array

Definition at line 95 of file ApiQueryMessageGroups.php.

Here is the call graph for this function:

ApiQueryMessageGroups::getAllowedParams

(

)

Definition at line 224 of file ApiQueryMessageGroups.php.

ApiQueryMessageGroups::getDescription

(

)

Definition at line 330 of file ApiQueryMessageGroups.php.

ApiQueryMessageGroups::getExamples

(

)

[protected]

Definition at line 335 of file ApiQueryMessageGroups.php.

ApiQueryMessageGroups::getParamDescription

(

)

Definition at line 258 of file ApiQueryMessageGroups.php.

static ApiQueryMessageGroups::getPropertyList

(

)

[static, protected]

Returns array of key value pairs of properties and their descriptions.

Returns:

array

Definition at line 303 of file ApiQueryMessageGroups.php.

ApiQueryMessageGroups::getVersion

(

)

Definition at line 341 of file ApiQueryMessageGroups.php.

ApiQueryMessageGroups::getWorkflowStates

(

MessageGroup $

group

)

[protected]

Get the workflow states applicable to the given message group.

Parameters:

MessageGroup

$group

Returns:

boolean|array Associative array with states as key and localized state labels as values

Definition at line 193 of file ApiQueryMessageGroups.php.

Referenced by formatGroup().

Here is the call graph for this function:

---

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

• Translate/api/ApiQueryMessageGroups.php