Yii2中文手册

目录搜索

阅读前篇简介 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)

文字

Sessions 和 Cookies

[译注：Session中文翻译为会话，Cookie有些翻译成小甜饼，不贴切，两个单词保留英文] Sessions 和 cookies 允许数据在多次请求中保持，在纯PHP中，可以分别使用全局变量$_SESSION 和$_COOKIE 来访问，Yii将session和cookie封装成对象并增加一些功能，可通过面向对象方式访问它们。

Sessions

和请求和响应类似，默认可通过为yii\web\Session 实例的session 应用组件来访问sessions。

开启和关闭 Sessions

可使用以下代码来开启和关闭session。

$session = Yii::$app->session;

// 检查session是否开启 if ($session->isActive) ...

// 开启session$session->open();

// 关闭session$session->close();

// 销毁session中所有已注册的数据$session->destroy();

多次调用yii\web\Session::open() 和yii\web\Session::close() 方法并不会产生错误，因为方法内部会先检查session是否已经开启。

访问Session数据

To access the data stored in session, you can do the following: 可使用如下方式访问session中的数据：

$session = Yii::$app->session;

// 获取session中的变量值，以下用法是相同的：$language = $session->get('language');
$language = $session['language'];
$language = isset($_SESSION['language']) ? $_SESSION['language'] : null;

// 设置一个session变量，以下用法是相同的：$session->set('language', 'en-US');
$session['language'] = 'en-US';
$_SESSION['language'] = 'en-US';

// 删除一个session变量，以下用法是相同的：$session->remove('language');
unset($session['language']);
unset($_SESSION['language']);

// 检查session变量是否已存在，以下用法是相同的：if ($session->has('language')) ...
if (isset($session['language'])) ...
if (isset($_SESSION['language'])) ...

// 遍历所有session变量，以下用法是相同的：foreach ($session as $name => $value) ...
foreach ($_SESSION as $name => $value) ...

补充: 当使用session组件访问session数据时候，如果session没有开启会自动开启，这和通过$_SESSION不同，$_SESSION要求先执行session_start()。

当session数据为数组时，session组件会限制你直接修改数据中的单元项，例如：

$session = Yii::$app->session;

// 如下代码不会生效$session['captcha']['number'] = 5;
$session['captcha']['lifetime'] = 3600;

// 如下代码会生效：$session['captcha'] = [
    'number' => 5,
    'lifetime' => 3600,
];

// 如下代码也会生效：echo $session['captcha']['lifetime'];

可使用以下任意一个变通方法来解决这个问题：

$session = Yii::$app->session;

// 直接使用$_SESSION (确保Yii::$app->session->open() 已经调用)$_SESSION['captcha']['number'] = 5;
$_SESSION['captcha']['lifetime'] = 3600;

// 先获取session数据到一个数组，修改数组的值，然后保存数组到session中$captcha = $session['captcha'];
$captcha['number'] = 5;
$captcha['lifetime'] = 3600;
$session['captcha'] = $captcha;

// 使用ArrayObject 数组对象代替数组$session['captcha'] = new \ArrayObject;
...
$session['captcha']['number'] = 5;
$session['captcha']['lifetime'] = 3600;

// 使用带通用前缀的键来存储数组$session['captcha.number'] = 5;
$session['captcha.lifetime'] = 3600;

为更好的性能和可读性，推荐最后一种方案，也就是不用存储session变量为数组，而是将每个数组项变成有相同键前缀的session变量。

自定义Session存储

yii\web\Session 类默认存储session数据为文件到服务器上，Yii提供以下session类实现不同的session存储方式：

yii\web\DbSession: 存储session数据在数据表中
yii\web\CacheSession: 存储session数据到缓存中，缓存和配置中的缓存组件相关
yii\redis\Session: 存储session数据到以redis 作为存储媒介中
yii\mongodb\Session: 存储session数据到MongoDB.

所有这些session类支持相同的API方法集，因此，切换到不同的session存储介质不需要修改项目使用session的代码。

注意: 如果通过$_SESSION访问使用自定义存储介质的session，需要确保session已经用yii\web\Session::open() 开启，这是因为在该方法中注册自定义session存储处理器。

学习如何配置和使用这些组件类请参考它们的API文档，如下为一个示例显示如何在应用配置中配置yii\web\DbSession将数据表作为session存储介质。

return [
    'components' => [
        'session' => [
            'class' => 'yii\web\DbSession',
            // 'db' => 'mydb',  // 数据库连接的应用组件ID，默认为'db'.
            // 'sessionTable' => 'my_session', // session 数据表名，默认为'session'.
        ],
    ],
];

也需要创建如下数据库表来存储session数据：

CREATE TABLE session
(
    id CHAR(40) NOT NULL PRIMARY KEY,
    expire INTEGER,
    data BLOB
)

其中'BLOB' 对应你选择的数据库管理系统的BLOB-type类型，以下一些常用数据库管理系统的BLOB类型：

MySQL: LONGBLOB
PostgreSQL: BYTEA
MSSQL: BLOB

注意: 根据php.ini 设置的 session.hash_function，你需要调整id列的长度，例如，如果 session.hash_function=sha256 ，应使用长度为64而不是40的char类型。

Flash 数据

Flash数据是一种特别的session数据，它一旦在某个请求中设置后，只会在下次请求中有效，然后该数据就会自动被删除。常用于实现只需显示给终端用户一次的信息，如用户提交一个表单后显示确认信息。

可通过session应用组件设置或访问session，例如：

$session = Yii::$app->session;

// 请求 #1// 设置一个名为"postDeleted" flash 信息$session->setFlash('postDeleted', 'You have successfully deleted your post.');

// 请求 #2// 显示名为"postDeleted" flash 信息echo $session->getFlash('postDeleted');

// 请求 #3// $result 为 false，因为flash信息已被自动删除$result = $session->hasFlash('postDeleted');

和普通session数据类似，可将任意数据存储为flash数据。

当调用yii\web\Session::setFlash()时, 会自动覆盖相同名的已存在的任何数据，为将数据追加到已存在的相同名flash中，可改为调用yii\web\Session::addFlash()。例如:

$session = Yii::$app->session;

// 请求 #1// 在名称为"alerts"的flash信息增加数据$session->addFlash('alerts', 'You have successfully deleted your post.');
$session->addFlash('alerts', 'You have successfully added a new friend.');
$session->addFlash('alerts', 'You are promoted.');

// 请求 #2// $alerts 为名为'alerts'的flash信息，为数组格式$alerts = $session->getFlash('alerts');

注意: 不要在相同名称的flash数据中使用yii\web\Session::setFlash() 的同时也使用yii\web\Session::addFlash()，因为后一个防范会自动将flash信息转换为数组以使新的flash数据可追加进来，因此，当你调用yii\web\Session::getFlash()时，会发现有时获取到一个数组，有时获取到一个字符串，取决于你调用这两个方法的顺序。

Cookies

Yii使用 yii\web\Cookie对象来代表每个cookie，yii\web\Request 和 yii\web\Response 通过名为'cookies'的属性维护一个cookie集合，前者的cookie 集合代表请求提交的cookies，后者的cookie集合表示发送给用户的cookies。

读取 Cookies

当前请求的cookie信息可通过如下代码获取：

// 从 "request"组件中获取cookie集合(yii\web\CookieCollection)$cookies = Yii::$app->request->cookies;

// 获取名为 "language" cookie 的值，如果不存在，返回默认值"en"$language = $cookies->getValue('language', 'en');

// 另一种方式获取名为 "language" cookie 的值if (($cookie = $cookies->get('language')) !== null) {
    $language = $cookie->value;
}

// 可将 $cookies当作数组使用if (isset($cookies['language'])) {
    $language = $cookies['language']->value;
}

// 判断是否存在名为"language" 的 cookieif ($cookies->has('language')) ...
if (isset($cookies['language'])) ...

发送 Cookies

You can send cookies to end users using the following code: 可使用如下代码发送cookie到终端用户：

// 从"response"组件中获取cookie 集合(yii\web\CookieCollection)$cookies = Yii::$app->response->cookies;

// 在要发送的响应中添加一个新的cookie$cookies->add(new \yii\web\Cookie([
    'name' => 'language',
    'value' => 'zh-CN',
]));

// 删除一个cookie$cookies->remove('language');
// 等同于以下删除代码unset($cookies['language']);

除了上述例子定义的 yii\web\Cookie::name 和 yii\web\Cookie::value 属性 yii\web\Cookie 类也定义了其他属性来实现cookie的各种信息，如 yii\web\Cookie::domain, yii\web\Cookie::expire 可配置这些属性到cookie中并添加到响应的cookie集合中。

注意: 为安全起见yii\web\Cookie::httpOnly 被设置为true，这可减少客户端脚本访问受保护cookie（如果浏览器支持）的风险，更多详情可阅读 httpOnly wiki article for more details.

Cookie验证

在上两节中，当通过request 和 response 组件读取和发送cookie时，你会喜欢扩展的cookie验证的保障安全功能，它能使cookie不被客户端修改。该功能通过给每个cookie签发一个哈希字符串来告知服务端cookie是否在客户端被修改，如果被修改，通过request组件的yii\web\Request::cookiescookie集合访问不到该cookie。

注意: Cookie验证只保护cookie值被修改，如果一个cookie验证失败，仍然可以通过$_COOKIE来访问该cookie，因为这是第三方库对未通过cookie验证自定义的操作方式。

Cookie验证默认启用，可以设置yii\web\Request::enableCookieValidation属性为false来禁用它，尽管如此，我们强烈建议启用它。

注意: 直接通过$_COOKIE 和 setcookie() 读取和发送的Cookie不会被验证。

当使用cookie验证，必须指定yii\web\Request::cookieValidationKey，它是用来生成s上述的哈希值，可通过在应用配置中配置request组件。

return [
    'components' => [
        'request' => [
            'cookieValidationKey' => 'fill in a secret key here',
        ],
    ],
];

补充: yii\web\Request::cookieValidationKey 对你的应用安全很重要，应只被你信任的人知晓，请不要将它放入版本控制中。