在項目中,推薦使用 Yii2 內建的 URL 工具類產生連結,這樣可以非常便捷的管理整站的 URL 行為:比如通過修改配置改變整站的URL格式等。URL 更多進階的用法參見官方文檔,這篇文章僅僅介紹 Yii2 產生 URL 的幾種方式。
Yii2 預設的 URL 連結格式
Yii2 預設的 URL 連結格式是指為開啟 URL 美化時的格式。
未啟用子模組的 URL 格式:
// 參數 r 中的 article 表示控制器, view 表示動作http://www.example.com/index.php?r=article/view&id=100
啟用了子模組的 URL 格式:
// 參數 r 中的 kernel 表示子模組http://www.example.com/index.php?r=kernel/article/view&id=100
Yii2 內建的 URL 產生工具
URL 管理器:urlManager
URL 助手類:yii\helpers\Url
使用內建的 URL 產生工具,以後可以在不改變源碼的情況通過配置即可美化整站的 URL
URL 管理器
URL 管理器是一個名叫 urlManager 的內建應用程式組件。在 WEB 應用和控制台應用中以通過以下兩種方式建立 URL:
\Yii::$app->urlManager->createUrl($params)
\Yii::$app->urlManager->createAbsoluteUrl($params, $schema = null)
createUrl 方法產生根目錄的相對路徑,例如:/index.php?r=article/view
createAbsoluteUrl() 方法產生的是絕對路徑,例如:http://www.example.com/index.php?r=article/view
常見的利用 URL 管理器建立 URL 的例子:
// URL:/index.php?r=article/view\Yii::$app->urlManager->createUrl('article/view');// URL:/index.php?r=article/view&id=2\Yii::$app->urlManager->createUrl(['article/view','id'=>2]);// URL: http://www.example.com?r=kernel/article/viewecho \Yii::$app->urlManager->createAbsoluteUrl('kernel/article/view');
URL 助手類
相對於 URL管理器,使用 yii\helpers\Url 助手類可大大簡化 URL 的建立。
1. 假設當前 URL /index.php?r=kernel/article/view&id=10,以下說明 URL 助手類 Url::to() 是如何工作的(不推薦):
// 建立當前 URL// 顯示:/?r=kernel/article/view&id=10echo Url::to();// 建立當前 URL// 顯示:http://www.example.com/?r=kernel/article/view&id=10echo Url::to('', true);// 字元參數,沒啥用// 顯示:kernel/article/viewecho Url::to('kernel/article/view');// 建立路由,數組參數的自動調用 Url::toRoute(...)// 顯示:/index.php?r=kernel/article/viewecho Url::to(['article/view']);
2. 假設當前 URL /index.php?r=kernel/article/view&id=10,以下說明 URL 助手類 Url::toRoute() 方法是如何工作的(推薦):
// 建立當前路由(僅繼承參數r的值)// 顯示:/index.php?r=kernel/article/viewecho Url::toRoute([]);// 相同的模組和控制器,不同的動作(僅繼承參數r的值)// 顯示:/index.php?r=kernel/article/listecho Url::toRoute('list');// 相同的模組和控制器,不同的動作(僅繼承參數r的值)// 顯示:/index.php?r=kernel/article/list&cat=contactecho Url::toRoute(['list','cat'=>10]);// 相同模組,不同控制器和動作(僅繼承參數r的值)// 顯示:/index.php?r=kernel/product/indexecho Url::toRoute('product/index');// 絕對路由,不管是被哪個模組和控制器調用// 顯示:/index.php?r=product/indexecho Url::toRoute('/product/index');// 控制器動作 `actionListHot` 的 URL 格式(僅繼承參數r的值,區分大小寫)// 顯示:/index.php?r=kernel/article/list-hotecho Url::toRoute('list-hot');// 從別名中擷取 URL // 顯示:http://www.baidu.com/Yii::setAlias('@baidu', 'http://www.baidu.com/');echo Url::to('@baidu');
3. 假設當前 URL /index.php?r=kernel/article/view&id=10,以下說明 URL 助手類 Url::current() 方法是如何工作的(推薦):
// 建立當前 URL(包括路由和參數)// 顯示:/?r=kernel/article/view&id=10echo Url::current();// 移除參數 id// 顯示:/?r=kernel/article/viewecho Url::current(['id'=>null]);// 新增參數 cat// 顯示:/?r=kernel/article/view&id=10&cat=2echo Url::current(['cat'=>2]);