Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

[Translation] tagged the guaranteed BC API

  • Loading branch information...
commit 7d6751bc1b94265dee3bafa72b384a21ef85d1c2 1 parent 4aac432
Fabien Potencier authored March 24, 2011
12  IdentityTranslator.php
@@ -15,6 +15,8 @@
15 15
  * IdentityTranslator does not translate anything.
16 16
  *
17 17
  * @author Fabien Potencier <fabien@symfony.com>
  18
+ *
  19
+ * @api
18 20
  */
19 21
 class IdentityTranslator implements TranslatorInterface
20 22
 {
@@ -24,6 +26,8 @@ class IdentityTranslator implements TranslatorInterface
24 26
      * Constructor.
25 27
      *
26 28
      * @param MessageSelector $selector The message selector for pluralization
  29
+     *
  30
+     * @api
27 31
      */
28 32
     public function __construct(MessageSelector $selector)
29 33
     {
@@ -32,6 +36,8 @@ public function __construct(MessageSelector $selector)
32 36
 
33 37
     /**
34 38
      * {@inheritdoc}
  39
+     *
  40
+     * @api
35 41
      */
36 42
     public function setLocale($locale)
37 43
     {
@@ -39,6 +45,8 @@ public function setLocale($locale)
39 45
 
40 46
     /**
41 47
      * {@inheritdoc}
  48
+     *
  49
+     * @api
42 50
      */
43 51
     public function getLocale()
44 52
     {
@@ -46,6 +54,8 @@ public function getLocale()
46 54
 
47 55
     /**
48 56
      * {@inheritdoc}
  57
+     *
  58
+     * @api
49 59
      */
50 60
     public function trans($id, array $parameters = array(), $domain = 'messages', $locale = null)
51 61
     {
@@ -54,6 +64,8 @@ public function trans($id, array $parameters = array(), $domain = 'messages', $l
54 64
 
55 65
     /**
56 66
      * {@inheritdoc}
  67
+     *
  68
+     * @api
57 69
      */
58 70
     public function transChoice($id, $number, array $parameters = array(), $domain = 'messages', $locale = null)
59 71
     {
4  Loader/ArrayLoader.php
@@ -17,11 +17,15 @@
17 17
  * ArrayLoader loads translations from a PHP array.
18 18
  *
19 19
  * @author Fabien Potencier <fabien@symfony.com>
  20
+ *
  21
+ * @api
20 22
  */
21 23
 class ArrayLoader implements LoaderInterface
22 24
 {
23 25
     /**
24 26
      * {@inheritdoc}
  27
+     *
  28
+     * @api
25 29
      */
26 30
     public function load($resource, $locale, $domain = 'messages')
27 31
     {
4  Loader/CsvFileLoader.php
@@ -17,11 +17,15 @@
17 17
  * CsvFileLoader loads translations from CSV files.
18 18
  *
19 19
  * @author Saša Stamenković <umpirsky@gmail.com>
  20
+ *
  21
+ * @api
20 22
  */
21 23
 class CsvFileLoader extends ArrayLoader implements LoaderInterface
22 24
 {
23 25
     /**
24 26
      * {@inheritdoc}
  27
+     *
  28
+     * @api
25 29
      */
26 30
     public function load($resource, $locale, $domain = 'messages')
27 31
     {
4  Loader/LoaderInterface.php
@@ -17,6 +17,8 @@
17 17
  * LoaderInterface is the interface implemented by all translation loaders.
18 18
  *
19 19
  * @author Fabien Potencier <fabien@symfony.com>
  20
+ *
  21
+ * @api
20 22
  */
21 23
 interface LoaderInterface
22 24
 {
@@ -28,6 +30,8 @@
28 30
      * @param  string $domain   The domain
29 31
      *
30 32
      * @return MessageCatalogue A MessageCatalogue instance
  33
+     *
  34
+     * @api
31 35
      */
32 36
     function load($resource, $locale, $domain = 'messages');
33 37
 }
4  Loader/PhpFileLoader.php
@@ -17,11 +17,15 @@
17 17
  * PhpFileLoader loads translations from PHP files returning an array of translations.
18 18
  *
19 19
  * @author Fabien Potencier <fabien@symfony.com>
  20
+ *
  21
+ * @api
20 22
  */
21 23
 class PhpFileLoader extends ArrayLoader implements LoaderInterface
22 24
 {
23 25
     /**
24 26
      * {@inheritdoc}
  27
+     *
  28
+     * @api
25 29
      */
26 30
     public function load($resource, $locale, $domain = 'messages')
27 31
     {
4  Loader/XliffFileLoader.php
@@ -18,11 +18,15 @@
18 18
  * XliffFileLoader loads translations from XLIFF files.
19 19
  *
20 20
  * @author Fabien Potencier <fabien@symfony.com>
  21
+ *
  22
+ * @api
21 23
  */
22 24
 class XliffFileLoader implements LoaderInterface
23 25
 {
24 26
     /**
25 27
      * {@inheritdoc}
  28
+     *
  29
+     * @api
26 30
      */
27 31
     public function load($resource, $locale, $domain = 'messages')
28 32
     {
4  Loader/YamlFileLoader.php
@@ -18,11 +18,15 @@
18 18
  * YamlFileLoader loads translations from Yaml files.
19 19
  *
20 20
  * @author Fabien Potencier <fabien@symfony.com>
  21
+ *
  22
+ * @api
21 23
  */
22 24
 class YamlFileLoader extends ArrayLoader implements LoaderInterface
23 25
 {
24 26
     /**
25 27
      * {@inheritdoc}
  28
+     *
  29
+     * @api
26 30
      */
27 31
     public function load($resource, $locale, $domain = 'messages')
28 32
     {
28  MessageCatalogue.php
@@ -17,6 +17,8 @@
17 17
  * MessageCatalogue.
18 18
  *
19 19
  * @author Fabien Potencier <fabien@symfony.com>
  20
+ *
  21
+ * @api
20 22
  */
21 23
 class MessageCatalogue implements MessageCatalogueInterface
22 24
 {
@@ -29,6 +31,8 @@ class MessageCatalogue implements MessageCatalogueInterface
29 31
      *
30 32
      * @param string $locale   The locale
31 33
      * @param array  $messages An array of messages classified by domain
  34
+     *
  35
+     * @api
32 36
      */
33 37
     public function __construct($locale, array $messages = array())
34 38
     {
@@ -39,6 +43,8 @@ public function __construct($locale, array $messages = array())
39 43
 
40 44
     /**
41 45
      * {@inheritdoc}
  46
+     *
  47
+     * @api
42 48
      */
43 49
     public function getLocale()
44 50
     {
@@ -47,6 +53,8 @@ public function getLocale()
47 53
 
48 54
     /**
49 55
      * {@inheritdoc}
  56
+     *
  57
+     * @api
50 58
      */
51 59
     public function getDomains()
52 60
     {
@@ -55,6 +63,8 @@ public function getDomains()
55 63
 
56 64
     /**
57 65
      * {@inheritdoc}
  66
+     *
  67
+     * @api
58 68
      */
59 69
     public function all($domain = null)
60 70
     {
@@ -67,6 +77,8 @@ public function all($domain = null)
67 77
 
68 78
     /**
69 79
      * {@inheritdoc}
  80
+     *
  81
+     * @api
70 82
      */
71 83
     public function set($id, $translation, $domain = 'messages')
72 84
     {
@@ -75,6 +87,8 @@ public function set($id, $translation, $domain = 'messages')
75 87
 
76 88
     /**
77 89
      * {@inheritdoc}
  90
+     *
  91
+     * @api
78 92
      */
79 93
     public function has($id, $domain = 'messages')
80 94
     {
@@ -83,6 +97,8 @@ public function has($id, $domain = 'messages')
83 97
 
84 98
     /**
85 99
      * {@inheritdoc}
  100
+     *
  101
+     * @api
86 102
      */
87 103
     public function get($id, $domain = 'messages')
88 104
     {
@@ -91,6 +107,8 @@ public function get($id, $domain = 'messages')
91 107
 
92 108
     /**
93 109
      * {@inheritdoc}
  110
+     *
  111
+     * @api
94 112
      */
95 113
     public function replace($messages, $domain = 'messages')
96 114
     {
@@ -101,6 +119,8 @@ public function replace($messages, $domain = 'messages')
101 119
 
102 120
     /**
103 121
      * {@inheritdoc}
  122
+     *
  123
+     * @api
104 124
      */
105 125
     public function add($messages, $domain = 'messages')
106 126
     {
@@ -113,6 +133,8 @@ public function add($messages, $domain = 'messages')
113 133
 
114 134
     /**
115 135
      * {@inheritdoc}
  136
+     *
  137
+     * @api
116 138
      */
117 139
     public function addCatalogue(MessageCatalogueInterface $catalogue)
118 140
     {
@@ -131,6 +153,8 @@ public function addCatalogue(MessageCatalogueInterface $catalogue)
131 153
 
132 154
     /**
133 155
      * {@inheritdoc}
  156
+     *
  157
+     * @api
134 158
      */
135 159
     public function addFallbackCatalogue(MessageCatalogueInterface $catalogue)
136 160
     {
@@ -149,6 +173,8 @@ public function addFallbackCatalogue(MessageCatalogueInterface $catalogue)
149 173
 
150 174
     /**
151 175
      * {@inheritdoc}
  176
+     *
  177
+     * @api
152 178
      */
153 179
     public function getResources()
154 180
     {
@@ -157,6 +183,8 @@ public function getResources()
157 183
 
158 184
     /**
159 185
      * {@inheritdoc}
  186
+     *
  187
+     * @api
160 188
      */
161 189
     public function addResource(ResourceInterface $resource)
162 190
     {
26  MessageCatalogueInterface.php
@@ -17,6 +17,8 @@
17 17
  * MessageCatalogueInterface.
18 18
  *
19 19
  * @author Fabien Potencier <fabien@symfony.com>
  20
+ *
  21
+ * @api
20 22
  */
21 23
 interface MessageCatalogueInterface
22 24
 {
@@ -24,6 +26,8 @@
24 26
      * Gets the catalogue locale.
25 27
      *
26 28
      * @return string The locale
  29
+     *
  30
+     * @api
27 31
      */
28 32
     function getLocale();
29 33
 
@@ -31,6 +35,8 @@ function getLocale();
31 35
      * Gets the domains.
32 36
      *
33 37
      * @return array An array of domains
  38
+     *
  39
+     * @api
34 40
      */
35 41
     function getDomains();
36 42
 
@@ -42,6 +48,8 @@ function getDomains();
42 48
      * @param string $domain The domain name
43 49
      *
44 50
      * @return array An array of messages
  51
+     *
  52
+     * @api
45 53
      */
46 54
     function all($domain = null);
47 55
 
@@ -51,6 +59,8 @@ function all($domain = null);
51 59
      * @param string $id          The message id
52 60
      * @param string $translation The messages translation
53 61
      * @param string $domain      The domain name
  62
+     *
  63
+     * @api
54 64
      */
55 65
     function set($id, $translation, $domain = 'messages');
56 66
 
@@ -61,6 +71,8 @@ function set($id, $translation, $domain = 'messages');
61 71
      * @param string $domain The domain name
62 72
      *
63 73
      * @return Boolean true if the message has a translation, false otherwise
  74
+     *
  75
+     * @api
64 76
      */
65 77
     function has($id, $domain = 'messages');
66 78
 
@@ -71,6 +83,8 @@ function has($id, $domain = 'messages');
71 83
      * @param string $domain The domain name
72 84
      *
73 85
      * @return string The message translation
  86
+     *
  87
+     * @api
74 88
      */
75 89
     function get($id, $domain = 'messages');
76 90
 
@@ -79,6 +93,8 @@ function get($id, $domain = 'messages');
79 93
      *
80 94
      * @param string $messages An array of translations
81 95
      * @param string $domain   The domain name
  96
+     *
  97
+     * @api
82 98
      */
83 99
     function replace($messages, $domain = 'messages');
84 100
 
@@ -87,6 +103,8 @@ function replace($messages, $domain = 'messages');
87 103
      *
88 104
      * @param string $messages An array of translations
89 105
      * @param string $domain   The domain name
  106
+     *
  107
+     * @api
90 108
      */
91 109
     function add($messages, $domain = 'messages');
92 110
 
@@ -96,6 +114,8 @@ function add($messages, $domain = 'messages');
96 114
      * The two catalogues must have the same locale.
97 115
      *
98 116
      * @param MessageCatalogueInterface $catalogue A MessageCatalogueInterface instance
  117
+     *
  118
+     * @api
99 119
      */
100 120
     function addCatalogue(MessageCatalogueInterface $catalogue);
101 121
 
@@ -106,6 +126,8 @@ function addCatalogue(MessageCatalogueInterface $catalogue);
106 126
      * This is used to provide default translations when they do not exist for the current locale.
107 127
      *
108 128
      * @param MessageCatalogueInterface $catalogue A MessageCatalogueInterface instance
  129
+     *
  130
+     * @api
109 131
      */
110 132
     function addFallbackCatalogue(MessageCatalogueInterface $catalogue);
111 133
 
@@ -113,6 +135,8 @@ function addFallbackCatalogue(MessageCatalogueInterface $catalogue);
113 135
      * Returns an array of resources loaded to build this collection.
114 136
      *
115 137
      * @return ResourceInterface[] An array of resources
  138
+     *
  139
+     * @api
116 140
      */
117 141
     function getResources();
118 142
 
@@ -120,6 +144,8 @@ function getResources();
120 144
      * Adds a resource for this collection.
121 145
      *
122 146
      * @param ResourceInterface $resource A resource instance
  147
+     *
  148
+     * @api
123 149
      */
124 150
     function addResource(ResourceInterface $resource);
125 151
 }
4  MessageSelector.php
@@ -15,6 +15,8 @@
15 15
  * MessageSelector.
16 16
  *
17 17
  * @author Fabien Potencier <fabien@symfony.com>
  18
+ *
  19
+ * @api
18 20
  */
19 21
 class MessageSelector
20 22
 {
@@ -41,6 +43,8 @@ class MessageSelector
41 43
      * @param  integer $number The number of items represented for the message
42 44
      * @param  string $locale The locale to use for choosing
43 45
      * @return string
  46
+     *
  47
+     * @api
44 48
      */
45 49
     public function choose($message, $number, $locale)
46 50
     {
18  Translator.php
@@ -17,6 +17,8 @@
17 17
  * Translator.
18 18
  *
19 19
  * @author Fabien Potencier <fabien@symfony.com>
  20
+ *
  21
+ * @api
20 22
  */
21 23
 class Translator implements TranslatorInterface
22 24
 {
@@ -32,6 +34,8 @@ class Translator implements TranslatorInterface
32 34
      *
33 35
      * @param string          $locale   The locale
34 36
      * @param MessageSelector $selector The message selector for pluralization
  37
+     *
  38
+     * @api
35 39
      */
36 40
     public function __construct($locale = null, MessageSelector $selector)
37 41
     {
@@ -47,6 +51,8 @@ public function __construct($locale = null, MessageSelector $selector)
47 51
      *
48 52
      * @param string          $format The name of the loader (@see addResource())
49 53
      * @param LoaderInterface $loader A LoaderInterface instance
  54
+     *
  55
+     * @api
50 56
      */
51 57
     public function addLoader($format, LoaderInterface $loader)
52 58
     {
@@ -60,6 +66,8 @@ public function addLoader($format, LoaderInterface $loader)
60 66
      * @param mixed  $resource The resource name
61 67
      * @param string $locale   The locale
62 68
      * @param string $domain   The domain
  69
+     *
  70
+     * @api
63 71
      */
64 72
     public function addResource($format, $resource, $locale, $domain = 'messages')
65 73
     {
@@ -72,6 +80,8 @@ public function addResource($format, $resource, $locale, $domain = 'messages')
72 80
 
73 81
     /**
74 82
      * {@inheritdoc}
  83
+     *
  84
+     * @api
75 85
      */
76 86
     public function setLocale($locale)
77 87
     {
@@ -80,6 +90,8 @@ public function setLocale($locale)
80 90
 
81 91
     /**
82 92
      * {@inheritdoc}
  93
+     *
  94
+     * @api
83 95
      */
84 96
     public function getLocale()
85 97
     {
@@ -90,6 +102,8 @@ public function getLocale()
90 102
      * Sets the fallback locale.
91 103
      *
92 104
      * @param string $locale The fallback locale
  105
+     *
  106
+     * @api
93 107
      */
94 108
     public function setFallbackLocale($locale)
95 109
     {
@@ -101,6 +115,8 @@ public function setFallbackLocale($locale)
101 115
 
102 116
     /**
103 117
      * {@inheritdoc}
  118
+     *
  119
+     * @api
104 120
      */
105 121
     public function trans($id, array $parameters = array(), $domain = 'messages', $locale = null)
106 122
     {
@@ -117,6 +133,8 @@ public function trans($id, array $parameters = array(), $domain = 'messages', $l
117 133
 
118 134
     /**
119 135
      * {@inheritdoc}
  136
+     *
  137
+     * @api
120 138
      */
121 139
     public function transChoice($id, $number, array $parameters = array(), $domain = 'messages', $locale = null)
122 140
     {
10  TranslatorInterface.php
@@ -15,6 +15,8 @@
15 15
  * TranslatorInterface.
16 16
  *
17 17
  * @author Fabien Potencier <fabien@symfony.com>
  18
+ *
  19
+ * @api
18 20
  */
19 21
 interface TranslatorInterface
20 22
 {
@@ -27,6 +29,8 @@
27 29
      * @param string $locale     The locale
28 30
      *
29 31
      * @return string The translated string
  32
+     *
  33
+     * @api
30 34
      */
31 35
     function trans($id, array $parameters = array(), $domain = null, $locale = null);
32 36
 
@@ -40,6 +44,8 @@ function trans($id, array $parameters = array(), $domain = null, $locale = null)
40 44
      * @param string  $locale     The locale
41 45
      *
42 46
      * @return string The translated string
  47
+     *
  48
+     * @api
43 49
      */
44 50
     function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null);
45 51
 
@@ -47,6 +53,8 @@ function transChoice($id, $number, array $parameters = array(), $domain = null,
47 53
      * Sets the current locale.
48 54
      *
49 55
      * @param string $locale The locale
  56
+     *
  57
+     * @api
50 58
      */
51 59
     function setLocale($locale);
52 60
 
@@ -54,6 +62,8 @@ function setLocale($locale);
54 62
      * Returns the current locale.
55 63
      *
56 64
      * @return string The locale
  65
+     *
  66
+     * @api
57 67
      */
58 68
     function getLocale();
59 69
 }

0 notes on commit 7d6751b

Please sign in to comment.
Something went wrong with that request. Please try again.