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

Api module for querying MessageGroups. More...

Inheritance diagram for MediaWiki\Extension\Translate\MessageGroupProcessing\QueryMessageGroupsActionApi:

Public Member Functions

 __construct (ApiQuery $query, string $moduleName, private readonly HookRunner $hookRunner, private readonly MessageGroupMetadata $messageGroupMetadata, private readonly MessageGroupSubscription $groupSubscription,)
 
 execute ()
 

Protected Member Functions

 formatGroup ( $mixed, array $props, array $subscriptions, int $depth=0)
 
 getAllowedParams ()
 
 getExamplesMessages ()
 

Detailed Description

Api module for querying MessageGroups.

Author
Niklas Laxström
Harry Burt

Definition at line 26 of file QueryMessageGroupsActionApi.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Extension\Translate\MessageGroupProcessing\QueryMessageGroupsActionApi::__construct ( ApiQuery $query,
string $moduleName,
private readonly HookRunner $hookRunner,
private readonly MessageGroupMetadata $messageGroupMetadata,
private readonly MessageGroupSubscription $groupSubscription )

Definition at line 28 of file QueryMessageGroupsActionApi.php.

Member Function Documentation

◆ execute()

MediaWiki\Extension\Translate\MessageGroupProcessing\QueryMessageGroupsActionApi::execute ( )

Definition at line 38 of file QueryMessageGroupsActionApi.php.

◆ formatGroup()

MediaWiki\Extension\Translate\MessageGroupProcessing\QueryMessageGroupsActionApi::formatGroup ( $mixed,
array $props,
array $subscriptions,
int $depth = 0 )
protected
Parameters
array | MessageGroup$mixed
array<string,int>$props List of props as the array keys
array<string,int>$subscriptions List of message group ids as the array keys
int$depth

Definition at line 147 of file QueryMessageGroupsActionApi.php.

◆ getAllowedParams()

MediaWiki\Extension\Translate\MessageGroupProcessing\QueryMessageGroupsActionApi::getAllowedParams ( )
protected

Definition at line 287 of file QueryMessageGroupsActionApi.php.

◆ getExamplesMessages()

MediaWiki\Extension\Translate\MessageGroupProcessing\QueryMessageGroupsActionApi::getExamplesMessages ( )
protected

Definition at line 352 of file QueryMessageGroupsActionApi.php.


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