Просмотр файла vendor/symfony/translation/MetadataAwareInterface.php

Размер файла: 1.51Kb
  1. <?php
  2.  
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  11.  
  12. namespace Symfony\Component\Translation;
  13.  
  14. /**
  15. * MetadataAwareInterface.
  16. *
  17. * @author Fabien Potencier <fabien@symfony.com>
  18. */
  19. interface MetadataAwareInterface
  20. {
  21. /**
  22. * Gets metadata for the given domain and key.
  23. *
  24. * Passing an empty domain will return an array with all metadata indexed by
  25. * domain and then by key. Passing an empty key will return an array with all
  26. * metadata for the given domain.
  27. *
  28. * @param string $key The key
  29. * @param string $domain The domain name
  30. *
  31. * @return mixed The value that was set or an array with the domains/keys or null
  32. */
  33. public function getMetadata($key = '', $domain = 'messages');
  34.  
  35. /**
  36. * Adds metadata to a message domain.
  37. *
  38. * @param string $key The key
  39. * @param mixed $value The value
  40. * @param string $domain The domain name
  41. */
  42. public function setMetadata($key, $value, $domain = 'messages');
  43.  
  44. /**
  45. * Deletes metadata for the given key and domain.
  46. *
  47. * Passing an empty domain will delete all metadata. Passing an empty key will
  48. * delete all metadata for the given domain.
  49. *
  50. * @param string $key The key
  51. * @param string $domain The domain name
  52. */
  53. public function deleteMetadata($key = '', $domain = 'messages');
  54. }