Translate extension for MediaWiki
 
Loading...
Searching...
No Matches
MediaWiki\Extension\Translate\MessageGroupProcessing\MessageGroupReviewStore Class Reference

Provides methods to get and change the state of a message group. More...

Public Member Functions

 __construct (IConnectionProvider $dbProvider, HookRunner $hookRunner)
 
 getState (MessageGroup $group, string $code)
 
 changeState (MessageGroup $group, string $code, string $newState, User $user)
 
 getGroupPriority (string $group)
 
 setGroupPriority (string $groupId, ?string $priority)
 Store priority for message group.
 
 getWorkflowState (string $groupId, string $languageCode)
 Get the current workflow state for the given message group for the given language.
 
 getWorkflowStatesForLanguage (string $languageCode, array $groupIds)
 
 getWorkflowStatesForGroup (string $groupId)
 

Detailed Description

Provides methods to get and change the state of a message group.

Author
Eugene Wang'ombe @license GPL-2.0-or-later

Definition at line 20 of file MessageGroupReviewStore.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Extension\Translate\MessageGroupProcessing\MessageGroupReviewStore::__construct ( IConnectionProvider $dbProvider,
HookRunner $hookRunner )

Definition at line 27 of file MessageGroupReviewStore.php.

Member Function Documentation

◆ changeState()

MediaWiki\Extension\Translate\MessageGroupProcessing\MessageGroupReviewStore::changeState ( MessageGroup $group,
string $code,
string $newState,
User $user )
Returns
bool true if the message group state changed, otherwise false

Definition at line 47 of file MessageGroupReviewStore.php.

◆ getGroupPriority()

MediaWiki\Extension\Translate\MessageGroupProcessing\MessageGroupReviewStore::getGroupPriority ( string $group)

Definition at line 86 of file MessageGroupReviewStore.php.

◆ getState()

MediaWiki\Extension\Translate\MessageGroupProcessing\MessageGroupReviewStore::getState ( MessageGroup $group,
string $code )
Returns
mixed|false — The value from the field, or false if nothing was found

Definition at line 33 of file MessageGroupReviewStore.php.

◆ getWorkflowState()

MediaWiki\Extension\Translate\MessageGroupProcessing\MessageGroupReviewStore::getWorkflowState ( string $groupId,
string $languageCode )

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

Parameters
string$groupId
string$languageCode
Returns
string|null State id or null.

Definition at line 144 of file MessageGroupReviewStore.php.

◆ getWorkflowStatesForGroup()

MediaWiki\Extension\Translate\MessageGroupProcessing\MessageGroupReviewStore::getWorkflowStatesForGroup ( string $groupId)

Definition at line 164 of file MessageGroupReviewStore.php.

◆ getWorkflowStatesForLanguage()

MediaWiki\Extension\Translate\MessageGroupProcessing\MessageGroupReviewStore::getWorkflowStatesForLanguage ( string $languageCode,
array $groupIds )

Definition at line 149 of file MessageGroupReviewStore.php.

◆ setGroupPriority()

MediaWiki\Extension\Translate\MessageGroupProcessing\MessageGroupReviewStore::setGroupPriority ( string $groupId,
?string $priority )

Store priority for message group.

Abusing this table that was intended to store message group states

Definition at line 92 of file MessageGroupReviewStore.php.


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