从 Yii 1.1 升级 ¶
- 安装
- PHP 需求
- 命名空间
- 组件(Component)与对象(BaseObject)
- 对象的配置
- 事件(Event)
- 路径别名(Path Alias)
- 视图(View)
- 模型(Model)
- 控制器(Controller)
- 小部件(Widget)
- 主题(Theme)
- 控制台应用(Console Application)
- 国际化(I18N)
- 动作过滤器(Action Filters)
- 前端资源(Assets)
- 助手类(Helpers)
- 表单(Forms)
- 查询生成器(Query Builder)
- 活动记录(Active Record)
- 活动记录行为(Active Record Behaviors)
- 用户及身份验证接口(IdentityInterface)
- URL 管理
- 同时使用 Yii 1.1 和 2.x
2.0 版框架是完全重写的,在 1.1 和 2.0 两个版本之间存在相当多差异。 因此从 1.1 版升级并不像小版本间的跨越那么简单, 通过本指南你将会了解两个版本间主要的不同之处。
如果你之前没有用过 Yii 1.1,可以跳过本章,直接从"入门篇"开始读起。
请注意,Yii 2.0 引入了很多本章并没有涉及到的新功能。 强烈建议你通读整部权威指南来了解所有新特性。 这样有可能会发现一些以前你要自己开发的功能,而现在已经被包含在核心代码中了。
安装 ¶
Yii 2.0 完全拥抱 Composer,它是事实上的 PHP 依赖管理工具。 核心框架以及扩展的安装都通过 Composer 来处理。想要了解更多如何安装 Yii 2.0 请参阅本指南的 安装 Yii 章节。如果你想创建新扩展, 或者把你已有的 Yii 1.1 的扩展改写成兼容 2.0 的版本, 你可以参考 创建扩展 章节。
PHP 需求 ¶
Yii 2.0 需要 PHP 5.4 或更高版本,该版本相对于 Yii 1.1 所需求的 PHP 5.2 而言有巨大的改进。 因此在语言层面上有很多的值得注意的不同之处。 下面是 PHP 层的主要变化汇总:
- 命名空间
- 匿名函数
- 数组短语法
[...元素...]
用于取代array(...元素...)
- 视图文件中的短格式 echo 标签
<?=
,自 PHP 5.4 起总会被识别并且合法,无论 short_open_tag 的设置是什么,可以安全使用。 - SPL 类和接口
- 延迟静态绑定
- 日期和时间
- Traits
- intl Yii 2.0 使用 PHP 扩展
intl
来支持国际化的相关功能。
命名空间 ¶
Yii 2.0 里最明显的改动就数命名空间的使用了。几乎每一个核心类都引入了命名空间,
比如 yii\web\Request
。1.1 版类名前缀 “C” 已经不再使用。
当前的命名方案与目录结构相吻合。例如,yii\web\Request
就表明对应的类文件是 Yii 框架文件夹下的 web/Request.php
文件。
(有了 Yii 的类自动加载器, 你可以直接使用全部核心类而不需要显式包含具体文件。)
组件(Component)与对象(BaseObject) ¶
Yii 2.0 把 1.1 中的 CComponent
类拆分成了两个类:yii\base\Object 和 yii\base\Component。
Object 类是一个轻量级的基类,你可以通过 getters 和 setters 来定义对象的属性。
Component 类继承自 Object,
同时进一步支持 事件 和 行为。
如果你不需要用到事件或行为, 应该考虑使用 Object 类作为基类。 这种类通常用来表示基本的数据结构。
对象的配置 ¶
Object 类引入了一种统一对象配置的方法。 所有 Object 的子类都应该用以下方法声明它的构造方法(如果需要的话), 以正确配置它自身:
class MyClass extends \yii\base\BaseObject
{
public function __construct($param1, $param2, $config = [])
{
// ... 配置生效前的初始化过程
parent::__construct($config);
}
public function init()
{
parent::init();
// ... 配置生效后的初始化过程
}
}
在上面的例子里,构造方法的最后一个参数必须传入一个配置数组, 包含一系列用于在方法结尾初始化相关属性的键值对。 你可以重写 init() 方法来执行一些需要在配置生效后进行的初始化工作。
你可以通过遵循以下约定俗成的编码习惯, 来使用配置数组创建并配置新的对象:
$object = Yii::createObject([
'class' => 'MyClass',
'property1' => 'abc',
'property2' => 'cde',
], [$param1, $param2]);
更多有关配置的细节可以在配置章节找到。
事件(Event) ¶
在 Yii 1 中,通常通过定义 on
开头的方法(例如 onBeforeSave
)来创建事件。
而在 Yii 2 中,你可以使用任意的事件名了。同时通过调用 trigger() 方法来触发相关事件:
$event = new \yii\base\Event;
$component->trigger($eventName, $event);
要给事件附加一个事件事件处理器,需要使用 on() 方法:
$component->on($eventName, $handler);
// 解除事件处理器,使用 off 方法:
// $component->off($eventName, $handler);
事件功能还有更多增强之处。要了解它们,请查看事件章节。
路径别名(Path Alias) ¶
Yii 2.0 将路径别名的应用扩大至文件/目录路径和 URL。Yii 2.0 中路径别名必须以 @
符号开头,
以区别于普通文件目录路径或 URL。例如 @yii
就是指向 Yii 安装目录的别名。
绝大多数 Yii 核心代码都支持别名。
例如 yii\caching\FileCache::$cachePath
就同时支持路径别名或普通的目录地址。
路径别名也和类的命名空间密切相关。建议给每一个根命名空间定义一个路径别名,
从而无须额外配置,便可启动 Yii 的类自动加载机制。
例如,因为有 @yii
指向 Yii 安装目录,
那类似 yii\web\Request
的类就能被 Yii 自动加载。同理,若你用了一个第三方的类库,
如 Zend Framework,你只需定义一个名为 @Zend
的路径别名指向该框架的安装目录。
之后 Yii 就可以自动加载任意 Zend Framework 中的类了。
更多路径别名信息请参阅路径别名章节。
视图(View) ¶
Yii 2 中视图最明显的改动是视图内的特殊变量 $this
不再指向当前控制器或小部件,
而是指向视图对象,它是 2.0 中引入的全新概念。视图对象为 yii\web\View 的实例,
他代表了 MVC 模式中的视图部分。如果你想要在视图中访问一个控制器或小部件,
可以使用 $this->context
。
要在其他视图里渲染一个局部视图,使用 $this->render()
,而不是 $this->renderPartial()
。
render()
现在只返回渲染结果,而不是直接显示它,所以现在你必须显式地把它 echo 出来。像这样:
echo $this->render('_item', ['item' => $item]);
除了使用 PHP 作为主要的模板语言,Yii 2.0 也装备了两种流行模板引擎的官方支持:Smarty 和 Twig。
过去的 Prado 模板引擎不再被支持。要使用这些模板引擎,
你需要配置 view
应用组件,
给它设置 View::$renderers 属性。
具体请参阅模板引擎章节。
模型(Model) ¶
Yii 2.0 使用 yii\base\Model 作为模型基类,类似于 1.1 的 CModel
。
CFormModel
被完全弃用了,现在要创建表单模型类,可以通过继承 yii\base\Model 类来实现。
Yii 2.0 引进了名为 scenarios() 的新方法来声明支持的场景, 并指明在哪个场景下某属性必须经过验证,可否被视为安全值等等。如:
public function scenarios()
{
return [
'backend' => ['email', 'role'],
'frontend' => ['email', '!role'],
];
}
上面的代码声明了两个场景:backend
和 frontend
。对于 backend
场景,email
和 role
属性值都是安全的,
且能进行批量赋值。对于 frontend
场景,email
能批量赋值而 role
不能。
email
和 role
都必须通过规则验证。
rules() 方法仍用于声明验证规则。注意,由于引入了 scenarios(),现在已经没有 unsafe
验证器了。
大多数情况下,如果 rules() 方法内已经完整地指定场景了,
那就不必覆写 scenarios(),
也不必声明 unsafe
属性值。
要了解更多有关模型的细节,请参考模型章节。
控制器(Controller) ¶
Yii 2.0 使用 yii\web\Controller 作为控制器的基类,
它类似于 1.1 的 CController
。使用 yii\base\Action 作为操作类的基类。
这些变化最明显的影响是,当你在写控制器操作的代码时, 应该返回(return)要渲染的内容而不是输出(echo)它:
public function actionView($id)
{
$model = \app\models\Post::findOne($id);
if ($model) {
return $this->render('view', ['model' => $model]);
} else {
throw new \yii\web\NotFoundHttpException;
}
}
请查看控制器(Controller)章节了解有关控制器的更多细节。
小部件(Widget) ¶
Yii 2.0 使用 yii\base\Widget 作为小部件基类,类似于 1.1 的 CWidget
。
为了让框架获得更好的 IDE 支持,Yii 2.0 引进了一个调用小部件的新语法。 包含 begin(),end() 和 widget() 三个静态方法,用法如下:
use yii\widgets\Menu;
use yii\widgets\ActiveForm;
// 注意必须 **"echo"** 结果以显示内容
echo Menu::widget(['items' => $items]);
// 传递一个用于初始化对象属性的数组
$form = ActiveForm::begin([
'options' => ['class' => 'form-horizontal'],
'fieldConfig' => ['inputOptions' => ['class' => 'input-xlarge']],
]);
... 表单输入栏都在这里 ...
ActiveForm::end();
更多细节请参阅小部件章节。
主题(Theme) ¶
2.0 主题的运作方式跟以往完全不同了。它们现在基于路径映射机制,该机制会把一个源视图文件的路径映射到一个主题视图文件路径。
举例来说,如果路径映射为 ['/web/views' => '/web/themes/basic']
,
那么 /web/views/site/index.php
视图经过主题修饰的版本就会是 /web/themes/basic/site/index.php
。
也因此让主题现在可以应用在任何视图文件之上,
甚至是渲染控制器上下文环境之外的视图文件或小部件。
同样,CThemeManager
组件已经被移除了。
取而代之的 theme
成为了 view
应用组件的一个可配置属性。
更多细节请参考主题章节。
控制台应用(Console Application) ¶
控制台应用现在如普通的 Web 应用程序一样,由控制器组成,
控制台的控制器继承自 yii\console\Controller,类似于 1.1 的 CConsoleCommand
。
运行控制台命令使用 yii <route>
,
其中 <route>
代表控制器的路由(如 sitemap/index
)。
额外的匿名参数传递到对应的控制器操作方法,
而有名的参数根据 yii\console\Controller::options() 的声明来解析。
Yii 2.0 支持基于代码注释自动生成相的关命令行帮助(help)信息。
更多细节请参阅控制台命令章节。
国际化(I18N) ¶
Yii 2.0 移除了原来内置的日期格式器和数字格式器,为了支持 PECL intl PHP module(PHP 的国际化扩展)的使用。
消息翻译现在由 i18n
应用组件执行。
该组件管理一系列消息源,
允许使用基于消息类别的不同消息源。
更多细节请参阅国际化(Internationalization)章节。
动作过滤器(Action Filters) ¶
操作的过滤现在通过行为(behavior)来实现。要定义一个新的,自定义的过滤器,请继承 yii\base\ActionFilter 类。
要使用一个过滤器,需要把过滤器类作为一个 behavior
绑定到控制器上。
例如,要使用 yii\filters\AccessControl 过滤器,你需要在控制器内添加如下代码:
public function behaviors()
{
return [
'access' => [
'class' => 'yii\filters\AccessControl',
'rules' => [
['allow' => true, 'actions' => ['admin'], 'roles' => ['@']],
],
],
];
}
更多细节请参考过滤器章节。
前端资源(Assets) ¶
Yii 2.0 引入了一个新的概念,称为资源包(Asset Bundle),以代替 1.1 的脚本包概念。
一个资源包是一个目录下的资源文件集合(如 JavaScript 文件、CSS 文件、图片文件等)。 每一个资源包被表示为一个类,该类继承自 yii\web\AssetBundle。 用 yii\web\AssetBundle::register() 方法注册一个资源包后, 就使它的资源可被 Web 访问了, 注册了资源包的页面会自动包含和引用资源包内指定的 JS 和 CSS 文件。
更多细节请参阅 前端资源管理(Asset) 章节。
助手类(Helpers) ¶
Yii 2.0 很多常用的静态助手类,包括:
- yii\helpers\Html
- yii\helpers\ArrayHelper
- yii\helpers\StringHelper
- yii\helpers\FileHelper
- yii\helpers\Json
请参考助手一览 章节来了解更多。
表单(Forms) ¶
Yii 2.0 引进了表单栏(field)的概念,用来创建一个基于 yii\widgets\ActiveForm 的表单。 一个表单栏是一个由标签、输入框、错误消息(可能还有提示文字)组成的容器, 被表示为一个 ActiveField 对象。 使用表单栏建立表单的过程比以前更整洁利落:
<?php $form = yii\widgets\ActiveForm::begin(); ?>
<?= $form->field($model, 'username') ?>
<?= $form->field($model, 'password')->passwordInput() ?>
<div class="form-group">
<?= Html::submitButton('Login') ?>
</div>
<?php yii\widgets\ActiveForm::end(); ?>
请参考创建表单章节来了解更多细节。
查询生成器(Query Builder) ¶
Yii 1.1 中,查询语句的生成分散在多个类中,包括 CDbCommand
,CDbCriteria
以及 CDbCommandBuilder
。
Yii 2.0 以 Query 对象的形式表示一个数据库查询,
这个对象使用 QueryBuilder 在幕后生成 SQL 语句。
例如:
$query = new \yii\db\Query();
$query->select('id, name')
->from('user')
->limit(10);
$command = $query->createCommand();
$sql = $command->sql;
$rows = $command->queryAll();
最重要的是,这些查询生成方法还可以和活动记录配合使用。
请参考查询生成器(Query Builder)章节了解更多内容。
活动记录(Active Record) ¶
Yii 2.0 的活动记录改动了很多。 两个最显而易见的改动分别涉及查询语句的生成(query building)和关联查询的处理(relational query handling)。
1.1 中的 CDbCriteria
类在 Yii 2 中被 yii\db\ActiveQuery 所替代。
这个类是继承自 yii\db\Query,因此也继承了所有查询生成方法。开始拼装一个查询可以调用 yii\db\ActiveRecord::find() 方法进行:
// 检索所有“活动的”客户和订单,并以 ID 排序:
$customers = Customer::find()
->where(['status' => $active])
->orderBy('id')
->all();
要声明一个关联关系,只需简单地定义一个 getter 方法来返回一个 ActiveQuery 对象。
getter 方法定义的属性名代表关联表名称。
如,以下代码声明了一个名为 orders
的关系(1.1 中必须在 relations()
方法内声明关系):
class Customer extends \yii\db\ActiveRecord
{
public function getOrders()
{
return $this->hasMany('Order', ['customer_id' => 'id']);
}
}
现在你就可以通过调用 $customer->orders
来访问关联表中某用户的订单了。
你还可以用以下代码进行一场指定条件的实时关联查询:
$orders = $customer->getOrders()->andWhere('status=1')->all();
当贪婪加载一段关联关系时,Yii 2.0 和 1.1 的运作机理并不相同。 具体来说,在 1.1 中使用一条 JOIN 语句同时查询主表和关联表记录。 在 Yii 2.0 中会使用两个没有 JOIN 的 SQL 语句:第一条语句取回主表记录, 第二条通过主表记录经主键筛选后查询关联表记录。
当生成返回大量记录的查询时,可以链式书写 asArray() 方法, 这样会以数组的形式返回查询结果,而不必返回 ActiveRecord 对象,这能显著降低因大量记录读取所消耗的 CPU 时间和内存。如:
$customers = Customer::find()->asArray()->all();
另一个改变是你不能再通过公共变量定义属性(Attribute)的默认值了。
如果你需要这么做的话,可以在你的记录类的 init
方法中设置它们。
public function init()
{
parent::init();
$this->status = self::STATUS_NEW;
}
曾几何时,在 1.1 中重写一个活动记录类的构造方法会导致一些问题。它们不会在 2.0 中出现了。 需要注意的是,如果你需要在构造方法中添加一些参数,恐怕必须重写 yii\db\ActiveRecord::instantiate() 方法。
活动记录方面还有很多其他的变化与改进, 请参考活动记录章节以了解更多细节。
活动记录行为(Active Record Behaviors) ¶
在 2.0 中遗弃了活动记录行为基类 CActiveRecordBehavior
。
如果你想创建活动记录行为,需要直接继承 yii\base\Behavior
。
如果行为类中需要表示一些事件,需要像这样覆写 events()
方法:
namespace app\components;
use yii\db\ActiveRecord;
use yii\base\Behavior;
class MyBehavior extends Behavior
{
// ...
public function events()
{
return [
ActiveRecord::EVENT_BEFORE_VALIDATE => 'beforeValidate',
];
}
public function beforeValidate($event)
{
// ...
}
}
用户及身份验证接口(IdentityInterface) ¶
1.1 中的 CWebUser
类现在被 yii\web\User 所取代,随之 CUserIdentity
类也不在了。
与之相对的,为达到相同目的,你可以实现 yii\web\IdentityInterface 接口,它使用起来更直观。
在高级应用模版里提供了一个这样的一个例子。
要了解更多细节请参考认证(Authentication),授权(Authorization)以及高级应用模版 这三个章节。
URL 管理 ¶
Yii 2.0 的 URL 管理跟 1.1 中很像。一个主要的改进是现在的 URL 管理支持可选参数了。
比如,如果你在 2.0 中定义了一个下面这样的规则,那么它可以同时匹配
post/popular
和 post/1/popular
两种 URL。
而在 1.1 中为达成相同效果,必须要使用两条规则。
[
'pattern' => 'post/<page:\d+>/<tag>',
'route' => 'post/index',
'defaults' => ['page' => 1],
]
请参考URL 解析和生成 章节,以了解更多细节。.
一个重要变化是路由命名的约定,
现在的控制器和动作的驼峰命名会被转换成小写字母,
其中每个单词由一个专有的连字号分隔,例如,CamelCaseController
将为 camel-case
。
有关更多详细信息,请参阅关于 controller IDs 和 action IDs 的部分。
同时使用 Yii 1.1 和 2.x ¶
如果你有一些遗留的 Yii 1.1 代码,需要跟 Yii 2.0 一起使用, 可以参考 1.1 和 2.0 共用章节。