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 相关文章推荐
层叠菜单的动态生成
Oct 09 PHP
国外十大最流行的PHP框架排名
Jul 04 PHP
实现获取http内容的php函数分享
Feb 16 PHP
thinkphp实现图片上传功能分享
Mar 04 PHP
PHP自带函数给数字或字符串自动补齐位数
Jul 29 PHP
PHP中echo和print的区别
Aug 28 PHP
谈谈PHP中substr和substring的正确用法及相关参数的介绍
Dec 16 PHP
WordPress主题制作之模板文件的引入方法
Dec 28 PHP
WordPress中获取指定分类及其子分类下的文章数目
Dec 31 PHP
PHP如何获取当前主机、域名、网址、路径、端口等参数
Jun 09 PHP
PHP实现的服务器一致性hash分布算法示例
Aug 09 PHP
PHP7.3.10编译安装教程
Oct 08 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
一个显示天气预报的程序
2006/10/09 PHP
基于python发送邮件的乱码问题的解决办法
2013/04/25 PHP
浅谈php扩展imagick
2014/06/02 PHP
PHP闭包实例解析
2014/09/08 PHP
CodeIgniter 完美解决URL含有中文字符串
2016/05/13 PHP
LNMP部署laravel以及xhprof安装使用教程
2017/09/14 PHP
PHP safe_mode开启对于PHP系统函数有什么影响
2020/11/10 PHP
jquery中动态效果小结
2010/12/16 Javascript
JavaScript:Div层拖动效果实例代码
2013/08/06 Javascript
JavaScript第一篇之实现按钮全选、功能
2016/08/21 Javascript
使用nodejs下载风景壁纸
2017/02/05 NodeJs
jQuery插件FusionCharts实现的3D帕累托图效果示例【附demo源码】
2017/03/25 jQuery
JS SetInterval 代码实现页面轮询
2017/08/11 Javascript
Swiper 4.x 使用方法(移动端网站的内容触摸滑动)
2018/05/17 Javascript
JS/HTML5游戏常用算法之追踪算法实例详解
2018/12/12 Javascript
Vue页面切换和a链接的本质区别详解
2019/11/12 Javascript
js实现登录时记住密码的方法分析
2020/04/05 Javascript
[51:20]完美世界DOTA2联赛PWL S2 Magma vs PXG 第一场 11.28
2020/12/01 DOTA
使用go和python递归删除.ds store文件的方法
2014/01/22 Python
python3+PyQt5实现使用剪贴板做复制与粘帖示例
2017/01/24 Python
windows下cx_Freeze生成Python可执行程序的详细步骤
2018/10/09 Python
python 异或加密字符串的实例
2018/10/14 Python
python自定义函数实现一个数的三次方计算方法
2019/01/20 Python
解决pycharm同一目录下无法import其他文件
2020/02/12 Python
如何用Anaconda搭建虚拟环境并创建Django项目
2020/08/02 Python
Python中用xlwt制作表格实例讲解
2020/11/05 Python
C#公司笔试题
2014/03/28 面试题
语文教学感言
2014/02/06 职场文书
服务型党组织建设典型材料
2014/05/07 职场文书
安全演讲稿大全
2014/05/09 职场文书
感谢信范文大全
2015/01/23 职场文书
2015年汽车销售工作总结
2015/04/07 职场文书
淘宝文案策划岗位职责
2015/04/14 职场文书
教师培训简讯
2015/07/20 职场文书
如何拟写通知正文?
2019/04/02 职场文书
该怎么书写道歉信?
2019/07/03 职场文书