|
1
|
|
|
<?php |
|
2
|
|
|
/* |
|
3
|
|
|
* Copyright (c) 2012-2015 Marc Teyssier |
|
4
|
|
|
* |
|
5
|
|
|
* See the file LICENSE.txt for copying permission. |
|
6
|
|
|
*/ |
|
7
|
|
|
namespace Mouf\Utils\I18n\Fine\Common\Ui; |
|
8
|
|
|
|
|
9
|
|
|
/** |
|
10
|
|
|
* Used to interface of translation message |
|
11
|
|
|
* This interface must be implement to use the human interface in Mouf |
|
12
|
|
|
* |
|
13
|
|
|
* @author Marc Teyssier |
|
14
|
|
|
* |
|
15
|
|
|
*/ |
|
16
|
|
|
interface EditTranslationInterface |
|
17
|
|
|
{ |
|
18
|
|
|
|
|
19
|
|
|
/** |
|
20
|
|
|
* Return the list of all translation. The table has 2 dimensions. |
|
21
|
|
|
* The first is the language. |
|
22
|
|
|
* The second is the key/value of translation |
|
23
|
|
|
* |
|
24
|
|
|
* @return array<string, array<string, string>> Translations |
|
|
|
|
|
|
25
|
|
|
*/ |
|
26
|
|
|
public function getAllTranslationByLanguage(); |
|
27
|
|
|
|
|
28
|
|
|
/** |
|
29
|
|
|
* Return a list of all message for a language. |
|
30
|
|
|
* |
|
31
|
|
|
* @param string $language Language |
|
32
|
|
|
* @return array<string, string> List with key value of translation |
|
|
|
|
|
|
33
|
|
|
*/ |
|
34
|
|
|
public function getTranslationsForLanguage($language); |
|
35
|
|
|
|
|
36
|
|
|
/** |
|
37
|
|
|
* Return a list of all message for a language. |
|
38
|
|
|
* |
|
39
|
|
|
* @param string $key Fine key |
|
40
|
|
|
* @return array<string, string> List with key value of translation |
|
|
|
|
|
|
41
|
|
|
*/ |
|
42
|
|
|
public function getTranslationsForKey($key); |
|
43
|
|
|
|
|
44
|
|
|
/** |
|
45
|
|
|
* Delete a translation for a language. If the language is not set or null, this function deletes the translation for all language. |
|
46
|
|
|
* |
|
47
|
|
|
* @param string $key Key to remove |
|
48
|
|
|
* @param string|null $language Language to remove key or null for all |
|
49
|
|
|
*/ |
|
50
|
|
|
public function deleteTranslation($key, $language = null); |
|
51
|
|
|
|
|
52
|
|
|
/** |
|
53
|
|
|
* Add or change a translation |
|
54
|
|
|
* |
|
55
|
|
|
* @param string $key Key of translation |
|
56
|
|
|
* @param string $value Message of translation |
|
57
|
|
|
* @param string $language Language to add translation |
|
58
|
|
|
*/ |
|
59
|
|
|
public function setTranslation($key, $value, $language); |
|
60
|
|
|
|
|
61
|
|
|
/** |
|
62
|
|
|
* Add or change many translations in one time, for a language |
|
63
|
|
|
* The table index is the key that you want change |
|
64
|
|
|
* |
|
65
|
|
|
* @param array<string, string> $messages List with key value of translation |
|
66
|
|
|
* @param string $language Language to add translation |
|
67
|
|
|
*/ |
|
68
|
|
|
public function setTranslationsForLanguage(array $messages, $language); |
|
69
|
|
|
|
|
70
|
|
|
/** |
|
71
|
|
|
* Add or change many translations in one time, for a key |
|
72
|
|
|
* The table index is the language that you want change |
|
73
|
|
|
* |
|
74
|
|
|
* @param array<string, string> $messages List with key language of translation |
|
75
|
|
|
* @param string $key Key to add translation |
|
76
|
|
|
*/ |
|
77
|
|
|
public function setTranslationsForKey(array $messages, $key); |
|
78
|
|
|
|
|
79
|
|
|
/** |
|
80
|
|
|
* Liste of all language supported |
|
81
|
|
|
* |
|
82
|
|
|
* @return array<string> |
|
83
|
|
|
*/ |
|
84
|
|
|
public function getLanguageList(); |
|
85
|
|
|
|
|
86
|
|
|
/** |
|
87
|
|
|
* Return an array with all the key create without language checking |
|
88
|
|
|
* |
|
89
|
|
|
* @return array<string> All key |
|
90
|
|
|
*/ |
|
91
|
|
|
public function getAllKey(); |
|
92
|
|
|
} |
|
93
|
|
|
|
thecodingmachine /
utils.i18n.fine.common
Loading history...
This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.