interface CatalogueMetadataAwareInterface

This interface is used to get, set, and delete metadata about the Catalogue.

Methods

mixed
getCatalogueMetadata(string$key ='',string$domain ='messages')

Gets catalogue metadata for the given domain and key.

void
setCatalogueMetadata(string$key,mixed$value,string$domain ='messages')

Adds catalogue metadata to a message domain.

void
deleteCatalogueMetadata(string$key ='',string$domain ='messages')

Deletes catalogue metadata for the given key and domain.

Details

mixed getCatalogueMetadata(string$key ='',string$domain ='messages')

Gets catalogue metadata for the given domain and key.

Passing an empty domain will return an array with all catalogue metadata indexed by domain and then by key. Passing an empty key will return an array with all catalogue metadata for the given domain.

Parameters

string $key
string $domain

Return Value

mixed The value that was set or an array with the domains/keys or null

void setCatalogueMetadata(string$key,mixed$value,string$domain ='messages')

Adds catalogue metadata to a message domain.

Parameters

string $key
mixed $value
string $domain

Return Value

void

void deleteCatalogueMetadata(string$key ='',string$domain ='messages')

Deletes catalogue metadata for the given key and domain.

Passing an empty domain will delete all catalogue metadata. Passing an empty key will delete all metadata for the given domain.

Parameters

string $key
string $domain

Return Value

void