You are here

interface MetadataAwareInterface in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 vendor/symfony/translation/MetadataAwareInterface.php \Symfony\Component\Translation\MetadataAwareInterface

MetadataAwareInterface.

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

Expanded class hierarchy of MetadataAwareInterface

All classes that implement MetadataAwareInterface

File

vendor/symfony/translation/MetadataAwareInterface.php, line 19

Namespace

Symfony\Component\Translation
View source
interface MetadataAwareInterface {

  /**
   * 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.
   *
   * @param string $key    The key
   * @param string $domain The domain name
   *
   * @return mixed The value that was set or an array with the domains/keys or null
   */
  public function getMetadata($key = '', $domain = 'messages');

  /**
   * Adds metadata to a message domain.
   *
   * @param string $key    The key
   * @param mixed  $value  The value
   * @param string $domain The domain name
   */
  public function setMetadata($key, $value, $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.
   *
   * @param string $key    The key
   * @param string $domain The domain name
   */
  public function deleteMetadata($key = '', $domain = 'messages');

}

Members

Namesort descending Modifiers Type Description Overrides
MetadataAwareInterface::deleteMetadata public function Deletes metadata for the given key and domain. 1
MetadataAwareInterface::getMetadata public function Gets metadata for the given domain and key. 1
MetadataAwareInterface::setMetadata public function Adds metadata to a message domain. 1