BaseUrl.php 12.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\helpers;

use Yii;
Qiang Xue committed
11
use yii\base\InvalidParamException;
12 13 14 15 16 17 18 19 20 21 22

/**
 * BaseUrl provides concrete implementation for [[Url]].
 *
 * Do not use BaseUrl. Use [[Url]] instead.
 *
 * @author Alexander Makarov <sam@rmcreative.ru>
 * @since 2.0
 */
class BaseUrl
{
23
    /**
24
     * Creates a URL for the given route.
25
     *
26
     * This method will use [[\yii\web\UrlManager]] to create a URL.
27
     *
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
     * You may specify the route as a string, e.g., `site/index`. You may also use an array
     * if you want to specify additional query parameters for the URL being created. The
     * array format must be:
     *
     * ```php
     * // generates: /index.php?r=site/index&param1=value1&param2=value2
     * ['site/index', 'param1' => 'value1', 'param2' => 'value2']
     * ```
     *
     * If you want to create a URL with an anchor, you can use the array format with a `#` parameter.
     * For example,
     *
     * ```php
     * // generates: /index.php?r=site/index&param1=value1#name
     * ['site/index', 'param1' => 'value1', '#' => 'name']
     * ```
     *
     * A route may be either absolute or relative. An absolute route has a leading slash (e.g. `/site/index`),
     * while a relative route has none (e.g. `site/index` or `index`). A relative route will be converted
     * into an absolute one by the following rules:
48 49
     *
     * - If the route is an empty string, the current [[\yii\web\Controller::route|route]] will be used;
50
     * - If the route contains no slashes at all (e.g. `index`), it is considered to be an action ID
51
     *   of the current controller and will be prepended with [[\yii\web\Controller::uniqueId]];
52 53 54 55 56 57 58 59 60 61 62
     * - If the route has no leading slash (e.g. `site/index`), it is considered to be a route relative
     *   to the current module and will be prepended with the module's [[\yii\base\Module::uniqueId|uniqueId]].
     *
     * Below are some examples of using this method:
     *
     * ```php
     * // /index?r=site/index
     * echo Url::toRoute('site/index');
     *
     * // /index?r=site/index&src=ref1#name
     * echo Url::toRoute(['site/index', 'src' => 'ref1', '#' => 'name']);
63
     *
64 65 66 67 68 69
     * // http://www.example.com/index.php?r=site/index
     * echo Url::toRoute('site/index', true);
     *
     * // https://www.example.com/index.php?r=site/index
     * echo Url::toRoute('site/index', 'https');
     * ```
70
     *
71 72 73
     * @param string|array $route use a string to represent a route (e.g. `index`, `site/index`),
     * or an array to represent a route with query parameters (e.g. `['site/index', 'param1' => 'value1']`).
     * @param boolean|string $scheme the URI scheme to use in the generated URL:
74
     *
75 76 77
     * - `false` (default): generating a relative URL.
     * - `true`: generating an absolute URL whose scheme is the same as the current request.
     * - string: generating an absolute URL with the specified scheme (either `http` or `https`).
78
     *
79 80
     * @return string the generated URL
     * @throws InvalidParamException a relative route is given while there is no active controller
81 82 83
     */
    public static function toRoute($route, $scheme = false)
    {
84 85 86
        $route = (array)$route;
        $route[0] = static::normalizeRoute($route[0]);

87
        if ($scheme) {
88
            return Yii::$app->getUrlManager()->createAbsoluteUrl($route, is_string($scheme) ? $scheme : null);
89
        } else {
90
            return Yii::$app->getUrlManager()->createUrl($route);
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
        }
    }

    /**
     * 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.
     *
106
     * @param string $route the route. This can be either an absolute route or a relative route.
107
     * @return string normalized route suitable for UrlManager
108
     * @throws InvalidParamException a relative route is given while there is no active controller
109
     */
110
    protected static function normalizeRoute($route)
111
    {
112 113 114 115 116 117 118 119 120 121 122
        $route = (string) $route;
        if (strncmp($route, '/', 1) === 0) {
            // absolute route
            return ltrim($route, '/');
        }

        // relative route
        if (Yii::$app->controller === null) {
            throw new InvalidParamException("Unable to resolve the relative route: $route. No active controller is available.");
        }

123 124
        if (strpos($route, '/') === false) {
            // empty or an action ID
125 126
            return $route === '' ? Yii::$app->controller->getRoute() : Yii::$app->controller->getUniqueId() . '/' . $route;
        } else {
127
            // relative to module
128
            return ltrim(Yii::$app->controller->module->getUniqueId() . '/' . $route, '/');
129 130 131 132
        }
    }

    /**
133
     * Creates a URL based on the given parameters.
134
     *
135 136 137 138
     * This method is very similar to [[toRoute()]]. The only difference is that this method
     * requires a route to be specified as an array only. If a string is given, it will be treated
     * as a URL which will be prefixed with the base URL if it does not start with a slash.
     * In particular, if `$url` is
139
     *
140 141 142 143 144
     * - an array: [[toRoute()]] will be called to generate the URL. For example:
     *   `['site/index']`, `['post/index', 'page' => 2]`. Please refer to [[toRoute()]] for more details
     *   on how to specify a route.
     * - a string with a leading `@`: it is treated as an alias and the corresponding aliased string
     *   will be subject to the following rules.
145
     * - an empty string: the currently requested URL will be returned;
146 147 148 149 150 151 152 153 154 155 156 157 158 159
     * - a string without a leading slash: it will be prefixed with [[\yii\web\Request::baseUrl]].
     * - a string with a leading slash: it will be returned as is.
     *
     * Note that in case `$scheme` is specified (either a string or true), an absolute URL with host info
     * will be returned.
     *
     * Below are some examples of using this method:
     *
     * ```php
     * // /index?r=site/index
     * echo Url::to(['site/index']);
     *
     * // /index?r=site/index&src=ref1#name
     * echo Url::to(['site/index', 'src' => 'ref1', '#' => 'name']);
160
     *
161 162
     * // the currently requested URL
     * echo Url::to();
163
     *
164 165
     * // /images/logo.gif
     * echo Url::to('images/logo.gif');
166
     *
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
     * // http://www.example.com/index.php?r=site/index
     * echo Url::to(['site/index'], true);
     *
     * // https://www.example.com/index.php?r=site/index
     * echo Url::to(['site/index'], 'https');
     * ```
     *
     *
     * @param array|string $url the parameter to be used to generate a valid URL
     * @param boolean|string $scheme the URI scheme to use in the generated URL:
     *
     * - `false` (default): generating a relative URL.
     * - `true`: generating an absolute URL whose scheme is the same as the current request.
     * - string: generating an absolute URL with the specified scheme (either `http` or `https`).
     *
     * @return string the generated URL
     * @throws InvalidParamException a relative route is given while there is no active controller
184 185 186 187 188
     */
    public static function to($url = '', $scheme = false)
    {
        if (is_array($url)) {
            return static::toRoute($url, $scheme);
189 190 191 192 193 194
        }

        $url = (string) Yii::getAlias($url);

        if ($url === '') {
            $url = Yii::$app->getRequest()->getUrl();
195 196 197 198
        } else {
            $hasScheme = ($pos = strpos($url, ':')) > 0 && ctype_alpha(substr($url, 0, $pos));
            $char = $url[0];
            if ($char !== '/' && $char !== '#' && $char !== '.' && !$hasScheme) {
199
                $url = Yii::$app->getUrlManager()->getBaseUrl() . '/' . $url;
200
            }
201 202 203
        }

        if ($scheme) {
204
            if (empty($hasScheme)) {
205
                $url = Yii::$app->getUrlManager()->getHostInfo() . '/' . ltrim($url, '/');
206
            }
207
            if (is_string($scheme) && ($pos = strpos($url, ':')) !== false) {
208 209 210 211 212 213 214 215
                $url = $scheme . substr($url, $pos);
            }
        }

        return $url;
    }

    /**
216 217
     * Returns the base URL of the current request.
     * @param boolean|string $scheme the URI scheme to use in the returned base URL:
218
     *
219 220 221 222 223 224 225
     * - `false` (default): returning the base URL without host info.
     * - `true`: returning an absolute base URL whose scheme is the same as the current request.
     * - string: returning an absolute base URL with the specified scheme (either `http` or `https`).
     * @return string
     */
    public static function base($scheme = false)
    {
226
        $url = Yii::$app->getUrlManager()->getBaseUrl();
227
        if ($scheme) {
228
            $url = Yii::$app->getUrlManager()->getHostInfo() . $url;
229 230 231 232 233 234 235 236 237 238 239 240 241 242
            if (is_string($scheme) && ($pos = strpos($url, '://')) !== false) {
                $url = $scheme . substr($url, $pos);
            }
        }
        return $url;
    }

    /**
     * Remembers the specified URL so that it can be later fetched back by [[previous()]].
     *
     * @param string|array $url the URL to remember. Please refer to [[to()]] for acceptable formats.
     * If this parameter is not specified, the currently requested URL will be used.
     * @param string $name the name associated with the URL to be remembered. This can be used
     * later by [[previous()]]. If not set, it will use [[\yii\web\User::returnUrlParam]].
243 244 245 246
     * @see previous()
     */
    public static function remember($url = '', $name = null)
    {
247
        $url = static::to($url);
248 249 250 251 252 253 254 255 256 257 258

        if ($name === null) {
            Yii::$app->getUser()->setReturnUrl($url);
        } else {
            Yii::$app->getSession()->set($name, $url);
        }
    }

    /**
     * Returns the URL previously [[remember()|remembered]].
     *
259
     * @param string $name the named associated with the URL that was remembered previously.
260 261
     * If not set, it will use [[\yii\web\User::returnUrlParam]].
     * @return string the URL previously remembered. Null is returned if no URL was remembered with the given name.
262 263 264 265 266 267 268 269 270 271 272 273 274
     * @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.
275 276
     * The canonical URL is constructed using the 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
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
     * 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.
     *
296
     * @param boolean|string $scheme the URI scheme to use for the returned URL:
297
     *
298 299 300
     * - `false` (default): returning a relative URL.
     * - `true`: returning an absolute URL whose scheme is the same as the current request.
     * - string: returning an absolute URL with the specified scheme (either `http` or `https`).
301 302 303 304 305
     *
     * @return string home URL
     */
    public static function home($scheme = false)
    {
306 307
        $url = Yii::$app->getHomeUrl();

308
        if ($scheme) {
309
            $url = Yii::$app->getUrlManager()->getHostInfo() . $url;
310
            if (is_string($scheme) && ($pos = strpos($url, '://')) !== false) {
311 312 313 314 315 316
                $url = $scheme . substr($url, $pos);
            }
        }

        return $url;
    }
317
}