Yii2のフォーム作成(ActiveForm)方法の詳細説明

この記事の例では、Yii2でフォーム(ActiveForm)を作成する方法を説明します。参考までに皆さんと共有してください。詳細は次のとおりです:

フォームにはいくつかの検証情報が含まれており、属性設定はより複雑で複雑なので、何か間違っている場合はメッセージを残して指摘してください

テーブルコンテンツ

フォームの生成

フォーム内のメソッド
ActiveForm::begin() メソッド
ActiveForm::end() メソッド
getClientOptions() メソッド
その他のメソッド: errorsummary、validate、validateMultiple

フォーム内のパラメーター
フォームフォーム自体のプロパティ
$fieldConfigの各項目(フィールド)入力ボックスに関連するフォーム属性
検証属性について
各フィールドコンテナスタイルの属性について
Ajax検証
フロントエンドjsイベント
フォーム内のその他の属性

まず Yii の最も一般的な属性を見てみましょう まず、簡単なログインフォームと生成された HTML コードとインターフェースを直観的に理解しましょう

<?php $form = ActiveForm::begin([&#39;id&#39; => &#39;login-form&#39;]); ?>
  <?= $form->field($model, &#39;username&#39;) ?>
  <?= $form->field($model, &#39;password&#39;)->passwordInput() ?>
  <?= $form->field($model, &#39;rememberMe&#39;)->checkbox() ?>
  <div style="color:#999;margin:1em 0">
   If you forgot your password you can <?= Html::a(&#39;reset it&#39;, [&#39;site/request-password-reset&#39;]) ?>
  </div>
  <div class="form-group">
     <?= Html::submitButton(&#39;Login&#39;, [&#39;class&#39; => &#39;btn btn-primary&#39;, &#39;name&#39; => &#39;login-button&#39;]) ?>
  </div>
<?php ActiveForm::end(); ?>

以下は生成されたフォームの HTML で、その中の 5 つの部分にマークを付けました。

1. フォームの生成

Yii では、フォームは ActiveForm とウィジェットの両方です。上でわかるように、begin

<?php $form = ActiveForm::begin([&#39;id&#39; => &#39;login-form&#39;]); ?>

で始まり、最後に end で終わります。

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

2. フォームメソッド

ウィジェットでは、begin() メソッドが int メソッド

public function init()

を呼び出します。最後の end() メソッドでは、run メソッドが

public function run()

1 と呼ばれます。 ) メソッド

//这个是在执行 $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 = [])

主にモデル内のすべてのエラー情報を div に要約します。

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

これら 2 つはエラー情報を取得する方法であり、比較的簡単なので詳細は説明しません。

3. フォーム内のパラメータ

1. フォーム自体の属性

$action: 現在のフォーム送信の URL アドレスを設定します。空の場合は、現在の URL です

$method: 送信メソッド、投稿または 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. フォーム内の各項目 フィールド入力ボックスに関連する属性

Yii によって生成される各フィールドは 4 つの部分で構成されます:

① 一番外側の div は各フィールドのコンテナです。

② label は各フィールドのテキスト説明です。

③ input 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: 全フィールドの統一設定情報により設定される属性です。つまり、フィールドクラスの属性をここで設定できます。

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検証スクリプトを生成するかどうか(フォームでajax検証が設定されている場合はこれjs スクリプトも生成されます)。

② $enableAjaxValidation: ajax 検証であるかどうか

③ $validateOnChange: 入力ボックスがフォーカスを失い、値が変更されたときに検証する
④ $validateOnType: 入力時に検証する
⑤ $validationDelay: 検証遅延時間 (ミリ秒単位)

これら 5 つの属性フィールド クラスにはこれら 5 つの属性があるため、各フィールドを作成するときに個別に設定できます。

各フィールドコンテナスタイルの属性について:

$requiredCssClass: 必須項目のスタイル、デフォルトは「required」です

$errorCssClass: 検証エラーのスタイル、デフォルト値は「has-error」です

$successCssClass : 検証は正しいです スタイル、デフォルト値は 'has-success' です
$validatingCssClass: 検証プロセス中のスタイル、デフォルト値は 'validating' です

3、ajax 検証

$validationUrl: ajax の URL の場所verify

$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: この属性は非常に特殊で、フィールドを作成するときに使用されます。このフォームの $attributes にはフィールド内の値が割り当てられます。これにより、フィールドメソッドで生成された入力フォームを確実に検証できるようになります

この記事が、Yii フレームワークに基づいた PHP プログラムの設計に皆様のお役に立てれば幸いです。

Yii2の作成フォーム(ActiveForm)メソッドの詳しい解説はPHP中国語サイトをご覧ください！