ActiveForm.php 11.7 KB
Newer Older
Qiang Xue committed
1
<?php
Qiang Xue committed
2 3 4 5 6
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */
Qiang Xue committed
7

Qiang Xue committed
8 9
namespace yii\widgets;

Qiang Xue committed
10
use Yii;
Qiang Xue committed
11
use yii\base\Widget;
Qiang Xue committed
12
use yii\base\Model;
Qiang Xue committed
13
use yii\helpers\Html;
Qiang Xue committed
14
use yii\helpers\Json;
15
use yii\web\JsExpression;
Qiang Xue committed
16 17 18 19 20 21 22 23

/**
 * ActiveForm ...
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class ActiveForm extends Widget
Qiang Xue committed
24
{
Qiang Xue committed
25
	/**
Qiang Xue committed
26
	 * @param array|string $action the form action URL. This parameter will be processed by [[\yii\helpers\Html::url()]].
Qiang Xue committed
27 28 29 30 31 32 33
	 */
	public $action = '';
	/**
	 * @var string the form submission method. This should be either 'post' or 'get'.
	 * Defaults to 'post'.
	 */
	public $method = 'post';
Qiang Xue committed
34
	/**
Qiang Xue committed
35 36
	 * @var array the HTML attributes (name-value pairs) for the form tag.
	 * The values will be HTML-encoded using [[Html::encode()]].
Qiang Xue committed
37 38
	 * If a value is null, the corresponding attribute will not be rendered.
	 */
Alexander Makarov committed
39
	public $options = [];
Qiang Xue committed
40 41
	/**
	 * @var array the default configuration used by [[field()]] when creating a new field object.
Qiang Xue committed
42
	 */
43
	public $fieldConfig;
Qiang Xue committed
44
	/**
Qiang Xue committed
45 46
	 * @var string the default CSS class for the error summary container.
	 * @see errorSummary()
Qiang Xue committed
47
	 */
Qiang Xue committed
48
	public $errorSummaryCssClass = 'error-summary';
Qiang Xue committed
49 50 51 52 53 54 55
	/**
	 * @var string the CSS class that is added to a field container when the associated attribute is required.
	 */
	public $requiredCssClass = 'required';
	/**
	 * @var string the CSS class that is added to a field container when the associated attribute has validation error.
	 */
56
	public $errorCssClass = 'has-error';
Qiang Xue committed
57 58 59
	/**
	 * @var string the CSS class that is added to a field container when the associated attribute is successfully validated.
	 */
60
	public $successCssClass = 'has-success';
Qiang Xue committed
61 62 63 64
	/**
	 * @var string the CSS class that is added to a field container when the associated attribute is being validated.
	 */
	public $validatingCssClass = 'validating';
Qiang Xue committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
	/**
	 * @var boolean whether to enable client-side data validation.
	 * If [[ActiveField::enableClientValidation]] is set, its value will take precedence for that input field.
	 */
	public $enableClientValidation = true;
	/**
	 * @var boolean whether to enable AJAX-based data validation.
	 * If [[ActiveField::enableAjaxValidation]] is set, its value will take precedence for that input field.
	 */
	public $enableAjaxValidation = false;
	/**
	 * @var array|string the URL for performing AJAX-based validation. This property will be processed by
	 * [[Html::url()]]. Please refer to [[Html::url()]] for more details on how to configure this property.
	 * If this property is not set, it will take the value of the form's action attribute.
	 */
Qiang Xue committed
80
	public $validationUrl;
Qiang Xue committed
81 82 83 84 85 86 87 88
	/**
	 * @var boolean whether to perform validation when the form is submitted.
	 */
	public $validateOnSubmit = true;
	/**
	 * @var boolean whether to perform validation when an input field loses focus and its value is found changed.
	 * If [[ActiveField::validateOnChange]] is set, its value will take precedence for that input field.
	 */
Qiang Xue committed
89
	public $validateOnChange = true;
Qiang Xue committed
90 91 92 93 94 95 96
	/**
	 * @var boolean whether to perform validation while the user is typing in an input field.
	 * If [[ActiveField::validateOnType]] is set, its value will take precedence for that input field.
	 * @see validationDelay
	 */
	public $validateOnType = false;
	/**
Qiang Xue committed
97 98
	 * @var integer number of milliseconds that the validation should be delayed when an input field
	 * is changed or the user types in the field.
Qiang Xue committed
99 100 101
	 * If [[ActiveField::validationDelay]] is set, its value will take precedence for that input field.
	 */
	public $validationDelay = 200;
Qiang Xue committed
102 103 104 105
	/**
	 * @var string the name of the GET parameter indicating the validation request is an AJAX request.
	 */
	public $ajaxVar = 'ajax';
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
	/**
	 * @var string|JsExpression a JS callback that will be called when the form is being submitted.
	 * The signature of the callback should be:
	 *
	 * ~~~
	 * function ($form) {
	 *     ...return false to cancel submission...
	 * }
	 * ~~~
	 */
	public $beforeSubmit;
	/**
	 * @var string|JsExpression a JS callback that is called before validating an attribute.
	 * The signature of the callback should be:
	 *
	 * ~~~
	 * function ($form, attribute, messages) {
	 *     ...return false to cancel the validation...
	 * }
	 * ~~~
	 */
	public $beforeValidate;
	/**
	 * @var string|JsExpression a JS callback that is called after validating an attribute.
	 * The signature of the callback should be:
	 *
	 * ~~~
	 * function ($form, attribute, messages) {
	 * }
	 * ~~~
	 */
	public $afterValidate;
Qiang Xue committed
138
	/**
Qiang Xue committed
139
	 * @var array the client validation options for individual attributes. Each element of the array
Qiang Xue committed
140 141 142
	 * represents the validation options for a particular attribute.
	 * @internal
	 */
Alexander Makarov committed
143
	public $attributes = [];
Qiang Xue committed
144

Qiang Xue committed
145 146 147 148 149 150
	/**
	 * Initializes the widget.
	 * This renders the form open tag.
	 */
	public function init()
	{
Qiang Xue committed
151 152 153
		if (!isset($this->options['id'])) {
			$this->options['id'] = $this->getId();
		}
154
		if (!isset($this->fieldConfig['class'])) {
Qiang Xue committed
155
			$this->fieldConfig['class'] = ActiveField::className();
156
		}
Qiang Xue committed
157 158 159 160 161 162 163 164 165
		echo Html::beginForm($this->action, $this->method, $this->options);
	}

	/**
	 * Runs the widget.
	 * This registers the necessary javascript code and renders the form close tag.
	 */
	public function run()
	{
166
		if (!empty($this->attributes)) {
Qiang Xue committed
167 168 169
			$id = $this->options['id'];
			$options = Json::encode($this->getClientOptions());
			$attributes = Json::encode($this->attributes);
170 171 172
			$view = $this->getView();
			ActiveFormAsset::register($view);
			$view->registerJs("jQuery('#$id').yiiActiveForm($attributes, $options);");
Qiang Xue committed
173 174 175 176
		}
		echo Html::endForm();
	}

Qiang Xue committed
177 178 179 180
	/**
	 * Returns the options for the form JS widget.
	 * @return array the options
	 */
Qiang Xue committed
181 182
	protected function getClientOptions()
	{
Alexander Makarov committed
183
		$options = [
Qiang Xue committed
184 185
			'errorSummary' => '.' . $this->errorSummaryCssClass,
			'validateOnSubmit' => $this->validateOnSubmit,
Qiang Xue committed
186 187 188
			'errorCssClass' => $this->errorCssClass,
			'successCssClass' => $this->successCssClass,
			'validatingCssClass' => $this->validatingCssClass,
Qiang Xue committed
189
			'ajaxVar' => $this->ajaxVar,
Alexander Makarov committed
190
		];
Qiang Xue committed
191 192 193
		if ($this->validationUrl !== null) {
			$options['validationUrl'] = Html::url($this->validationUrl);
		}
Alexander Makarov committed
194
		foreach (['beforeSubmit', 'beforeValidate', 'afterValidate'] as $name) {
195 196 197 198
			if (($value = $this->$name) !== null) {
				$options[$name] = $value instanceof JsExpression ? $value : new JsExpression($value);
			}
		}
Qiang Xue committed
199
		return $options;
Qiang Xue committed
200 201
	}

Qiang Xue committed
202
	/**
Qiang Xue committed
203 204 205 206 207 208 209 210 211 212 213
	 * Generates a summary of the validation errors.
	 * If there is no validation error, an empty error summary markup will still be generated, but it will be hidden.
	 * @param Model|Model[] $models the model(s) associated with this form
	 * @param array $options the tag options in terms of name-value pairs. The following options are specially handled:
	 *
	 * - header: string, the header HTML for the error summary. If not set, a default prompt string will be used.
	 * - footer: string, the footer HTML for the error summary.
	 *
	 * The rest of the options will be rendered as the attributes of the container tag. The values will
	 * be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered.
	 * @return string the generated error summary
Qiang Xue committed
214
	 */
Alexander Makarov committed
215
	public function errorSummary($models, $options = [])
Qiang Xue committed
216
	{
Alexander Makarov committed
217 218 219
		if (!is_array($models)) {
			$models = [$models];
		}
Qiang Xue committed
220

Alexander Makarov committed
221
		$lines = [];
Qiang Xue committed
222
		foreach ($models as $model) {
slavcodev committed
223
			/** @var Model $model */
Qiang Xue committed
224 225
			foreach ($model->getFirstErrors() as $error) {
				$lines[] = Html::encode($error);
Qiang Xue committed
226 227 228
			}
		}

229
		$header = isset($options['header']) ? $options['header'] : '<p>' . Yii::t('yii', 'Please fix the following errors:') . '</p>';
Qiang Xue committed
230
		$footer = isset($options['footer']) ? $options['footer'] : '';
Qiang Xue committed
231
		unset($options['header'], $options['footer']);
Qiang Xue committed
232 233

		if (!isset($options['class'])) {
Qiang Xue committed
234
			$options['class'] = $this->errorSummaryCssClass;
Qiang Xue committed
235
		} else {
Qiang Xue committed
236
			$options['class'] .= ' ' . $this->errorSummaryCssClass;
Qiang Xue committed
237 238
		}

239
		if (!empty($lines)) {
Qiang Xue committed
240 241
			$content = "<ul><li>" . implode("</li>\n<li>", $lines) . "</li><ul>";
			return Html::tag('div', $header . $content . $footer, $options);
Qiang Xue committed
242 243 244
		} else {
			$content = "<ul></ul>";
			$options['style'] = isset($options['style']) ? rtrim($options['style'], ';') . '; display:none' : 'display:none';
Qiang Xue committed
245
			return Html::tag('div', $header . $content . $footer, $options);
Qiang Xue committed
246
		}
Qiang Xue committed
247 248
	}

Qiang Xue committed
249
	/**
250
	 * Generates a form field.
Qiang Xue committed
251
	 * A form field is associated with a model and an attribute. It contains a label, an input and an error message
252
	 * and use them to interact with end users to collect their inputs for the attribute.
Qiang Xue committed
253 254 255
	 * @param Model $model the data model
	 * @param string $attribute the attribute name or expression. See [[Html::getAttributeName()]] for the format
	 * about attribute expression.
Qiang Xue committed
256
	 * @param array $options the additional configurations for the field object
Qiang Xue committed
257
	 * @return ActiveField the created ActiveField object
Qiang Xue committed
258
	 * @see fieldConfig
Qiang Xue committed
259
	 */
Alexander Makarov committed
260
	public function field($model, $attribute, $options = [])
Qiang Xue committed
261
	{
Alexander Makarov committed
262
		return Yii::createObject(array_merge($this->fieldConfig, $options, [
Qiang Xue committed
263 264 265
			'model' => $model,
			'attribute' => $attribute,
			'form' => $this,
Alexander Makarov committed
266
		]));
Qiang Xue committed
267
	}
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356

	/**
	 * Validates one or several models and returns an error message array indexed by the attribute IDs.
	 * This is a helper method that simplifies the way of writing AJAX validation code.
	 *
	 * For example, you may use the following code in a controller action to respond
	 * to an AJAX validation request:
	 *
	 * ~~~
	 * $model = new Post;
	 * $model->load($_POST);
	 * if (Yii::$app->request->isAjax) {
	 *     Yii::$app->response->format = Response::FORMAT_JSON;
	 *     return ActiveForm::validate($model);
	 * }
	 * // ... respond to non-AJAX request ...
	 * ~~~
	 *
	 * To validate multiple models, simply pass each model as a parameter to this method, like
	 * the following:
	 *
	 * ~~~
	 * ActiveForm::validate($model1, $model2, ...);
	 * ~~~
	 *
	 * @param Model $model the model to be validated
	 * @param mixed $attributes list of attributes that should be validated.
	 * If this parameter is empty, it means any attribute listed in the applicable
	 * validation rules should be validated.
	 *
	 * When this method is used to validate multiple models, this parameter will be interpreted
	 * as a model.
	 *
	 * @return array the error message array indexed by the attribute IDs.
	 */
	public static function validate($model, $attributes = null)
	{
		$result = [];
		if ($attributes instanceof Model) {
			// validating multiple models
			$models = func_get_args();
			$attributes = null;
		} else {
			$models = [$model];
		}
		/** @var Model $model */
		foreach ($models as $model) {
			$model->validate($attributes);
			foreach ($model->getErrors() as $attribute => $errors) {
				$result[Html::getInputId($model, $attribute)] = $errors;
			}
		}
		return $result;
	}

	/**
	 * Validates an array of model instances and returns an error message array indexed by the attribute IDs.
	 * This is a helper method that simplifies the way of writing AJAX validation code for tabular input.
	 *
	 * For example, you may use the following code in a controller action to respond
	 * to an AJAX validation request:
	 *
	 * ~~~
	 * // ... load $models ...
	 * if (Yii::$app->request->isAjax) {
	 *     Yii::$app->response->format = Response::FORMAT_JSON;
	 *     return ActiveForm::validateMultiple($models);
	 * }
	 * // ... respond to non-AJAX request ...
	 * ~~~
	 *
	 * @param array $models an array of models to be validated.
	 * @param mixed $attributes list of attributes that should be validated.
	 * If this parameter is empty, it means any attribute listed in the applicable
	 * validation rules should be validated.
	 * @return array the error message array indexed by the attribute IDs.
	 */
	public static function validateMultiple($models, $attributes = null)
	{
		$result = [];
		/** @var Model $model */
		foreach ($models as $i => $model) {
			$model->validate($attributes);
			foreach ($model->getErrors() as $attribute => $errors) {
				$result[Html::getInputId($model, "[$i]" . $attribute)] = $errors;
			}
		}
		return $result;
	}
Qiang Xue committed
357
}