ApiQueryMessageCollection Class Reference

Api module for querying MessageCollection. More...

List of all members.

Public Member Functions
	__construct ($query, $moduleName)
	execute ()
	getCacheMode ($params)
	executeGenerator ($resultPageSet)
	extractMessageData ($result, $props, $message)
	getAllowedParams ()
	getParamDescription ()
	getDescription ()
	getVersion ()
Protected Member Functions
	getExamples ()
Static Protected Member Functions
static	getWorkflowState ($groupId, $language)
	Get the current workflow state for the message group for the given language.

---

Detailed Description

Api module for querying MessageCollection.

Definition at line 16 of file ApiQueryMessageCollection.php.

---

Constructor & Destructor Documentation

ApiQueryMessageCollection::__construct	(	$	query,
		$	moduleName
	)

Definition at line 18 of file ApiQueryMessageCollection.php.

---

Member Function Documentation

ApiQueryMessageCollection::execute

(

)

Definition at line 22 of file ApiQueryMessageCollection.php.

ApiQueryMessageCollection::executeGenerator

(

$

resultPageSet

)

Definition at line 30 of file ApiQueryMessageCollection.php.

ApiQueryMessageCollection::extractMessageData	(	$	result,
		$	props,
		$	message
	)

Parameters:

	$result	ApiResult
	$props	array
	$message	ThinMessage

Returns:

array

Definition at line 135 of file ApiQueryMessageCollection.php.

ApiQueryMessageCollection::getAllowedParams

(

)

Definition at line 188 of file ApiQueryMessageCollection.php.

ApiQueryMessageCollection::getCacheMode

(

$

params

)

Definition at line 26 of file ApiQueryMessageCollection.php.

ApiQueryMessageCollection::getDescription

(

)

Definition at line 263 of file ApiQueryMessageCollection.php.

ApiQueryMessageCollection::getExamples

(

)

[protected]

Definition at line 267 of file ApiQueryMessageCollection.php.

ApiQueryMessageCollection::getParamDescription

(

)

Definition at line 228 of file ApiQueryMessageCollection.php.

ApiQueryMessageCollection::getVersion

(

)

Definition at line 283 of file ApiQueryMessageCollection.php.

static ApiQueryMessageCollection::getWorkflowState	(	$	groupId,
		$	language
	)			[static, protected]

Get the current workflow state for the message group for the given language.

Parameters:

	string	$groupId Group id.
	string	$language Language tag.

Returns:

string|bool State id or false.

Definition at line 174 of file ApiQueryMessageCollection.php.

---

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

• Translate/api/ApiQueryMessageCollection.php