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

首先说说什么是别名

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

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

别名的格式:

别名必须以"@"字符开头,别名中还可以包含"https://www.jb51.net/"。如("@www"为根别名,"@www/test"就为子别名)
别名最后的目录分隔符("\"或者"https://www.jb51.net/")都将去掉(如果有的情况下)

别名的路径有以下几个格式:

目录路径或者文件的路径(`/tmp`, `/tmp/main.txt`)
URL(``)
另一个别名路径(`@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"

即在匹配的时候会以"https://www.jb51.net/"作为分隔符,先匹配最长的别名

上面设置的别名的结果分别为:

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

设置别名函数源码:setAlias

public static function setAlias($alias, $path) { if (strncmp($alias, '@', 1)) { //如果不是@开头,则自动在前面加上@ $alias = '@' . $alias; } //查找别名中的"https://www.jb51.net/" $pos = strpos($alias, 'https://www.jb51.net/'); //如果别名中没有"https://www.jb51.net/",则根别名就是所输入的别名,否则从截取"https://www.jb51.net/"前面的作为根别名 //如:@www,根别名就为@www; //如:@www/data,那么根别名截取为@www。 $root = $pos === false ? $alias : substr($alias, 0, $pos); if ($path !== null) { /* * 如果路径中包含有别名,另直接调用getAlias来解析得到路径。 * 否则去掉结尾的"https://www.jb51.net/"、"\" */ $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]); } } }

例如:

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/6a1c9af0a25a552c6d1c50483d85844f.html