ApiTranslationReview Class Reference

API module for marking translations as reviewed. More...

List of all members.

Public Member Functions
	execute ()
	isWriteMode ()
	needsToken ()
	getTokenSalt ()
	getAllowedParams ()
	getParamDescription ()
	getDescription ()
	getPossibleErrors ()
	getExamples ()
	getVersion ()
Static Public Member Functions
static	doReview (User $user, Revision $revision, $comment=null)
	Executes the real stuff.
static	getReviewBlockers (User $user, Revision $revision)
	Validates review action by checking permissions and other things.
static	getToken ()
static	injectTokenFunction (&$list)
static	getRight ()
Static Protected Attributes
static	$right = 'translate-messagereview'
static	$salt = 'translate-messagereview'

---

Detailed Description

API module for marking translations as reviewed.

Definition at line 15 of file ApiTranslationReview.php.

---

Member Function Documentation

static ApiTranslationReview::doReview	(	User $	user,
		Revision $	revision,
		$	comment = null
	)			[static]

Executes the real stuff.

No checks done!

Parameters:

	User	$user
	Revision	$revision
	null|string	$comment

Returns:

Bool, whether the action was recorded.

Definition at line 73 of file ApiTranslationReview.php.

Referenced by execute(), and MessageGroupStatesUpdaterJobTest::testHooks().

ApiTranslationReview::execute

(

)

Definition at line 19 of file ApiTranslationReview.php.

Here is the call graph for this function:

ApiTranslationReview::getAllowedParams

(

)

Definition at line 148 of file ApiTranslationReview.php.

ApiTranslationReview::getDescription

(

)

Definition at line 170 of file ApiTranslationReview.php.

ApiTranslationReview::getExamples

(

)

Definition at line 186 of file ApiTranslationReview.php.

ApiTranslationReview::getParamDescription

(

)

Definition at line 161 of file ApiTranslationReview.php.

Here is the call graph for this function:

ApiTranslationReview::getPossibleErrors

(

)

Definition at line 174 of file ApiTranslationReview.php.

static ApiTranslationReview::getReviewBlockers	(	User $	user,
		Revision $	revision
	)			[static]

Validates review action by checking permissions and other things.

Parameters:

	User	$user
	Revision	$revision

Returns:

string Error key or empty string if review is allowed.

Since:

2012-09-24

Definition at line 114 of file ApiTranslationReview.php.

Referenced by execute(), and ApiTranslationReviewTest::testgetReviewBlockers().

static ApiTranslationReview::getRight

(

)

[static]

Definition at line 211 of file ApiTranslationReview.php.

static ApiTranslationReview::getToken

(

)

[static]

Definition at line 196 of file ApiTranslationReview.php.

Referenced by MessageTable::getReviewButton().

ApiTranslationReview::getTokenSalt

(

)

Definition at line 144 of file ApiTranslationReview.php.

ApiTranslationReview::getVersion

(

)

Definition at line 192 of file ApiTranslationReview.php.

static ApiTranslationReview::injectTokenFunction

(

&$

list

)

[static]

Definition at line 205 of file ApiTranslationReview.php.

ApiTranslationReview::isWriteMode

(

)

Definition at line 136 of file ApiTranslationReview.php.

ApiTranslationReview::needsToken

(

)

Definition at line 140 of file ApiTranslationReview.php.

---

Member Data Documentation

ApiTranslationReview::$right = 'translate-messagereview' [static, protected]

Definition at line 16 of file ApiTranslationReview.php.

Referenced by getPossibleErrors().

ApiTranslationReview::$salt = 'translate-messagereview' [static, protected]

Definition at line 17 of file ApiTranslationReview.php.

---

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

• Translate/api/ApiTranslationReview.php