Class CRequiredValidator

CRequiredValidator validates that the specified attribute does not have null or empty value.

When using the CValidator::$message property to define a custom error message, the message may contain additional placeholders that will be replaced with the actual content. In addition to the "{attribute}" placeholder, recognized by all validators (see CValidator), CRequiredValidator allows for the following placeholders to be specified:

{value}: replaced with the desired value CRequiredValidator::$requiredValue.

CComponent

CValidator

CRequiredValidator

Package: system\validators
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/validators/CRequiredValidator.php

Methods summary
`protected`	# `validateAttribute( CModel $object, string $attribute )` Validates the attribute of the object. If there is any error, the error message is added to the object. Validates the attribute of the object. If there is any error, the error message is added to the object. Parameters `$object` `CModel` $object the object being validated `$attribute` `string` $attribute the attribute being validated
`public string`	# `clientValidateAttribute( CModel $object, string $attribute )` Returns the JavaScript needed for performing client-side validation. Returns the JavaScript needed for performing client-side validation. Parameters `$object` `CModel` $object the data object being validated `$attribute` `string` $attribute the name of the attribute to be validated. Returns `string` the client-side validation script. Since 1.1.7 See `CActiveForm::$enableClientValidation` Overrides `CValidator::clientValidateAttribute()`

Methods inherited from CValidator
`addError(), applyTo(), createValidator(), isEmpty(), validate()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`public mixed`	`$requiredValue`		# the desired value that the attribute must have. If this is null, the validator will validate that the specified attribute does not have null or empty value. If this is set as a value that is not null, the validator will validate that the attribute has a value that is the same as this property value. Defaults to null. the desired value that the attribute must have. If this is null, the validator will validate that the specified attribute does not have null or empty value. If this is set as a value that is not null, the validator will validate that the attribute has a value that is the same as this property value. Defaults to null.
`public boolean`	`$strict`	`false`	# whether the comparison to `CRequiredValidator::$requiredValue` is strict. When this is true, the attribute value and type must both match those of `CRequiredValidator::$requiredValue`. Defaults to false, meaning only the value needs to be matched. This property is only used when `CRequiredValidator::$requiredValue` is not null. whether the comparison to `CRequiredValidator::$requiredValue` is strict. When this is true, the attribute value and type must both match those of `CRequiredValidator::$requiredValue`. Defaults to false, meaning only the value needs to be matched. This property is only used when `CRequiredValidator::$requiredValue` is not null.
`public boolean`	`$trim`	`true`	# whether the value should be trimmed with php trim() function when comparing strings. When set to false, the attribute value is not considered empty when it contains spaces. Defaults to true, meaning the value will be trimmed. whether the value should be trimmed with php trim() function when comparing strings. When set to false, the attribute value is not considered empty when it contains spaces. Defaults to true, meaning the value will be trimmed. Since 1.1.14

Properties inherited from CValidator
`$attributes, $builtInValidators, $enableClientValidation, $except, $message, $on, $safe, $skipOnError`

Packages

Classes

Class CRequiredValidator

Parameters

Parameters

Returns

Since

See

Overrides

Since