annuaire recherche
阅读前篇 简介 Yii 是什么 从 Yii 1.1 升级 入门 安装 Yii 运行应用 第一次问候 使用Forms 数据库应用 使用 Gii 生成代码 进阶 应用结构 概述 入口脚本 应用(Applications) 应用组件(Application Components) 控制器(Controllers) 模型(Models) 视图(views) 模块(Modules) 过滤器(Filters) 小部件(Widgets) 前端资源(Assets) 扩展(Extensions) 请求处理 运行概述 启动引导(Bootstrapping) 路由和创建URL 请求(Requests) 响应(Responses) Sessions 和 Cookies 错误处理(Handling Errors) 日志(Logging) 关键概念 组件(Component) 属性(Property) 事件(Events) 行为(Behaviors) 配置(Configurations) 别名(Aliases) 类自动加载(Autoloading) 服务定位器(Service Locator) 依赖注入容器(Dependency Injection Container) 配合数据库工作 数据库访问 (Data Access Objects) 查询生成器(Query Builder) 活动记录(Active Record) 数据库迁移(Migrations) Sphinx Redis MongoDB Elasticsearch 接收用户数据 创建表单(Creating Forms) 输入验证(Validating Input) 文件上传(Uploading Files) 收集列表输入(Collecting Tabular Input) 多模型的复合表单(Getting Data for Multiple Models) 显示数据 格式化输出数据(Data Formatting) 分页(Pagination) 排序(Sorting) 数据提供器(Data Providers) 数据小部件(Data Widgets) 客户端脚本使用(Working with Client Scripts) 主题(Theming) 安全 认证(Authentication) 授权(Authorization) 处理密码(Working with Passwords) 客户端认证(Auth Clients) 最佳安全实践(Best Practices) 缓存 概述 数据缓存 片段缓存 页面缓存 HTTP 缓存 RESTfull Web服务 快速入门(Quick Start) 资源(Resources) 控制器(Controllers) 路由(Routing) 格式化响应(Response Formatting) 授权认证(Authentication) 速率限制(Rate Limiting) 版本(Versioning) 错误处理(Error Handling) 开发工具 调试工具栏和调试器 使用Gii生成代码 生成API文档 测试 概述(Overview) 配置测试环境(Testing environment setup) 单元测试(Unit Tests) 功能测试(Function Tests) 验收测试(Acceptance Tests) 测试夹具(Fixtures) 高级专题 高级应用模板 创建自定义应用程序结构 控制台命令 核心验证器(Core Validators) 国际化 收发邮件 性能优化 共享主机环境 模板引擎 集成第三方代码 小部件 Bootstrap 小部件 Jquery UI 助手类 概述 Array 助手(ArrayHelper) Html 助手(Html) Url 助手(Url)
personnages

别名(Aliases)

别名(Aliases)

别名用来表示文件路径和 URL,这样就避免了在代码中硬编码一些绝对路径和 URL。一个别名必须以 @ 字符开头,以区别于传统的文件路径和 URL。Yii 预定义了大量可用的别名。例如,别名 @yii 指的是 Yii 框架本身的安装目录,而 @web 表示的是当前运行应用的根 URL。

定义别名

你可以调用 Yii::setAlias() 来给文件路径或 URL 定义别名:

// 文件路径的别名
Yii::setAlias('@foo', '/path/to/foo');

// URL 的别名
Yii::setAlias('@bar', 'http://www.example.com');

注意:别名所指向的文件路径或 URL 不一定是真实存在的文件或资源。

可以通过在一个别名后面加斜杠 / 和一至多个路径分段生成新别名(无需调用 Yii::setAlias())。我们把通过 Yii::setAlias() 定义的别名称为根别名,而用他们衍生出去的别名成为衍生别名。例如,@foo 就是根别名,而 @foo/bar/file.php 是一个衍生别名。

你还可以用别名去定义新别名(根别名与衍生别名均可):

Yii::setAlias('@foobar', '@foo/bar');

根别名通常在引导阶段定义。比如你可以在入口脚本里调用 Yii::setAlias()。为了方便起见,应用提供了一个名为 aliases 的可写属性,你可以在应用配置中设置它,就像这样:

return [
    // ...
    'aliases' => [
        '@foo' => '/path/to/foo',
        '@bar' => 'http://www.example.com',
    ],
];

解析别名

你可以调用 Yii::getAlias() 命令来解析根别名到对应的文件路径或 URL。同样的页面也可以用于解析衍生别名。例如:

echo Yii::getAlias('@foo');               // 输出:/path/to/fooecho Yii::getAlias('@bar');               // 输出:http://www.example.comecho Yii::getAlias('@foo/bar/file.php');  // 输出:/path/to/foo/bar/file.php

由衍生别名所解析出的文件路径和 URL 是通过替换掉衍生别名中的根别名部分得到的。

注意:Yii::getAlias() 并不检查结果路径/URL 所指向的资源是否真实存在。

根别名可能也会包含斜杠 /。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.phpecho Yii::getAlias('@foo/bar/file.php');   // 输出:/path2/bar/file.php

若 @foo/bar 未被定义为根别名,最后一行语句会显示为 /path/to/foo/bar/file.php

使用别名

别名在 Yii 的很多地方都会被正确识别,无需调用 Yii::getAlias() 来把它们转换为路径/URL。例如,yii\caching\FileCache::cachePath 能同时接受文件路径或是指向文件路径的别名,因为通过 @ 前缀能区分它们。

use yii\caching\FileCache;

$cache = new FileCache([
    'cachePath' => '@runtime/cache',
]);

请关注 API 文档了解特定属性或方法参数是否支持别名。

预定义的别名

Yii 预定义了一系列别名来简化常用路径和 URL 的使用:

  • @yii - BaseYii.php 文件所在的目录(也被称为框架安装目录)
  • @app - 当前运行的应用 yii\base\Application::basePath
  • @runtime - 当前运行的应用的 yii\base\Application::runtimePath
  • @vendor - yii\base\Application::vendorPath
  • @webroot - 当前运行应用的 Web 入口目录
  • @web - 当前运行应用的根 URL

@yii 别名是在入口脚本里包含 Yii.php 文件时定义的,其他的别名都是在配置应用的时候,于应用的构造方法内定义的。

扩展的别名

每一个通过 Composer 安装的 扩展 都自动添加了一个别名。该别名会以该扩展在 composer.json 文件中所声明的根命名空间为名,且他直接代指该包的根目录。例如,如果你安装有 yiisoft/yii2-jui 扩展,会自动得到 @yii/jui 别名,它定义于引导启动阶段:

Yii::setAlias('@yii/jui''VendorPath/yiisoft/yii2-jui');
Article précédent: Article suivant: