这期内容当中小编将会给大家带来有关怎么在Yii2中获取别名的函数,文章内容丰富且以专业的角度为大家分析和叙述,阅读完这篇文章希望大家可以有所收获。
什么是别名。
在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; } }
上述就是小编为大家分享的怎么在Yii2中获取别名的函数了,如果刚好有类似的疑惑,不妨参照上述分析进行理解。如果想知道更多相关知识,欢迎关注亿速云行业资讯频道。
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。