This repository has been archived by the owner on Jan 8, 2020. It is now read-only.
/
TranslatorAwareTreeRouteStack.php
176 lines (155 loc) · 4.74 KB
/
TranslatorAwareTreeRouteStack.php
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
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Mvc\Router\Http;
use Zend\I18n\Translator\TranslatorInterface as Translator;
use Zend\I18n\Translator\TranslatorAwareInterface;
use Zend\Stdlib\RequestInterface as Request;
/**
* Translator aware tree route stack.
*/
class TranslatorAwareTreeRouteStack extends TreeRouteStack implements TranslatorAwareInterface
{
/**
* Translator used for translatable segments.
*
* @var Translator
*/
protected $translator;
/**
* Whether the translator is enabled.
*
* @var bool
*/
protected $translatorEnabled = true;
/**
* Translator text domain to use.
*
* @var string
*/
protected $translatorTextDomain = 'default';
/**
* match(): defined by \Zend\Mvc\Router\RouteInterface
*
* @see \Zend\Mvc\Router\RouteInterface::match()
* @param Request $request
* @param integer|null $pathOffset
* @param array $options
* @return RouteMatch|null
*/
public function match(Request $request, $pathOffset = null, array $options = array())
{
if ($this->hasTranslator() && $this->isTranslatorEnabled() && !isset($options['translator'])) {
$options['translator'] = $this->getTranslator();
}
if (!isset($options['text_domain'])) {
$options['text_domain'] = $this->getTranslatorTextDomain();
}
return parent::match($request, $pathOffset, $options);
}
/**
* assemble(): defined by \Zend\Mvc\Router\RouteInterface interface.
*
* @see \Zend\Mvc\Router\RouteInterface::assemble()
* @param array $params
* @param array $options
* @return mixed
* @throws Exception\InvalidArgumentException
* @throws Exception\RuntimeException
*/
public function assemble(array $params = array(), array $options = array())
{
if ($this->hasTranslator() && $this->isTranslatorEnabled() && !isset($options['translator'])) {
$options['translator'] = $this->getTranslator();
}
if (!isset($options['text_domain'])) {
$options['text_domain'] = $this->getTranslatorTextDomain();
}
return parent::assemble($params, $options);
}
/**
* setTranslator(): defined by TranslatorAwareInterface.
*
* @see TranslatorAwareInterface::setTranslator()
* @param Translator $translator
* @param string $textDomain
* @return TreeRouteStack
*/
public function setTranslator(Translator $translator = null, $textDomain = null)
{
$this->translator = $translator;
if ($textDomain !== null) {
$this->setTranslatorTextDomain($textDomain);
}
return $this;
}
/**
* getTranslator(): defined by TranslatorAwareInterface.
*
* @see TranslatorAwareInterface::getTranslator()
* @return Translator
*/
public function getTranslator()
{
return $this->translator;
}
/**
* hasTranslator(): defined by TranslatorAwareInterface.
*
* @see TranslatorAwareInterface::hasTranslator()
* @return bool
*/
public function hasTranslator()
{
return $this->translator !== null;
}
/**
* setTranslatorEnabled(): defined by TranslatorAwareInterface.
*
* @see TranslatorAwareInterface::setTranslatorEnabled()
* @param bool $enabled
* @return TreeRouteStack
*/
public function setTranslatorEnabled($enabled = true)
{
$this->translatorEnabled = $enabled;
return $this;
}
/**
* isTranslatorEnabled(): defined by TranslatorAwareInterface.
*
* @see TranslatorAwareInterface::isTranslatorEnabled()
* @return bool
*/
public function isTranslatorEnabled()
{
return $this->translatorEnabled;
}
/**
* setTranslatorTextDomain(): defined by TranslatorAwareInterface.
*
* @see TranslatorAwareInterface::setTranslatorTextDomain()
* @param string $textDomain
* @return self
*/
public function setTranslatorTextDomain($textDomain = 'default')
{
$this->translatorTextDomain = $textDomain;
return $this;
}
/**
* getTranslatorTextDomain(): defined by TranslatorAwareInterface.
*
* @see TranslatorAwareInterface::getTranslatorTextDomain()
* @return string
*/
public function getTranslatorTextDomain()
{
return $this->translatorTextDomain;
}
}