類別 yii\helpers\BaseUrl

傳回當前請求的基礎 URL。

傳回當前請求頁面的正規 URL。

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 about canonical URL (Canonical URL 是使用當前控制器的 yii\web\Controller::$route 和 yii\web\Controller::$actionParams 建構而成。您可以在版面視圖中使用以下程式碼來新增關於 Canonical URL 的連結標籤)

$this->registerLinkTag(['rel' => 'canonical', 'href' => Url::canonical()]);

使用當前路由和 GET 參數建立 URL。

You may modify or remove some of the GET parameters, or add additional query parameters through the $params parameter. In particular, if you specify a parameter to be null, then this parameter will be removed from the existing GET parameters; all other parameters specified in $params will be merged with the existing GET parameters. For example, (您可以透過 $params 參數修改或移除某些 GET 參數，或新增額外的查詢參數。特別是，如果您將參數指定為 null，則此參數將從現有的 GET 參數中移除；$params 中指定的所有其他參數將與現有的 GET 參數合併。例如：)

// assume $_GET = ['id' => 123, 'src' => 'google'], current route is "post/view"

// /index.php?r=post%2Fview&id=123&src=google
echo Url::current();

// /index.php?r=post%2Fview&id=123
echo Url::current(['src' => null]);

// /index.php?r=post%2Fview&id=100&src=google
echo Url::current(['id' => 100]);

Note that if you're replacing array parameters with [] at the end you should specify $params as nested arrays. For a PostSearchForm model where parameter names are PostSearchForm[id] and PostSearchForm[src] the syntax would be the following (請注意，如果您要用結尾為 [] 的陣列參數取代，則應將 $params 指定為巢狀陣列。對於 PostSearchForm 模型，其中參數名稱為 PostSearchForm[id] 和 PostSearchForm[src]，語法如下：)

// index.php?r=post%2Findex&PostSearchForm%5Bid%5D=100&PostSearchForm%5Bsrc%5D=google
echo Url::current([
    $postSearch->formName() => ['id' => 100, 'src' => 'google'],
]);

通過確保 URL 使用指定的 scheme 來正規化 URL。

If the URL is relative or the scheme is not a string, normalization is skipped. (如果 URL 是相對的，或協定不是字串，則會跳過正規化。)

傳回首頁 URL。

傳回一個值，指示 URL 是否為相對路徑。

A relative URL does not have host info part. (相對 URL 沒有主機資訊部分。)

正規化路由，使其適用於 UrlManager。絕對路由保持不變，而相對路由則轉換為絕對路由。

A relative route is a route without a leading slash, such as "view", "post/view". (相對路由是不帶前導斜線的路由，例如 "view"、"post/view"。)

• If the route is an empty string, the current route (路由) will be used; (如果路由是空字串，將會使用目前的 route (路由)；)
• 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; (如果路由完全不包含斜線，則會將其視為當前控制器的動作 ID，並在其前面加上 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. (如果路由沒有前導斜線，則會將其視為相對於目前模組的路由，並在其前面加上模組的 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. (從版本 2.0.2 開始，路由也可以指定為別名。在這種情況下，別名會先轉換為實際路由，然後再執行上述轉換步驟。)

傳回先前記住的 URL。

See also (另請參閱)

• remember()
• yii\web\User::getReturnUrl()

記住指定的 URL，以便稍後可以通過 previous() 擷取回來。

See also (另請參閱)

• previous()
• yii\web\User::setReturnUrl()

根據給定的參數建立 URL。

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. In particular, if $url is (此方法與 toRoute() 非常相似。唯一的區別在於此方法僅要求將路由指定為陣列。如果給定字串，則會將其視為 URL。特別是，如果 $url 是)

• 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. (陣列：將呼叫 toRoute() 以產生 URL。例如：['site/index']、['post/index', 'page' => 2]。請參閱 toRoute() 以取得關於如何指定路由的更多詳細資訊。)
• a string with a leading @: it is treated as an alias, and the corresponding aliased string will be returned. (帶有前導 @ 的字串：會將其視為別名，並回傳對應的別名字串。)
• an empty string: the currently requested URL will be returned; (空字串：將回傳目前請求的 URL；)
• a normal string: it will be returned as is. (一般字串：將按原樣回傳。)

When $scheme is specified (either a string or true), an absolute URL with host info (obtained from yii\web\UrlManager::$hostInfo) will be returned. If $url is already an absolute URL, its scheme will be replaced with the specified one. (當指定 $scheme (字串或 true) 時，將回傳帶有主機資訊 (從 yii\web\UrlManager::$hostInfo 取得) 的絕對 URL。如果 $url 已經是絕對 URL，其協定將被替換為指定的協定。)

Below are some examples of using this method (以下是一些使用此方法的範例)

// /index.php?r=site%2Findex
echo Url::to(['site/index']);

// /index.php?r=site%2Findex&src=ref1#name
echo Url::to(['site/index', 'src' => 'ref1', '#' => 'name']);

// /index.php?r=post%2Findex     assume the alias "@posts" is defined as "/post/index"
echo Url::to(['@posts']);

// the currently requested URL
echo Url::to();

// /images/logo.gif
echo Url::to('@web/images/logo.gif');

// images/logo.gif
echo Url::to('images/logo.gif');

// https://www.example.com/images/logo.gif
echo Url::to('@web/images/logo.gif', true);

// https://www.example.com/images/logo.gif
echo Url::to('@web/images/logo.gif', 'https');

// //www.example.com/images/logo.gif
echo Url::to('@web/images/logo.gif', '');

為給定的路由建立 URL。

This method will use yii\web\UrlManager to create a URL. (此方法將使用 yii\web\UrlManager 來建立 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 (您可以將路由指定為字串，例如 site/index。如果您想為正在建立的 URL 指定額外的查詢參數，也可以使用陣列。陣列格式必須是)

// 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, (如果您想建立帶有錨點的 URL，可以使用帶有 # 參數的陣列格式。例如：)

// 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 (路由可以是絕對的或相對的。絕對路由帶有前導斜線 (例如 /site/index)，而相對路由則沒有 (例如 site/index 或 index)。相對路由將通過以下規則轉換為絕對路由)

• If the route is an empty string, the current route (路由) will be used; (如果路由是空字串，將會使用目前的 route (路由)；)
• 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; (如果路由完全不包含斜線 (例如 index)，則會將其視為當前控制器的動作 ID，並在其前面加上 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 uniqueId. (如果路由沒有前導斜線 (例如 site/index)，則會將其視為相對於目前模組的路由，並在其前面加上模組的 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. (從版本 2.0.2 開始，路由也可以指定為別名。在這種情況下，別名會先轉換為實際路由，然後再執行上述轉換步驟。)

Below are some examples of using this method (以下是一些使用此方法的範例)

// /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']);

// https://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');