| 148 |
lars |
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 |
* This interface is used to get, set, and delete metadata about the translation messages.
|
|
|
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 |
* @return mixed The value that was set or an array with the domains/keys or null
|
|
|
29 |
*/
|
|
|
30 |
public function getMetadata(string $key = '', string $domain = 'messages'): mixed;
|
|
|
31 |
|
|
|
32 |
/**
|
|
|
33 |
* Adds metadata to a message domain.
|
|
|
34 |
*/
|
|
|
35 |
public function setMetadata(string $key, mixed $value, string $domain = 'messages');
|
|
|
36 |
|
|
|
37 |
/**
|
|
|
38 |
* Deletes metadata for the given key and domain.
|
|
|
39 |
*
|
|
|
40 |
* Passing an empty domain will delete all metadata. Passing an empty key will
|
|
|
41 |
* delete all metadata for the given domain.
|
|
|
42 |
*/
|
|
|
43 |
public function deleteMetadata(string $key = '', string $domain = 'messages');
|
|
|
44 |
}
|