MetadataAwareInterface.php
| 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 | namespace IAWP_SCOPED\Symfony\Component\Translation; |
| 12 | |
| 13 | /** |
| 14 | * MetadataAwareInterface. |
| 15 | * |
| 16 | * @author Fabien Potencier <fabien@symfony.com> |
| 17 | */ |
| 18 | interface MetadataAwareInterface |
| 19 | { |
| 20 | /** |
| 21 | * Gets metadata for the given domain and key. |
| 22 | * |
| 23 | * Passing an empty domain will return an array with all metadata indexed by |
| 24 | * domain and then by key. Passing an empty key will return an array with all |
| 25 | * metadata for the given domain. |
| 26 | * |
| 27 | * @return mixed The value that was set or an array with the domains/keys or null |
| 28 | */ |
| 29 | public function getMetadata(string $key = '', string $domain = 'messages'); |
| 30 | /** |
| 31 | * Adds metadata to a message domain. |
| 32 | * |
| 33 | * @param mixed $value |
| 34 | */ |
| 35 | public function setMetadata(string $key, $value, string $domain = 'messages'); |
| 36 | /** |
| 37 | * Deletes metadata for the given key and domain. |
| 38 | * |
| 39 | * Passing an empty domain will delete all metadata. Passing an empty key will |
| 40 | * delete all metadata for the given domain. |
| 41 | */ |
| 42 | public function deleteMetadata(string $key = '', string $domain = 'messages'); |
| 43 | } |
| 44 |