Yii 2で別名を取得する関数(setAliasとgetAlias)の使い方分析を設定する

6819 ワード

この例では、Yii 2で別名を設定して取得する関数(setAliasおよびgetAlias)の使い方について説明します.皆さんの参考にしてください.具体的には以下の通りです.
まず別名とは何かを話します.
Yiiには多くのパスがあり、開発の過程では現在もいくつかのパスを使用しています.一般的には絶対パスが必要ですが、絶対パスは長いです.
したがって、パスを容易に使用するために、Yiで各パスに名前を付けることができます.この名前は別名です.
別名のフォーマット:
別名は「@」文字で始まる必要があります.別名には「/」も含めることができます.('@www'がルートエイリアス、'@www/test'がサブエイリアス)エイリアスの最後のディレクトリ区切り記号(''または'/')が削除されます(場合によっては)
エイリアスのパスには、次の形式があります.
ディレクトリパスまたはファイルのパス(`/tmp`,`/tmp/main.txt`)URL(`http://www.yii2.com`)別の別名パス(`@yii/base`)は、getAlias()を呼び出し、中の別名を解析します.
別名の設定:

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");


エイリアスを設定するとき、パスにエイリアスが含まれている場合はgetAlias()を呼び出し、エイリアスを解析します.例えば、別名@yiiに対応するパスが/xxx/yiiの場合、@yii/baseは/xxx/yii/baseとして解析されます.
別名の取得:
エイリアスパスを取得するには、次の手順に従います.
エイリアスが「@」で始まる場合は、エイリアスを直接返し、一致する最長のエイリアスを処理せずに検索し、入力したパラメータのエイリアスをエイリアスパスで置き換えます.
別名「@foo」=>「my」と「@foo/test」=>「my/test」の2つを設定します.
@foo/test/configで対応するパスを取得した場合、結果は「my/test/config」@foo/testtst/configで対応するパスを取得した場合、結果は「my/testtst/config」@foo/configで対応するパスを取得した場合、結果は「my/config」
つまり、一致するときは「/」を区切り記号として、最も長い別名を先に一致させます.
上に設定したエイリアスの結果は、次のとおりです.

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


別名関数ソースの設定:setAlias

public static function setAlias($alias, $path)
{
 if (strncmp($alias, '@', 1)) {
  //    @  ,        @
  $alias = '@' . $alias;
 }
 //      "/"
 $pos = strpos($alias, '/');
 //       "/",            ,     "/"        
 // :@www,     @www;
 // :@www/data,        @www。
 $root = $pos === false ? $alias : substr($alias, 0, $pos);
 if ($path !== null) {
  /*
   *           ,     getAlias       。
   *        "/"、"\"
   */
  $path = strncmp($path, '@', 1) ? rtrim($path, '\\/') : static::getAlias($path);
  if (!isset(static::$aliases[$root])) {
   /*
    *              (@www)
    *
    *          (    @www),            (['@www'=>'  '])
    *            (['@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          ,             @www
    */
   if ($pos === false) {
    static::$aliases[$root] = $path;
   } else {
    static::$aliases[$root] = [$alias => $path];
   }
  } elseif (is_string(static::$aliases[$root])) {
   /*
    *       (        ,          )
    *
    *            ,      。
    * ['@www']=xxx
    *
    *                     
    * @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 {
   //          
   static::$aliases[$root][$alias] = $path;
   krsort(static::$aliases[$root]);
  }
 } elseif (isset(static::$aliases[$root])) {
  //        ,     。
  if (is_array(static::$aliases[$root])) {
   unset(static::$aliases[$root][$alias]);
  } elseif ($pos === false) {
   //         
   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]
つまり、同じルート別名のすべてのデータが、ルート別名をキーとする配列に配置され、キーが逆ソートされます.
別名関数の取得元:getAlias

public static function getAlias($alias, $throwException = true)
{
 //     @  ,    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])) {
  //           ,          (['@www'=>xxx])
  if (is_string(static::$aliases[$root])) {
   /*
    *            ,            ,
    *            +         
    *
    *  :
    * @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) {
    /*
     *    ,                            
     *                   。
     *
     *                 "/",              "/"     。
     */
    if (strpos($alias . '/', $name . '/') === 0) {
     return $path . substr($alias, strlen($name));
    }
   }
  }
 }
 if ($throwException) {
  throw new InvalidParamException("Invalid path alias: $alias");
 } else {
  return false;
 }
}


Yiiの関連内容についてもっと興味のある読者は、「Yiiフレームワーク入門及び常用技術総括」、「php優秀開発フレームワーク総括」、「smartyテンプレート入門基礎教程」、「php対象プログラム設計入門教程」、「php文字列(string)用法総括」、「php+mysqlデータベース操作入門チュートリアル」および「php一般データベース操作テクニック要約」
本稿では,Yiiフレームワークに基づくPHPプログラムの設計に役立つことを期待する.