Yii2创建表单(ActiveForm)

时间:2022-10-20 20:23:23
由于表单涉及到一些验证方面的信息,属性设置又比较多、比较复杂,所以哪里有什么不正确的地方请留言指点

目录
  • 表单的生成
  • 表单中的方法
    • ActiveForm::begin()方法
    • ActiveForm::end()方法
    • getClientOptions()方法
    • 其它方法:errorSummary、validate、validateMultiple
  • 表单中的参数
    • 表单form自身的属性
    • 表单中各个项(field)输入框相关的属性
      • $fieldConfig
      • 关于验证的属性
      • 关于每个field容器样式的属性
    • ajax验证
    • 前端js事件
    • 表单中的其它属性
我们先看看Yii里面最简单的登录表单以及生成的html代码和界面,先有个直观的了解
  1. <?php $form = ActiveForm::begin(['id' => 'login-form']); ?>
  2.    <?= $form->field($model, 'username') ?>
  3.    <?= $form->field($model, 'password')->passwordInput() ?>
  4.    <?= $form->field($model, 'rememberMe')->checkbox() ?>
  5.    <div style="color:#999;margin:1em 0">
  6.       If you forgot your password you can <?= Html::a('reset it', ['site/request-password-reset']) ?>
  7.    </div>
  8.    <div class="form-group">
  9.          <?= Html::submitButton('Login', ['class' => 'btn btn-primary', 'name' => 'login-button']) ?>
  10.    </div>
  11. <?php ActiveForm::end(); ?>
下面是生成的表单Html,我在里面标明了5部分。

1、表单的生成
在Yii中表单即ActiveForm也是Widget,在上面可以看到是由begin开始
  1. <?php $form = ActiveForm::begin(['id' => 'login-form']); ?>
中间为各个项的输入框,最后由end结尾
  1. <?php ActiveForm::end(); ?>

2、表单中的方法
在Widget中 begin()方法会调用 int方法
  1. public function init()
在最后的 end()方法会调用 run方法
  1. public function run()
1、ActiveForm::begin()方法
  1. //这个是在执行 $form = ActiveForm::begin(['id' => 'login-form']); 中的begin方法的时候调用的
  2. public function init()
  3. {
  4.          //设置表单元素form的id
  5.         if (!isset($this->options['id'])) {
  6.             $this->options['id'] = $this->getId();
  7.         }
  8.         //设置表单中间的要生成各个field的所使用的类
  9.         if (!isset($this->fieldConfig['class'])) {
  10.             $this->fieldConfig['class'] = ActiveField::className();
  11.         }
  12.         //这个就是输出表单的开始标签
  13.         //如:<form id="login-form" action="/lulublog/frontend/web/index.php?r=site/login" method="post">
  14.         echo Html::beginForm($this->action, $this->method, $this->options);
  15. }

2、ActiveForm::end()方法
  1. //这个是在执行 ActiveForm::end(); 中的end方法的时候调用的
  2. public function run()
  3. {
  4.         //下面这个就是往视图中注册表单的js验证脚本,
  5.         if (!empty($this->attributes)) {
  6.             $id = $this->options['id'];
  7.             $options = Json::encode($this->getClientOptions());
  8.             $attributes = Json::encode($this->attributes);
  9.             $view = $this->getView();
  10.             ActiveFormAsset::register($view);
  11.             /*
  12.              * $attributes:为要验证的所有的field数组。它的值是在activeform中创建field的时候,在field的begin方法中给它赋值的。
  13.              * 其中每个field又是一个数组,为这个field的各个参数
  14.              * 比如username的field中的参数有
  15.              * validate、id、name、
  16.              * validateOnChange、validateOnType、validationDelay、
  17.              * container、input、error
  18.              *
  19.              * $options:为这个表单整体的属性,如:
  20.              * errorSummary、validateOnSubmit、
  21.              * errorCssClass、successCssClass、validatingCssClass、
  22.              * ajaxParam、ajaxDataType
  23.              */
  24.             
  25.             $view->registerJs("jQuery('#$id').yiiActiveForm($attributes, $options);");
  26.         }
  27.         //输出表单的结束标签
  28.         echo Html::endForm();
  29. }
3、getClientOptions()方法
  1. /*
  2. * 设置表单的全局的一些样式属性以及js回调事件等
  3. */
  4. protected function getClientOptions()
  5. {
  6.         $options = [
  7.             'errorSummary' => '.' . $this->errorSummaryCssClass,
  8.             'validateOnSubmit' => $this->validateOnSubmit,
  9.             'errorCssClass' => $this->errorCssClass,
  10.             'successCssClass' => $this->successCssClass,
  11.             'validatingCssClass' => $this->validatingCssClass,
  12.             'ajaxParam' => $this->ajaxParam,
  13.             'ajaxDataType' => $this->ajaxDataType,
  14.         ];
  15.         if ($this->validationUrl !== null) {
  16.             $options['validationUrl'] = Url::to($this->validationUrl);
  17.         }
  18.         foreach (['beforeSubmit', 'beforeValidate', 'afterValidate'] as $name) {
  19.             if (($value = $this->$name) !== null) {
  20.                 $options[$name] = $value instanceof JsExpression ? $value : new JsExpression($value);
  21.             }
  22.         }

  23.         return $options;
  24. }
下面这个是生成的表单验证Js代码
  1. jQuery(document).ready(function () {
  2.         jQuery('#login-form').yiiActiveForm(
  3.         {
  4.                 "username":{
  5.                         "validate":function (attribute, value, messages) {
  6.                                 yii.validation.required(value, messages, {"message":"Username cannot be blank."});
  7.                         },
  8.                         "id":"loginform-username",
  9.                         "name":"username",
  10.                         "validateOnChange":true,
  11.                         "validateOnType":false,
  12.                         "validationDelay":200,
  13.                         "container":".field-loginform-username",
  14.                         "input":"#loginform-username",
  15.                         "error":".help-block"},
  16.                 "password":{
  17.                         "validate":function (attribute, value, messages) {
  18.                                 yii.validation.required(value, messages, {"message":"Password cannot be blank."});
  19.                         },
  20.                         "id":"loginform-password",
  21.                         "name":"password",
  22.                         "validateOnChange":true,
  23.                         "validateOnType":false,
  24.                         "validationDelay":200,
  25.                         "container":".field-loginform-password",
  26.                         "input":"#loginform-password",
  27.                         "error":".help-block"
  28.                         },

  29.                 "rememberMe":{
  30.                         "validate":function (attribute, value, messages) {
  31.                                 yii.validation.boolean(value, messages, {
  32.                                         "trueValue":"1","falseValue":"0","message":"Remember Me must be either \"1\" or \"0\".","skipOnEmpty":1});
  33.                         },
  34.                         "id":"loginform-rememberme",
  35.                         "name":"rememberMe","validateOnChange":true,
  36.                         "validateOnType":false,
  37.                         "validationDelay":200,
  38.                         "container":".field-loginform-rememberme",
  39.                         "input":"#loginform-rememberme",
  40.                         "error":".help-block"}
  41.         },
  42.         {
  43.                 "errorSummary":".error-summary",
  44.                 "validateOnSubmit":true,
  45.                 "errorCssClass":"has-error",
  46.                 "successCssClass":"has-success",
  47.                 "validatingCssClass":"validating",
  48.                 "ajaxParam":"ajax",
  49.                 "ajaxDataType":"json"
  50.         });
  51. });
4、其它方法:errorSummary、validate、validateMultiple
  1. public function errorSummary($models, $options = [])
它主要就是把model中的所有的错误信息汇总到一个div中。
  1. public static function validate($model, $attributes = null)
  2. public static function validateMultiple($models, $attributes = null)
这两个是获取错误信息的方法,比较简单也不说了。

3、表单中的参数

1、表单form自身的属性
  • $action:设置当前表单提交的url地址,如果为空则是当前的url
  • $method:提交方法,post或者get,默认为post
  • $option:这个里面设置表单的其它的属性,如id等,如果没有设置id,将会自动生成一个以$autoIdPrefix为前缀的自动增加的id
    1.     //这个方法在Widget基本中
    2.     public function getId($autoGenerate = true)
    3.     {
    4.         if ($autoGenerate && $this->_id === null) {
    5.             $this->_id = self::$autoIdPrefix . self::$counter++;
    6.         }

    7.         return $this->_id;
    8.     }
2、表单中各个项(field)输入框相关的属性

Yii生成的每个field由4部分组成:
  • 最外层div为每个field的容器,
  • label为每个field的文本说明,
  • input为输入元素,
  • 还有一个div为错误提示信息。
  1. <div class="form-group field-loginform-username required has-error">
  2.         <label class="control-label" for="loginform-username">Username</label>
  3.         <input type="text" id="loginform-username" class="form-control" name="LoginForm[username]">
  4.         <div class="help-block">Username cannot be blank.</div>
  5. </div>
$fieldConfig:这个是所有的field的统一的配置信息设置的属性。也就是说在field类中的属性都可以在这里进行设置。
  1. public function field($model, $attribute, $options = [])
  2. {
  3.         //使用fieldConfig和options属性来创建field
  4.         //$options会覆盖统一的fieldConfig属性值,以实现每个field的自定义
  5.         return Yii::createObject(array_merge($this->fieldConfig, $options, [
  6.             'model' => $model,
  7.             'attribute' => $attribute,
  8.             'form' => $this,
  9. ]));
  10. }
关于验证的属性:
  • $enableClientValidation:是否在客户端验证,也即是否生成前端js验证脚本(如果在form中设置了ajax验证,也会生成这个js脚本)。
  • $enableAjaxValidation:是否是ajax验证
  • $validateOnChange:在输入框失去焦点并且值改变的时候验证
  • $validateOnType:正在输入的时候就进行验证
  • $validationDelay:验证延迟的时间,单位为毫秒
这5个属性都可以在创建每个field的时候单独设置,因为在field类中就有这5个属性。

关于每个field容器样式的属性:
  • $requiredCssClass:必填项的样式,默认为‘required’
  • $errorCssClass:验证错误的样式,默认值为‘has-error’
  • $successCssClass:验证正确的样式,默认值为‘has-success’
  • $validatingCssClass:验证过程中的样式,默认值为‘validating’
3、ajax验证
  • $validationUrl:ajax验证的url地方
  • $ajaxParam:url中的get参数,用来标明当前是ajax请求,默认值为‘ajax’
  • $ajaxDataType:ajax请求返回的数据格式
4、前端js事件属性
  • $beforeSubmit:在提交表单之前事件,如果返回false,则不会提交表单,格式为:
    1. function ($form) {
    2.   ...return false to cancel submission...
    3. }
  • $beforeValidate:在每个属性在验证之前触发,格式为:
    1. function ($form, attribute, messages) {
    2.   ...return false to cancel the validation...
    3. }
  • $afterValidate:在每个属性在验证之后触发,格式为:
    1. function ($form, attribute, messages) {
    2. }
5、表单中的其它属性
  • $validateOnSubmit:提交表单的时候进行验证
  • $errorSummary:总的错误提示地方的样式
  • $attributes:这个属性比较特殊,它是在创建field的时候,在field中为这个form中的$attributes赋值的。这样可以确保通过field方法生成的输入表单都可以进行验证