怎么在Yii2中獲取別名的函數(shù)

這期內(nèi)容當(dāng)中小編將會(huì)給大家?guī)?lái)有關(guān)怎么在Yii2中獲取別名的函數(shù)，文章內(nèi)容豐富且以專業(yè)的角度為大家分析和敘述，閱讀完這篇文章希望大家可以有所收獲。

什么是別名。

在Yii中有很多的路徑，在開(kāi)發(fā)的過(guò)程當(dāng)前我們也會(huì)使用一些路徑。一般來(lái)說(shuō)都需要使用絕對(duì)路徑，但絕對(duì)路徑都很長(zhǎng)。

所以，為了方便的使用路徑，可以在Yi中i給每個(gè)路徑起個(gè)名稱，這個(gè)名稱就是別名。

別名的格式：

別名必須以"@"字符開(kāi)頭，別名中還可以包含"/"。如（"@www"為根別名，"@www/test"就為子別名）
別名最后的目錄分隔符（"\"或者"/"）都將去掉（如果有的情況下）

別名的路徑有以下幾個(gè)格式：

目錄路徑或者文件的路徑（`/tmp`, `/tmp/main.txt`）
URL（`http://www.yii2.com`）
另一個(gè)別名路徑（`@yii/base`），這樣會(huì)調(diào)用getAlias()，解析里面的別名。

設(shè)置別名：

Yii::setAlias("@www", "C:\www\");
Yii::setAlias("@data", "C:\www\data");
Yii::setAlias("@data/attach", "C:\www\data\attach\icon.png");
Yii::setAlias("@home", "www.yiifans.com\");
Yii::setAlias("@admin", "@www\admin");

設(shè)置別名的時(shí)候，如果路徑里面包含別名那么會(huì)調(diào)用getAlias()，解析里面的別名。
如：別名@yii 對(duì)應(yīng)的路徑為/xxx/yii，那么@yii/base將會(huì)解析為/xxx/yii/base

獲取別名：

獲取別名路徑的時(shí)候按如下順序來(lái)：

如果別名不以"@"開(kāi)頭，直接返回別名，不作處理
查找相匹配的最長(zhǎng)的別名，然后用別名路徑來(lái)替換傳入的參數(shù)中的別名。

如設(shè)置了兩個(gè)別名"@foo"=>"my"和"@foo/test"=>"my/test"。

如果用@foo/test/config來(lái)獲取對(duì)應(yīng)的路徑，結(jié)果為"my/test/config"
如果用@foo/testtst/config來(lái)獲取對(duì)應(yīng)的路徑，結(jié)果為"my/testtst/config"
如果用@foo/config來(lái)獲取對(duì)應(yīng)的路徑，結(jié)果為"my/config"

即在匹配的時(shí)候會(huì)以"/"作為分隔符，先匹配最長(zhǎng)的別名。

上面設(shè)置的別名的結(jié)果分別為：

Yii::getAlias("@www");
//輸出：C:\www
Yii::getAlias("@data");
//輸出：C:\www\data
Yii::getAlias("@data/attach");
//輸出：C:\www\data\attach\icon.png
Yii::getAlias("@home");
//輸出：www.yiifans.com
Yii::getAlias("@admin");
//輸出：C:\www\admin

設(shè)置別名函數(shù)源碼：setAlias

public static function setAlias($alias, $path)
{
 if (strncmp($alias, '@', 1)) {
  //如果不是@開(kāi)頭，則自動(dòng)在前面加上@
  $alias = '@' . $alias;
 }
 //查找別名中的"/"
 $pos = strpos($alias, '/');
 //如果別名中沒(méi)有"/"，則根別名就是所輸入的別名，否則從截取"/"前面的作為根別名
 //如：@www，根別名就為@www；
 //如:@www/data，那么根別名截取為@www。
 $root = $pos === false ? $alias : substr($alias, 0, $pos);
 if ($path !== null) {
  /*
   * 如果路徑中包含有別名，另直接調(diào)用getAlias來(lái)解析得到路徑。
   * 否則去掉結(jié)尾的"/"、"\"
   */
  $path = strncmp($path, '@', 1) ? rtrim($path, '\\/') : static::getAlias($path);
  if (!isset(static::$aliases[$root])) {
   /*
    * 如果還沒(méi)有設(shè)置過(guò)這個(gè)根別名（@www）
    *
    * 如果別名就是根別名（參數(shù)就是@www），則直接設(shè)置別名對(duì)應(yīng)的路徑（['@www'=>'路徑']）
    * 否則生成路徑為一個(gè)數(shù)組(['@www'=>['@www/data'=>'路徑'])
    *
    * @www   ['@www'=>'xxxx']
    * @www/a   ['@www'=>['@www/a'=>xxxa]]
    * @www/b   ['@www'=>['@www/b'=>xxxb]]
    * @www/a/b   ['@www'=>['@www/a/b'=>xxxc]]
    *
    * 注：上面的這4中只會(huì)注冊(cè)其中的一個(gè)，因?yàn)樵谏厦媾袛嗔擞袥](méi)有注冊(cè)@www
    */
   if ($pos === false) {
    static::$aliases[$root] = $path;
   } else {
    static::$aliases[$root] = [$alias => $path];
   }
  } elseif (is_string(static::$aliases[$root])) {
   /*
    * 注冊(cè)過(guò)根別名（只有注冊(cè)過(guò)根別名，對(duì)應(yīng)的值才會(huì)是字符串）
    *
    * 如果當(dāng)前注冊(cè)的是根別名，直接覆蓋舊值。
    * ['@www']=xxx
    *
    * 否則把當(dāng)前別名和根別名添加到根別名數(shù)組中
    * @www/a  ['@www']=['@www/a'=>xxxa,'@www'=>'xxx']
    *
    */
   if ($pos === false) {
    static::$aliases[$root] = $path;
   } else {
    static::$aliases[$root] = [
     $alias => $path,
     $root => static::$aliases[$root],
    ];
   }
  } else {
   //添加到根別名的數(shù)組中
   static::$aliases[$root][$alias] = $path;
   krsort(static::$aliases[$root]);
  }
 } elseif (isset(static::$aliases[$root])) {
  //如果是根別名數(shù)組，刪除子別名。
  if (is_array(static::$aliases[$root])) {
   unset(static::$aliases[$root][$alias]);
  } elseif ($pos === false) {
   //刪除整個(gè)根別名數(shù)組
   unset(static::$aliases[$root]);
  }
 }
}

例如：

@www=>xxx        ['@www']=xxx
@www=>yyy        ['@www']=yyy
@www/a=>yyya      ['@www']=['@www/a'=>yyya,'@www'=>yyy]
@www/b=yyyb       ['@www']=['@www/a'=>yyya,'@www'=>yyy,'@www/b'=>yyyb]

也就是說(shuō)，會(huì)把所有的相同根別名的數(shù)據(jù)，放到一個(gè)以根別名為鍵的數(shù)組中，而且對(duì)鍵進(jìn)行逆向排序

獲取別名函數(shù)源碼:getAlias

public static function getAlias($alias, $throwException = true)
{
 //如果不是為@開(kāi)頭，直接返回alias
 if (strncmp($alias, '@', 1)) {
  // not an alias
  return $alias;
 }
 //獲取根別名，和setAlias相同
 $pos = strpos($alias, '/');
 $root = $pos === false ? $alias : substr($alias, 0, $pos);
 if (isset(static::$aliases[$root])) {
  //如果根別名的值為字符串，即只設(shè)置了一個(gè)根別名（['@www'=>xxx]）
  if (is_string(static::$aliases[$root])) {
   /*
    * 如果獲取的名稱為根別名，直接返回根別名對(duì)應(yīng)的路徑，
    * 否則返回值為根別名路徑+去掉別名之后的路徑
    *
    * 如：
    * @www,直接返回 xxx
    * @www/aaa/bbb 返回xxx/aaa/bbb
    */
   return $pos === false ? static::$aliases[$root] : static::$aliases[$root] . substr($alias, $pos);
  } else {
   /* 遍歷子別名
    *
    * @www=>xxx  ['@www']=xxx
    * @www=>yyy  ['@www']=yyy
    * @www/a=>yyya  ['@www']=['@www/a'=>yyya,'@www'=>yyy]
    * @www/b=>yyyb  ['@www']=['@www/a'=>yyya,'@www/b'=>yyyb,'@www'=>yyy]
    * @www/a/c=>yyyac  ['@www']=['@www/a/c'=>yyyac,'@www/a'=>yyya,'@www/b'=>yyyb,'@www'=>yyy]
    */
   foreach (static::$aliases[$root] as $name => $path) {
    /*
     * 在這里，因?yàn)楦鶆e名的所有子別名都根據(jù)鍵也就是子別名進(jìn)行了逆向排序
     * 所以在查找的時(shí)候總是先匹配最長(zhǎng)的別名。
     *
     * 又因?yàn)樵诒容^的時(shí)候給別名后面加了"/"，所以可以保證在查找的時(shí)候能以"/"作為分隔符。
     */
    if (strpos($alias . '/', $name . '/') === 0) {
     return $path . substr($alias, strlen($name));
    }
   }
  }
 }
 if ($throwException) {
  throw new InvalidParamException("Invalid path alias: $alias");
 } else {
  return false;
 }
}

上述就是小編為大家分享的怎么在Yii2中獲取別名的函數(shù)了，如果剛好有類似的疑惑，不妨參照上述分析進(jìn)行理解。如果想知道更多相關(guān)知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道。