yii\helpers\BaseUrl::toRoute PHP Method

BaseUrl Class Documentation Usage Examples Of yii\helpers\BaseUrl::toRoute Datei anzeigen Open project: yiisoft/yii2

toRoute() public static method

This method will use UrlManager to create a URL. 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¶m1=value1¶m2=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¶m1=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: - 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 (e.g. index), 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 (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]]. Starting from version 2.0.2, a route can also be specified as an alias. In this case, the alias will be converted into the actual route first before conducting the above transformation steps. Below are some examples of using this method: php /index.php?r=site%2Findex echo Url::toRoute('site/index'); /index.php?r=site%2Findex&src=ref1#name echo Url::toRoute(['site/index', 'src' => 'ref1', '#' => 'name']); http://www.example.com/index.php?r=site%2Findex echo Url::toRoute('site/index', true); https://www.example.com/index.php?r=site%2Findex echo Url::toRoute('site/index', 'https'); /index.php?r=post%2Findex assume the alias "@posts" is defined as "post/index" echo Url::toRoute('@posts');
public static toRoute ( string | array $route, boolean | string $scheme = false ) : string
$route string | array 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']`).
$scheme boolean | string the URI scheme to use in the generated URL: - `false` (default): generating a relative URL. - `true`: returning an absolute base URL whose scheme is the same as that in [[\yii\web\UrlManager::$hostInfo]]. - string: generating an absolute URL with the specified scheme (either `http`, `https` or empty string for protocol-relative URL).
return string the generated URL 
    public static function toRoute($route, $scheme = false)
    {
        $route = (array) $route;
        $route[0] = static::normalizeRoute($route[0]);
        if ($scheme !== false) {
            return static::getUrlManager()->createAbsoluteUrl($route, is_string($scheme) ? $scheme : null);
        } else {
            return static::getUrlManager()->createUrl($route);
        }
    }

Usage Example

Beispiel #1
0
 public static function toRoute($route, $scheme = false)
 {
     $route[0] = ltrim($route[0], '/');
     if (substr_count($route[0], '/') == 2) {
         $route[0] = '/' . $route[0];
     }
     return "/" . I("__orgcode") . parent::toRoute($route, $scheme);
 }
All Usage Examples Of yii\helpers\BaseUrl::toRoute
BaseUrl
base
canonical
current
ensureScheme
getUrlManager
home
isRelative
normalizeRoute
previous
remember
to
toRoute