TranslatorLocator.php
3.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
<?php
/**
*
* This file is part of the Aura Project for PHP.
*
* @package Aura.Intl
*
* @license http://opensource.org/licenses/bsd-license.php BSD
*
*/
namespace Aura\Intl;
/**
*
* A ServiceLocator implementation for loading and retaining translator objects.
*
* @package Aura.Intl
*
*/
class TranslatorLocator
{
/**
*
* A registry to retain translator objects.
*
* @var array
*
*/
protected $registry;
/**
*
* The current locale code.
*
* @var string
*
*/
protected $locale;
/**
*
* A translator factory.
*
* @var TranslatorFactory
*
*
*/
protected $factory;
/**
*
* A package locator.
*
* @var PackageLocator
*
*/
protected $packages;
/**
*
* A formatter locator.
*
* @var FormatterInterface
*
*/
protected $formatters;
/**
*
* Constructor.
*
* @param PackageLocator $packages The package locator.
*
* @param FormatterLocator $formatters The formatter locator.
*
* @param TranslatorFactory $factory A translator factory to
* create translator objects for the locale and package.
*
* @param string $locale The default locale code to use.
*
*/
public function __construct(
PackageLocator $packages,
FormatterLocator $formatters,
TranslatorFactory $factory,
$locale
) {
$this->packages = $packages;
$this->factory = $factory;
$this->formatters = $formatters;
$this->setLocale($locale);
}
/**
*
* Sets the default locale code.
*
* @param string $locale The new locale code.
*
* @return void
*
*/
public function setLocale($locale)
{
$this->locale = $locale;
}
/**
*
* Returns the default locale code.
*
* @return string
*
*/
public function getLocale()
{
return $this->locale;
}
/**
*
* The TranslatorFactory object
*
* @return TranslatorFactory
*/
public function getFactory()
{
return $this->factory;
}
/**
*
* An object of type PackagesInterface
*
* @return PackagesInterface
*
*/
public function getPackages()
{
return $this->packages;
}
/**
*
* object of type FormatterLocator
*
* @return FormatterLocator
*
*/
public function getFormatters()
{
return $this->formatters;
}
/**
*
* Gets a translator from the registry by package for a locale.
*
* @param string $name The translator package to retrieve.
*
* @param string $locale The locale to use; if empty, uses the default
* locale.
*
* @return TranslatorInterface A translator object.
*
*/
public function get($name, $locale = null)
{
if (! $name) {
return null;
}
if (! $locale) {
$locale = $this->getLocale();
}
if (! isset($this->registry[$name][$locale])) {
// get the package descriptor
$package = $this->packages->get($name, $locale);
// build a translator; note the recursive nature of the
// 'fallback' param at the very end.
$translator = $this->factory->newInstance(
$locale,
$package->getMessages(),
$this->formatters->get($package->getFormatter()),
$this->get($package->getFallback(), $locale)
);
// retain in the registry
$this->registry[$name][$locale] = $translator;
}
return $this->registry[$name][$locale];
}
}