본 글의 예시에서는 Yii2에서 폼(ActiveForm)을 생성하는 방법을 설명합니다. 참고하실 수 있도록 공유해 드리며, 세부 내용은 다음과 같습니다.
양식에 일부 확인 정보가 포함되어 있고 속성 설정도 많고 복잡하므로 잘못된 내용이 있으면 메시지를 남겨주세요
디렉터리
양식 생성
양식의 메서드
ActiveForm::begin() 메서드
ActiveForm::end() 메서드
getClientOptions() method
기타 메소드: errorSummary, verify, verifyMultiple
양식 내 매개변수
양식 자체의 속성
양식 내 각 항목(필드)의 입력 상자와 관련된 속성
$fieldConfig
유효성 검사 속성에 대해
각 필드 컨테이너 스타일의 속성에 대해
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이자 위젯입니다. 위에서 볼 수 있듯이 시작
<?php $form = ActiveForm::begin(['id' => 'login-form']); ?>
중간에는 마지막으로 end
<?php ActiveForm::end(); ?>
로 끝납니다. 2. 형식의 메서드
위젯에서 start() 메서드는 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, verify, verifyMultiple
public function errorSummary($models, $options = [])
주로 모델의 모든 오류 정보를 div로 요약합니다.
public static function validate($model, $attributes = null) public static function validateMultiple($models, $attributes = null)
이 두 가지 방법은 오류 정보를 얻는 방법으로 비교적 간단하므로 자세히 설명하지 않겠습니다.
3. 양식의 매개변수
1. 양식 자체의 속성
$action: 현재 양식 제출의 URL 주소를 설정합니다.
$method: 제출 방법, post 또는 get, 기본값은 post
$option: ID 등 양식의 기타 속성을 설정합니다. ID가 설정되지 않은 경우 자동으로 설정됩니다. $autoIdPrefix로 접두어 생성
//这个方法在Widget基本中 public function getId($autoGenerate = true) { if ($autoGenerate && $this->_id === null) { $this->_id = self::$autoIdPrefix . self::$counter++; } return $this->_id; }
2. 양식
각 항목(필드)의 입력란과 관련된 속성입니다. Yii에서 생성된 필드는 4부분으로 구성됩니다. 구성:
① 가장 바깥쪽 div는 각 필드의 컨테이너이고,
② 레이블은 각 필드의 텍스트 설명이고,
3 input은 입력 요소입니다.
IV 또 다른 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 검증 여부
3 $validateOnChange: 입력 상자가 포커스를 잃고 값이 변경될 때 검증
4 $validateOnType: 입력 시 검증
⑤ $validationDelay: 검증 지연 시간 , 단위는 밀리초
이 5가지 속성은 필드 클래스에서 사용할 수 있으므로 각 필드를 생성할 때 개별적으로 설정할 수 있습니다.
각 필드 컨테이너 스타일의 속성 정보:
$requiredCssClass: 필수 항목의 스타일, 기본값은 'required'
$errorCssClass: 검증 오류의 스타일, 기본값 값은 'has-error'
$successCssClass: 올바른 스타일을 확인합니다. 기본값은 'has-success'입니다.
$validatingCssClass: 확인 프로세스 중 스타일, 기본값은 'validating'입니다
3, ajax 확인
$validationUrl: ajax 확인을 위한 URL 위치
$ajaxParam: 현재 ajax 요청을 나타내는 데 사용되는 URL의 매개변수 가져오기, 기본값은 'ajax'
$ajaxDataType: ajax 요청 반환 데이터 형식
4. Front-end js 이벤트 속성
$beforeSubmit: 양식을 제출하기 전의 이벤트 false가 반환되면 양식이 반환되지 않습니다. 제출된 형식은
function ($form) { ...return false to cancel submission... }
$beforeValidate: 각 속성이 검증되기 전에 트리거되며 형식은
function ($form, attribute, messages) { ...return false to cancel the validation... }
function ($form, attribute, messages) { }
$errorSummary: 합계 오류 프롬프트 스타일
$attributes: 이 속성은 필드가 생성될 때 필드에서 이 양식의 $attributes에 할당됩니다. 이를 통해 필드 메소드를 통해 생성된 입력 양식을 검증할 수 있습니다