Yii2中设置与获取别名的函数(setAlias和getAlias)用法分析


Posted in PHP onJuly 25, 2016

本文实例讲述了Yii2中设置与获取别名的函数(setAlias和getAlias)用法。分享给大家供大家参考,具体如下:

首先说说什么是别名

在Yii中有很多的路径,在开发的过程当前我们也会使用一些路径。一般来说都需要使用绝对路径,但绝对路径都很长。

所以,为了方便的使用路径,可以在Yi中i给每个路径起个名称,这个名称就是别名。

别名的格式:

别名必须以"@"字符开头,别名中还可以包含"/"。如("@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"

如果用@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框架的PHP程序设计有所帮助。

PHP 相关文章推荐
Win2003服务器安全加固设置--进一步提高服务器安全性
May 23 PHP
php使用exec shell命令注入的方法讲解
Nov 12 PHP
JS异常处理try..catch语句的作用和实例
May 05 PHP
php检查字符串中是否包含7位GSM字符的方法
Mar 17 PHP
Laravel 5框架学习之向视图传送数据(进阶篇)
Apr 08 PHP
PHP实现的简单缓存类
Jul 29 PHP
CI框架实现cookie登陆的方法详解
May 18 PHP
PHP实现超简单的SSL加密解密、验证及签名的方法示例
Aug 28 PHP
PHP registerXPathNamespace()函数讲解
Feb 03 PHP
php实现微信分享朋友链接功能
Feb 18 PHP
PHP cookie与session会话基本用法实例分析
Nov 18 PHP
php 下 html5 XHR2 + FormData + File API 上传文件操作实例分析
Feb 28 PHP
详解PHP实现定时任务的五种方法
Jul 25 #PHP
Yii2中YiiBase自动加载类、引用文件方法分析(autoload)
Jul 25 #PHP
PHP中session跨子域的三种实现方法
Jul 25 #PHP
Yii2创建控制器(createController)方法详解
Jul 23 #PHP
Yii2主题(Theme)用法详解
Jul 23 #PHP
Yii2创建表单(ActiveForm)方法详解
Jul 23 #PHP
Yii2验证器(Validator)用法分析
Jul 23 #PHP
You might like
PHP编码规范之注释和文件结构说明
2010/07/09 PHP
经验几则 推荐
2006/09/05 Javascript
jquery validation插件表单验证的一个例子
2010/03/03 Javascript
JS脚本defer的作用示例介绍
2014/01/02 Javascript
用javascript关闭本窗口技巧小结
2014/09/05 Javascript
好好了解一下Cookie(强烈推荐)
2016/06/14 Javascript
nodejs+express搭建多人聊天室步骤
2018/02/12 NodeJs
iView-admin 动态路由问题的解决方法
2018/10/03 Javascript
基于Vue和Element-Ui搭建项目的方法
2019/09/06 Javascript
vue.js 实现a标签href里添加参数
2019/11/12 Javascript
javascript实现点击小图显示大图
2020/11/29 Javascript
[37:45]2014 DOTA2国际邀请赛中国区预选赛5.21 DT VS Orenda
2014/05/22 DOTA
[01:24:09]Ti4 冒泡赛第二轮DK vs C9 1
2014/07/14 DOTA
Python 除法小技巧
2008/09/06 Python
python动态监控日志内容的示例
2014/02/16 Python
Python中的闭包实例详解
2014/08/29 Python
Python实现类似jQuery使用中的链式调用的示例
2016/06/16 Python
python利用不到一百行代码实现一个小siri
2017/03/02 Python
解析Python中的eval()、exec()及其相关函数
2017/12/20 Python
Python内置模块logging用法实例分析
2018/02/12 Python
python切片及sys.argv[]用法详解
2018/05/25 Python
pycharm 将django中多个app放到同个文件夹apps的处理方法
2018/05/30 Python
python实现超简单的视频对象提取功能
2018/06/04 Python
Python中flatten( )函数及函数用法详解
2018/11/02 Python
详解小白之KMP算法及python实现
2019/04/04 Python
用Python写一个自动木马程序
2019/09/17 Python
解决TensorFlow训练内存不断增长,进程被杀死问题
2020/02/05 Python
深入理解Python变量的数据类型和存储
2021/02/01 Python
服务行业个人求职的自我评价
2013/12/12 职场文书
公司离职证明范本
2014/01/13 职场文书
《老王》教学反思
2014/02/23 职场文书
工地安全生产标语
2014/06/06 职场文书
2014年维修工作总结
2014/11/22 职场文书
2014年居委会工作总结
2014/12/09 职场文书
文明旅游倡议书
2015/04/28 职场文书
pycharm debug 断点调试心得分享
2021/04/16 Python