MessageGroupLoader Class Reference

An abstract class to be implemented by group loaders / stores. More...

Inheritance diagram for MessageGroupLoader:

Public Member Functions
	getGroups ()
	Fetches and returns an array of MessageGroups.
	isExpired (DependencyWrapper $wrapper)
	Determines if dependencies have expired.

Detailed Description

An abstract class to be implemented by group loaders / stores.

Since

2019.05

Definition at line 14 of file MessageGroupLoader.php.

Member Function Documentation

getGroups()

MessageGroupLoader::getGroups ( )

abstract

Fetches and returns an array of MessageGroups.

Returns

MessageGroup[] Array of message groups with group id as the key

Note

Do not return an indexed based array as that would cause MessageGroups to be overwritten.

Reimplemented in AggregateMessageGroupLoader, FileBasedMessageGroupLoader, WorkflowStatesMessageGroupLoader, and MediaWiki\Extension\Translate\MessageGroupProcessing\CachedMessageGroupFactoryLoader.

isExpired()

MessageGroupLoader::isExpired

(

DependencyWrapper

$wrapper

)

Determines if dependencies have expired.

Called if data in cache is stored as a dependency wrapper.

Parameters

DependencyWrapper

$wrapper

Returns

bool true if expired, false otherwise.

Definition at line 30 of file MessageGroupLoader.php.

---

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

• messagegroups/loaders/MessageGroupLoader.php