# 创建表单
在 Yii 中使用表单的主要方式是通过 yii\widgets\ActiveForm。如果是基于模型的表单应首选这种方式。此外,在 yii\helpers\Html 中也有一些实用的方法用于添加按钮和帮助文本。
在客户端上显示的表单,大多数情况下有一个相应的[模型](http://www.yiichina.com/doc/guide/2.0/structure-models),用来验证其输入的服务器数据 (可在 [输入验证](http://www.yiichina.com/doc/guide/2.0/input-validation) 一节获取关于验证的细节)。 当创建基于模型的表单时,第一步是定义模型本身。该模式可以是一个基于[活动记录](http://www.yiichina.com/doc/guide/2.0/db-active-record)的类,表示数据库中的数据, 也可以是一个基于通用模型的类(继承自 yii\base\Model ),来获取任意的输入数据,如登录表单。 在下面的例子中,我们展示了一个用来做登录表单的通用模型:
~~~
<?php
class LoginForm extends \yii\base\Model
{
public $username;
public $password;
public function rules()
{
return [
// 在这里定义验证规则
];
}
}
~~~
在控制器中,我们将传递一个模型的实例到视图,其中 yii\widgets\ActiveForm 小部件用来显示表单:
~~~
<?php
use yii\helpers\Html;
use yii\widgets\ActiveForm;
$form = ActiveForm::begin([
'id' => 'login-form',
'options' => ['class' => 'form-horizontal'],
]) ?>
<?= $form->field($model, 'username') ?>
<?= $form->field($model, 'password')->passwordInput() ?>
<div class="form-group">
<div class="col-lg-offset-1 col-lg-11">
<?= Html::submitButton('Login', ['class' => 'btn btn-primary']) ?>
</div>
</div>
<?php ActiveForm::end() ?>
~~~
在上面的代码中,yii\widgets\ActiveForm::begin() 不仅创建了一个表单实例,同时也标志着表单的开始。 放在 yii\widgets\ActiveForm::begin() 与 yii\widgets\ActiveForm::end() 之间的所有内容都被包裹在 HTML 的 `<form>` 标签中。 与任何小部件一样,你可以指定一些选项,通过传递数组到 `begin` 方法中来配置该小部件。在这种情况下, 一个额外的 CSS 类和 ID 会在`<form>` 标签中使用。要查看所有可用的选项,请参阅 API 文档的 yii\widgets\ActiveForm。
为了在表单中创建表单元素与元素的标签,以及任何适用的 JavaScript 验证,yii\widgets\ActiveForm::field() 方法在调用时,会返回一个 yii\widgets\ActiveField 的实例。 直接输出该方法时,结果是一个普通的(文本)输入。要自定义输出,可以附加上 yii\widgets\ActiveField 的其它方法来一起调用:
~~~
// 一个密码输入框
<?= $form->field($model, 'password')->passwordInput() ?>
// 增加一个提示标签
<?= $form->field($model, 'username')->textInput()->hint('Please enter your name')->label('Name') ?>
// 创建一个 HTML5 邮箱输入框
<?= $form->field($model, 'email')->input('email') ?>
~~~
它会通过在 yii\widgets\ActiveField::$template 中定义的表单字段来创建 `<label>`,`<input>` 以及其它的标签。 input 输入框的 name 属性会自动地根据 yii\base\Model::formName() 以及属性名来创建。 例如,对于在上面的例子中 `username` 输入字段的 name 属性将是 `LoginForm[username]`。 这种命名规则使所有属性的数组的登录表单在服务器端的 `$_POST['LoginForm']` 数组中是可用的。
指定模型的属性可以以更复杂的方式来完成。例如,当上传时,多个文件或选择多个项目的属性,可能需要一个数组值, 你可以通过附加 `[]` 来指定它的属性名称:
~~~
// 允许多个文件被上传:
echo $form->field($model, 'uploadFile[]')->fileInput(['multiple'=>'multiple']);
// 允许进行选择多个项目:
echo $form->field($model, 'items[]')->checkboxList(['a' => 'Item A', 'b' => 'Item B', 'c' => 'Item C']);
~~~
命名表单元素,如提交按钮时要小心。在 [jQuery 文档](https://api.jquery.com/submit/) 中有一些保留的名称,可能会导致冲突:
> 表单和它们的子元素不应该使用与表单的属性冲突的 input name 或 id,例如 `submit`,`length`,或者 `method`。 要检查你的标签是否存在这些问题,一个完整的规则列表详见 [DOMLint](http://kangax.github.io/domlint/)。
额外的 HTML 标签可以使用纯 HTML 或者 yii\helpers\Html-辅助类中的方法来添加到表单中,就如上面例子中的 yii\helpers\Html::submitButton()。
> 提示: 如果你正在你的应用程序中使用 Twitter Bootstrap CSS 你可以使用yii\bootstrap\ActiveForm 来代替 yii\widgets\ActiveForm。 前者继承自后者并在生成表单字段时使用 Bootstrap 特有的样式。
> 提示:为了设计带星号的表单字段,你可以使用下面的 CSS:
>
> ~~~
> div.required label:after {
> content: " *";
> color: red;
> }
> ~~~
## 创建下拉列表
可以使用 ActiveForm 的 [dropDownList()](http://www.yiiframework.com/doc-2.0/yii-widgets-activefield.html#dropDownList()-detail) 方法来创建一个下拉列表:
~~~
use app\models\ProductCategory;
use yii\helpers\ArrayHelper;
/* @var $this yii\web\View */
/* @var $form yii\widgets\ActiveForm */
/* @var $model app\models\Product */
echo $form->field($model, 'product_category')->dropdownList(
ProductCategory::find()->select(['category_name', 'id'])->indexBy('id')->column(),
['prompt'=>'Select Category']
);
~~~
模型字段的值将被自动预先选定。
## 延伸阅读
下一节 [输入验证](http://www.yiichina.com/doc/guide/2.0/input-validation) 处理提交的表单数据的服务器端验证,以及 ajax- 和客户端验证。
要学会有关表格的更复杂的用法,你可以查看以下几节:
* [收集列表输入](http://www.yiichina.com/doc/guide/2.0/input-tabular-input) 同一种类型的多个模型的采集数据。
* [多模型同时输入](http://www.yiichina.com/doc/guide/2.0/input-multiple-models) 在同一窗口中处理多个不同的模型。
* [文件上传](http://www.yiichina.com/doc/guide/2.0/input-file-upload) 如何使用表格来上传文件。
- 介绍(Introduction)
- 关于 Yii(About Yii)
- 从 Yii 1.1 升级(Upgrading from Version 1.1)
- 入门(Getting Started)
- 安装 Yii(Installing Yii)
- 运行应用(Running Applications)
- 第一次问候(Saying Hello)
- 使用 Forms(Working with Forms)
- 玩转 Databases(Working with Databases)
- 用 Gii 生成代码(Generating Code with Gii)
- 更上一层楼(Looking Ahead)
- 应用结构(Application Structure)
- 结构概述(Overview)
- 入口脚本(Entry Scripts)
- 应用(Applications)
- 应用组件(Application Components)
- 控制器(Controllers)
- 模型(Models)
- 视图(Views)
- 模块(Modules)
- 过滤器(Filters)
- 小部件(Widgets)
- 前端资源(Assets)
- 扩展(Extensions)
- 请求处理(Handling Requests)
- 运行概述(Overview)
- 引导(Bootstrapping)
- 路由引导与创建 URL(Routing and URL Creation)
- 请求(Requests)
- 响应(Responses)
- Sessions and Cookies
- 错误处理(Handling Errors)
- 日志(Logging)
- 关键概念(Key Concepts)
- 组件(Components)
- 属性(Properties)
- 事件(Events)
- 行为(Behaviors)
- 配置(Configurations)
- 别名(Aliases)
- 类自动加载(Class Autoloading)
- 服务定位器(Service Locator)
- 依赖注入容器(Dependency Injection Container)
- 配合数据库工作(Working with Databases)
- 数据库访问(Data Access Objects): 数据库连接、基本查询、事务和模式操作
- 查询生成器(Query Builder): 使用简单抽象层查询数据库
- 活动记录(Active Record): 活动记录对象关系映射(ORM),检索和操作记录、定义关联关系
- 数据库迁移(Migrations): 在团体开发中对你的数据库使用版本控制
- Sphinx
- Redis
- MongoDB
- ElasticSearch
- 接收用户数据(Getting Data from Users)
- 创建表单(Creating Forms)
- 输入验证(Validating Input)
- 文件上传(Uploading Files)
- 收集列表输入(Collecting Tabular Input)
- 多模型同时输入(Getting Data for Multiple Models)
- 显示数据(Displaying Data)
- 格式化输出数据(Data Formatting)
- 分页(Pagination)
- 排序(Sorting)
- 数据提供器(Data Providers)
- 数据小部件(Data Widgets)
- 操作客户端脚本(Working with Client Scripts)
- 主题(Theming)
- 安全(Security)
- 认证(Authentication)
- 授权(Authorization)
- 处理密码(Working with Passwords)
- 客户端认证(Auth Clients)
- 安全领域的最佳实践(Best Practices)
- 缓存(Caching)
- 概述(Overview)
- 数据缓存(Data Caching)
- 片段缓存(Fragment Caching)
- 分页缓存(Page Caching)
- HTTP 缓存(HTTP Caching)
- RESTful Web 服务
- 快速入门(Quick Start)
- 资源(Resources)
- 控制器(Controllers)
- 路由(Routing)
- 格式化响应(Response Formatting)
- 授权验证(Authentication)
- 速率限制(Rate Limiting)
- 版本化(Versioning)
- 错误处理(Error Handling)
- 开发工具(Development Tools)
- 调试工具栏和调试器(Debug Toolbar and Debugger)
- 使用 Gii 生成代码(Generating Code using Gii)
- TBD 生成 API 文档(Generating API Documentation)
- 测试(Testing)
- 概述(Overview)
- 搭建测试环境(Testing environment setup)
- 单元测试(Unit Tests)
- 功能测试(Functional Tests)
- 验收测试(Acceptance Tests)
- 测试夹具(Fixtures)
- 高级专题(Special Topics)
- 高级应用模版(Advanced Project Template)
- 从头构建自定义模版(Building Application from Scratch)
- 控制台命令(Console Commands)
- 核心验证器(Core Validators)
- 国际化(Internationalization)
- 收发邮件(Mailing)
- 性能优化(Performance Tuning)
- 共享主机环境(Shared Hosting Environment)
- 模板引擎(Template Engines)
- 集成第三方代码(Working with Third-Party Code)
- 小部件(Widgets)
- Bootstrap 小部件(Bootstrap Widgets)
- jQuery UI 小部件(jQuery UI Widgets)
- 助手类(Helpers)
- 助手一览(Overview)
- Array 助手(ArrayHelper)
- Html 助手(Html)
- Url 助手(Url)