Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 55 lines (49 sloc) 1.551 kB
21eb295 @fabpot [Translation] created a new interface to avoid breaking BC
fabpot authored
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 /**
f10ed77 @Tobion [Translator] fix metadata
Tobion authored
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.
21eb295 @fabpot [Translation] created a new interface to avoid breaking BC
fabpot authored
27 *
f10ed77 @Tobion [Translator] fix metadata
Tobion authored
28 * @param string $key The key
4f3d4a1 @romainneutron Fix doc blocks
romainneutron authored
29 * @param string $domain The domain name
f10ed77 @Tobion [Translator] fix metadata
Tobion authored
30 *
31 * @return mixed The value that was set or an array with the domains/keys or null
21eb295 @fabpot [Translation] created a new interface to avoid breaking BC
fabpot authored
32 */
80dd709 @fabpot [Translation] changed the MetadataAwareInterface method signatures
fabpot authored
33 public function getMetadata($key = '', $domain = 'messages');
21eb295 @fabpot [Translation] created a new interface to avoid breaking BC
fabpot authored
34
35 /**
f10ed77 @Tobion [Translator] fix metadata
Tobion authored
36 * Adds metadata to a message domain.
21eb295 @fabpot [Translation] created a new interface to avoid breaking BC
fabpot authored
37 *
f10ed77 @Tobion [Translator] fix metadata
Tobion authored
38 * @param string $key The key
39 * @param mixed $value The value
40 * @param string $domain The domain name
21eb295 @fabpot [Translation] created a new interface to avoid breaking BC
fabpot authored
41 */
42 public function setMetadata($key, $value, $domain = 'messages');
43
44 /**
f10ed77 @Tobion [Translator] fix metadata
Tobion authored
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.
21eb295 @fabpot [Translation] created a new interface to avoid breaking BC
fabpot authored
49 *
f10ed77 @Tobion [Translator] fix metadata
Tobion authored
50 * @param string $key The key
4f3d4a1 @romainneutron Fix doc blocks
romainneutron authored
51 * @param string $domain The domain name
21eb295 @fabpot [Translation] created a new interface to avoid breaking BC
fabpot authored
52 */
80dd709 @fabpot [Translation] changed the MetadataAwareInterface method signatures
fabpot authored
53 public function deleteMetadata($key = '', $domain = 'messages');
21eb295 @fabpot [Translation] created a new interface to avoid breaking BC
fabpot authored
54 }
Something went wrong with that request. Please try again.