MetadataAwareInterface
in
MetadataAwareInterface.
Tags
Table of Contents
- deleteMetadata() : mixed
- Deletes metadata for the given key and domain.
- getMetadata() : mixed
- Gets metadata for the given domain and key.
- setMetadata() : mixed
- Adds metadata to a message domain.
Methods
deleteMetadata()
Deletes metadata for the given key and domain.
public
deleteMetadata([string $key = '' ][, string $domain = 'messages' ]) : mixed
Passing an empty domain will delete all metadata. Passing an empty key will delete all metadata for the given domain.
Parameters
- $key : string = ''
-
The key
- $domain : string = 'messages'
-
The domain name
Return values
mixed —getMetadata()
Gets metadata for the given domain and key.
public
getMetadata([string $key = '' ][, string $domain = 'messages' ]) : mixed
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
- $key : string = ''
-
The key
- $domain : string = 'messages'
-
The domain name
Return values
mixed —The value that was set or an array with the domains/keys or null
setMetadata()
Adds metadata to a message domain.
public
setMetadata(string $key, mixed $value[, string $domain = 'messages' ]) : mixed
Parameters
- $key : string
-
The key
- $value : mixed
-
The value
- $domain : string = 'messages'
-
The domain name