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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\helpers;
use Yii;
use yii\base\InvalidParamException;
use yii\web\Controller;
/**
* BaseUrl provides concrete implementation for [[Url]].
*
* Do not use BaseUrl. Use [[Url]] instead.
*
* @author Alexander Makarov <sam@rmcreative.ru>
* @since 2.0
*/
class BaseUrl
{
/**
* Returns URL for a route.
*
* @param array|string $route route as a string or route and parameters in form of
* `['route', 'param1' => 'value1', 'param2' => 'value2']`.
*
* If there is a controller running, relative routes are recognized:
*
* - If the route is an empty string, the current [[\yii\web\Controller::route|route]] will be used;
* - If the route contains no slashes at all, it is considered to be an action ID
* of the current controller and will be prepended with [[\yii\web\Controller::uniqueId]];
* - If the route has no leading slash, it is considered to be a route relative
* to the current module and will be prepended with the module's uniqueId.
*
* In case there is no controller, [[\yii\web\UrlManager::createUrl()]] will be used.
*
* @param boolean|string $scheme URI scheme to use:
*
* - `false`: relative URL. Default behavior.
* - `true`: absolute URL with the current scheme.
* - string: absolute URL with string value used as scheme.
*
* @return string the URL for the route
* @throws InvalidParamException if the parameter is invalid.
*/
public static function toRoute($route, $scheme = false)
{
$route = (array) $route;
if (Yii::$app->controller instanceof Controller) {
$route[0] = static::getNormalizedRoute($route[0]);
}
if ($scheme) {
if ($scheme === true) {
$scheme = null;
}
$url = Yii::$app->getUrlManager()->createAbsoluteUrl($route, $scheme);
} else {
$url = Yii::$app->getUrlManager()->createUrl($route);
}
return $url;
}
/**
* Normalizes route and makes it suitable for UrlManager. Absolute routes are staying as is
* while relative routes are converted to absolute ones.
*
* A relative route is a route without a leading slash, such as "view", "post/view".
*
* - If the route is an empty string, the current [[\yii\web\Controller::route|route]] will be used;
* - If the route contains no slashes at all, it is considered to be an action ID
* of the current controller and will be prepended with [[\yii\web\Controller::uniqueId]];
* - If the route has no leading slash, it is considered to be a route relative
* to the current module and will be prepended with the module's uniqueId.
*
* @param string $route the route. This can be either an absolute route or a relative route.
* @return string normalized route suitable for UrlManager
*/
private static function getNormalizedRoute($route)
{
if (strpos($route, '/') === false) {
// empty or an action ID
$route = $route === '' ? Yii::$app->controller->getRoute() : Yii::$app->controller->getUniqueId() . '/' . $route;
} elseif ($route[0] !== '/') {
// relative to module
$route = ltrim(Yii::$app->controller->module->getUniqueId() . '/' . $route, '/');
}
return $route;
}
/**
* Creates a URL specified by the input parameter.
*
* If the input parameter is
*
* - an array: the first array element is considered a route, while the rest of the name-value
* pairs are treated as the parameters to be used for URL creation using [[toRoute()]].
* For example: `['post/index', 'page' => 2]`, `['index']`.
* In case there is no controller, [[\yii\web\UrlManager::createUrl()]] will be used.
* - an empty string: the currently requested URL will be returned;
* - a non-empty string: it will first be processed by [[Yii::getAlias()]]. If the result
* is an absolute URL, it will be returned either without any change or, if scheme was specified, with scheme
* replaced; Otherwise, the result will be prefixed with [[\yii\web\Request::baseUrl]] and returned.
*
* @param array|string $url the parameter to be used to generate a valid URL
* @param boolean|string $scheme URI scheme to use:
*
* - `false`: relative URL. Default behavior.
* - `true`: absolute URL with the current scheme.
* - string: absolute URL with string value used as scheme.
*
* @return string the normalized URL
* @throws InvalidParamException if the parameter is invalid.
*/
public static function to($url = '', $scheme = false)
{
if (is_array($url)) {
return static::toRoute($url, $scheme);
} elseif ($url === '') {
if ($scheme) {
$url = Yii::$app->getRequest()->getAbsoluteUrl();
} else {
$url = Yii::$app->getRequest()->getUrl();
}
} else {
$url = Yii::getAlias($url);
if (strpos($url, '://') === false) {
if ($url === '' || ($url[0] !== '/' && $url[0] !== '#' && strncmp($url, './', 2))) {
$url = Yii::$app->getRequest()->getBaseUrl() . '/' . $url;
}
if ($scheme) {
$url = Yii::$app->getRequest()->getHostInfo() . $url;
}
}
}
if ($scheme && $scheme !== true) {
$pos = strpos($url, '://');
if ($pos !== false) {
$url = $scheme . substr($url, $pos);
}
}
return $url;
}
/**
* Remembers the specified URL so that it can be later fetched back.
*
* @param string $url URL to remember. Default is the currently requested URL.
* @param string $name Name to use to remember URL. Defaults to [[\yii\web\User::returnUrlParam]].
* @see previous()
*/
public static function remember($url = '', $name = null)
{
if ($url === '') {
$url = Yii::$app->getRequest()->getUrl();
}
if ($name === null) {
Yii::$app->getUser()->setReturnUrl($url);
} else {
Yii::$app->getSession()->set($name, $url);
}
}
/**
* Returns the URL previously [[remember()|remembered]].
*
* @param string $name Name used to remember URL. Defaults to [[\yii\web\User::returnUrlParam]].
* @return string URL, or null if no such URL was remembered before.
* @see remember()
*/
public static function previous($name = null)
{
if ($name === null) {
return Yii::$app->getUser()->getReturnUrl();
} else {
return Yii::$app->getSession()->get($name);
}
}
/**
* Returns the canonical URL of the currently requested page.
* The canonical URL is constructed using current controller's [[yii\web\Controller::route]] and
* [[yii\web\Controller::actionParams]]. You may use the following code in the layout view to add a link tag
* about canonical URL:
*
* ```php
* $this->registerLinkTag(['rel' => 'canonical', 'href' => Url::canonical()]);
* ```
*
* @return string the canonical URL of the currently requested page
*/
public static function canonical()
{
$params = Yii::$app->controller->actionParams;
$params[0] = Yii::$app->controller->getRoute();
return Yii::$app->getUrlManager()->createAbsoluteUrl($params);
}
/**
* Returns the home URL.
*
* @param boolean|string $scheme URI scheme to use:
*
* - `false`: relative URL. Default behavior.
* - `true`: absolute URL with the current scheme.
* - string: absolute URL with string value used as scheme.
*
* @return string home URL
*/
public static function home($scheme = false)
{
if ($scheme) {
$url = Yii::$app->getRequest()->getHostInfo() . Yii::$app->getHomeUrl();
if ($scheme !== true) {
$pos = strpos($url, '://');
$url = $scheme . substr($url, $pos);
}
} else {
$url = Yii::$app->getHomeUrl();
}
return $url;
}
}