本文實例講述了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程序设计有所帮助。