别名用来表示文件路径和 URL,这样就避免了在代码中硬编码一些绝对路径和 URL。 一个别名必须以 @ 字符开头,以区别于传统的文件路径和 URL。 没有前导 @ 定义的别名将以 @ 字符作为前缀
定义别名(Defining Aliases)
注意: Yii::getAlias() 并不检查结果路径/URL 所指向的资源是否真实存在。
#你可以调用 Yii::setAlias() 来给文件路径或 URL 定义别名:
// URL 的别名 D:\webroot\nbhuin\xjl\api\common
Yii::setAlias('@common', dirname(__DIR__));
// 文件路径的别名 /path/to/foo
Yii::setAlias('@foo', '/path/to/foo');
#你还可以用别名去定义新别名(根别名与衍生别名均可): /path/to/foo/bar
Yii::setAlias('@foobar', '@foo/bar');
// 包含 \foo\Bar 类的具体文件的别名 /definitely/not/foo/Bar.php
Yii::setAlias('@foo/Bar.php', '/definitely/not/foo/Bar.php');
解析别名(Resolving Aliases)
#你可以调用 Yii::getAlias() 命令来解析根别名到对应的文件路径或 URL。 同样的页面也可以用于解析衍生别名。例如:
Yii::getAlias('@common');
#根别名可能也会包含斜杠 /。 Yii::getAlias() 足够智能到判断一个别名中的哪部分是根别名,因此能正确解析文件路径/URL。 例如:
Yii::setAlias('@foo', '/path/to/foo');
Yii::setAlias('@foo/bar', '/path2/bar');
echo Yii::getAlias('@foo/test/file.php'); // 输出:/path/to/foo/test/file.php
echo Yii::getAlias('@foo/bar/file.php'); // 输出:/path2/bar/file.php
预定义的别名(Predefined Aliases)
Yii
预定义了一系列别名来简化常用路径和 URL 的使用:
@yii
,BaseYii.php
文件所在的目录(也被称为框架安装目录)。@app
,当前运行的应用 根路径(base path)。@runtime
,当前运行的应用的 运行环境(runtime)路径。默认为@app/runtime
。@webroot
,当前运行的Web应用程序的Web根目录。 它是根据包含 入口脚本 的目录确定的@web
,当前运行的Web应用程序的 base URL。它的值与[yii\web\Request::$baseUrl]
相同。@vendor
,Composer vendor 目录。@bower
,包含 bower 包 的根目录。默认为@vendor/bower
。@npm
,包含 npm 包 的根目录。默认为@vendor/npm
。
@yii
别名是在入口脚本里包含 Yii.php
文件时定义的, 其他的别名都是在配置应用的时候, 于应用的构造方法内定义的。
扩展的别名(Extension Aliases)
每一个通过 Composer 安装的 扩展 都自动添加了一个别名。 该别名会以该扩展在 composer.json 文件中所声明的根命名空间为名, 且他直接代指该包的根目录。例如,如果你安装有 yiisoft/yii2-jui 扩展,会自动得到 @yii/jui 别名, 它定义于引导启动阶段:
Yii::setAlias('@yii/jui', 'VendorPath/yiisoft/yii2-jui');