interface MetadataAwareInterface

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

Methods

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

Gets metadata for the given domain and key.

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

Adds metadata to a message domain.

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

Deletes metadata for the given key and domain.

Details

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

Gets metadata for the given domain and key.

Passing an empty domain will return an array with all metadata indexed by domain and then by key. Passing an empty key will return an array with all 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 setMetadata(string$key,mixed$value,string$domain ='messages')

Adds metadata to a message domain.

Parameters

string $key
mixed $value
string $domain

Return Value

void

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

Deletes metadata for the given key and domain.

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

Parameters

string $key
string $domain

Return Value

void