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