欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Yii2创建表单(ActiveForm)方法详解

程序员文章站 2024-04-02 17:12:10
本文实例讲述了yii2创建表单(activeform)的方法。分享给大家供大家参考,具体如下: 由于表单涉及到一些验证方面的信息,属性设置又比较多、比较复杂,所以哪里有什...

本文实例讲述了yii2创建表单(activeform)的方法。分享给大家供大家参考,具体如下:

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

目录

表单的生成

表单中的方法
  activeform::begin()方法
  activeform::end()方法
  getclientoptions()方法
  其它方法:errorsummary、validate、validatemultiple

表单中的参数
  表单form自身的属性
  表单中各个项(field)输入框相关的属性
    $fieldconfig
    关于验证的属性
    关于每个field容器样式的属性
  ajax验证
  前端js事件
  表单中的其它属性

我们先看看yii里面最简单的登录表单以及生成的html代码和界面,先有个直观的了解

<?php $form = activeform::begin(['id' => 'login-form']); ?>
  <?= $form->field($model, 'username') ?>
  <?= $form->field($model, 'password')->passwordinput() ?>
  <?= $form->field($model, 'rememberme')->checkbox() ?>
  <div style="color:#999;margin:1em 0">
   if you forgot your password you can <?= html::a('reset it', ['site/request-password-reset']) ?>
  </div>
  <div class="form-group">
     <?= html::submitbutton('login', ['class' => 'btn btn-primary', 'name' => 'login-button']) ?>
  </div>
<?php activeform::end(); ?>

下面是生成的表单html,我在里面标明了5部分。

1、表单的生成

在yii中表单即activeform也是widget,在上面可以看到是由begin开始

<?php $form = activeform::begin(['id' => 'login-form']); ?>

中间为各个项的输入框,最后由end结尾

<?php activeform::end(); ?>

2、表单中的方法

在widget中begin()方法会调用int方法

public function init()

在最后的end()方法会调用run方法

public function run()

1、activeform::begin()方法

//这个是在执行 $form = activeform::begin(['id' => 'login-form']); 中的begin方法的时候调用的
public function init()
{
    //设置表单元素form的id
    if (!isset($this->options['id'])) {
      $this->options['id'] = $this->getid();
    }
    //设置表单中间的要生成各个field的所使用的类
    if (!isset($this->fieldconfig['class'])) {
      $this->fieldconfig['class'] = activefield::classname();
    }
    //这个就是输出表单的开始标签
    //如:<form id="login-form" action="/lulublog/frontend/web/index.php?r=site/login" method="post">
    echo html::beginform($this->action, $this->method, $this->options);
}

2、activeform::end()方法

//这个是在执行 activeform::end(); 中的end方法的时候调用的
public function run()
{
    //下面这个就是往视图中注册表单的js验证脚本,
    if (!empty($this->attributes)) {
      $id = $this->options['id'];
      $options = json::encode($this->getclientoptions());
      $attributes = json::encode($this->attributes);
      $view = $this->getview();
      activeformasset::register($view);
      /*
       * $attributes:为要验证的所有的field数组。它的值是在activeform中创建field的时候,在field的begin方法中给它赋值的。
       * 其中每个field又是一个数组,为这个field的各个参数
       * 比如username的field中的参数有
       * validate、id、name、
       * validateonchange、validateontype、validationdelay、
       * container、input、error
       * 
       * $options:为这个表单整体的属性,如:
       * errorsummary、validateonsubmit、
       * errorcssclass、successcssclass、validatingcssclass、
       * ajaxparam、ajaxdatatype
       */
      $view->registerjs("jquery('#$id').yiiactiveform($attributes, $options);");
    }
    //输出表单的结束标签
    echo html::endform();
}

3、getclientoptions()方法

/*
* 设置表单的全局的一些样式属性以及js回调事件等
*/
protected function getclientoptions()
{
    $options = [
      'errorsummary' => '.' . $this->errorsummarycssclass,
      'validateonsubmit' => $this->validateonsubmit,
      'errorcssclass' => $this->errorcssclass,
      'successcssclass' => $this->successcssclass,
      'validatingcssclass' => $this->validatingcssclass,
      'ajaxparam' => $this->ajaxparam,
      'ajaxdatatype' => $this->ajaxdatatype,
    ];
    if ($this->validationurl !== null) {
      $options['validationurl'] = url::to($this->validationurl);
    }
    foreach (['beforesubmit', 'beforevalidate', 'aftervalidate'] as $name) {
      if (($value = $this->$name) !== null) {
        $options[$name] = $value instanceof jsexpression ? $value : new jsexpression($value);
      }
    }
    return $options;
}

下面这个是生成的表单验证js代码

jquery(document).ready(function () {
    jquery('#login-form').yiiactiveform(
    {
        "username":{
            "validate":function (attribute, value, messages) {
                yii.validation.required(value, messages, {"message":"username cannot be blank."});
            },
            "id":"loginform-username",
            "name":"username",
            "validateonchange":true,
            "validateontype":false,
            "validationdelay":200,
            "container":".field-loginform-username",
            "input":"#loginform-username",
            "error":".help-block"},
        "password":{
            "validate":function (attribute, value, messages) {
                yii.validation.required(value, messages, {"message":"password cannot be blank."});
            },
            "id":"loginform-password",
            "name":"password",
            "validateonchange":true,
            "validateontype":false,
            "validationdelay":200,
            "container":".field-loginform-password",
            "input":"#loginform-password",
            "error":".help-block"
            },
        "rememberme":{
            "validate":function (attribute, value, messages) {
                yii.validation.boolean(value, messages, {
                    "truevalue":"1","falsevalue":"0","message":"remember me must be either \"1\" or \"0\".","skiponempty":1});
            },
            "id":"loginform-rememberme",
            "name":"rememberme","validateonchange":true,
            "validateontype":false,
            "validationdelay":200,
            "container":".field-loginform-rememberme",
            "input":"#loginform-rememberme",
            "error":".help-block"}
    }, 
    {
        "errorsummary":".error-summary",
        "validateonsubmit":true,
        "errorcssclass":"has-error",
        "successcssclass":"has-success",
        "validatingcssclass":"validating",
        "ajaxparam":"ajax",
        "ajaxdatatype":"json"
    });
});

4、其它方法:errorsummary、validate、validatemultiple

public function errorsummary($models, $options = [])

它主要就是把model中的所有的错误信息汇总到一个div中。

public static function validate($model, $attributes = null)
public static function validatemultiple($models, $attributes = null)

这两个是获取错误信息的方法,比较简单也不说了。

3、表单中的参数

1、表单form自身的属性

$action:设置当前表单提交的url地址,如果为空则是当前的url
$method:提交方法,post或者get,默认为post
$option:这个里面设置表单的其它的属性,如id等,如果没有设置id,将会自动生成一个以$autoidprefix为前缀的自动增加的id

//这个方法在widget基本中
public function getid($autogenerate = true)
{
    if ($autogenerate && $this->_id === null) {
      $this->_id = self::$autoidprefix . self::$counter++;
    }
    return $this->_id;
}

2、表单中各个项(field)输入框相关的属性

yii生成的每个field由4部分组成:

① 最外层div为每个field的容器,
② label为每个field的文本说明,
③ input为输入元素,
④ 还有一个div为错误提示信息。

<div class="form-group field-loginform-username required has-error">
    <label class="control-label" for="loginform-username">username</label>
    <input type="text" id="loginform-username" class="form-control" name="loginform[username]">
    <div class="help-block">username cannot be blank.</div>
</div>

$fieldconfig:这个是所有的field的统一的配置信息设置的属性。也就是说在field类中的属性都可以在这里进行设置。

public function field($model, $attribute, $options = [])
{
    //使用fieldconfig和options属性来创建field
    //$options会覆盖统一的fieldconfig属性值,以实现每个field的自定义
    return yii::createobject(array_merge($this->fieldconfig, $options, [
      'model' => $model,
      'attribute' => $attribute,
      'form' => $this,
]));
}

关于验证的属性:

① $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,则不会提交表单,格式为:

function ($form) {
 ...return false to cancel submission...
}

$beforevalidate:在每个属性在验证之前触发,格式为:

function ($form, attribute, messages) {
 ...return false to cancel the validation...
}

$aftervalidate:在每个属性在验证之后触发,格式为:

function ($form, attribute, messages) {
}

5、表单中的其它属性

$validateonsubmit:提交表单的时候进行验证
$errorsummary:总的错误提示地方的样式
$attributes:这个属性比较特殊,它是在创建field的时候,在field中为这个form中的$attributes赋值的。这样可以确保通过field方法生成的输入表单都可以进行验证

更多关于yii相关内容感兴趣的读者可查看本站专题:《yii框架入门及常用技巧总结》、《php优秀开发框架总结》、《smarty模板入门基础教程》、《php面向对象程序设计入门教程》、《php字符串(string)用法总结》、《php+mysql数据库操作入门教程》及《php常见数据库操作技巧汇总

希望本文所述对大家基于yii框架的php程序设计有所帮助。