PHP Class Prado\Web\UI\WebControls\TCompareValidator

TCompareValidator compares the value entered by the user into an input control with the value entered into another input control or a constant value. To compare the associated input control with another input control, set the {@link setControlToCompare ControlToCompare} property to the ID path of the control to compare with. To compare the associated input control with a constant value, specify the constant value to compare with by setting the {@link setValueToCompare ValueToCompare} property. The {@link setDataType DataType} property is used to specify the data type of both comparison values. Both values are automatically converted to this data type before the comparison operation is performed. The following value types are supported: - Integer A 32-bit signed integer data type. - Float A double-precision floating point number data type. - Date A date data type. The format can be specified by the {@link setDateFormat DateFormat} property - String A string data type. Use the {@link setOperator Operator} property to specify the type of comparison to perform. Valid operators include Equal, NotEqual, GreaterThan, GreaterThanEqual, LessThan and LessThanEqual.
Since: 3.0
Author: Qiang Xue ([email protected])
Inheritance: extends TBaseValidator
Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode Description
evaluateIsValid ( ) : boolean This method overrides the parent's implementation.
getControlToCompare ( ) : string
getDataType ( ) : TValidationDataType
getDateFormat ( ) : string
getOperator ( ) : TValidationCompareOperator
getValueToCompare ( ) : string
setControlToCompare ( $value ) Sets the input component to compare with the input control being validated.
setDataType ( $value ) Sets the data type that the values being compared are converted to before the comparison is made.
setDateFormat ( $value ) Sets the date format for a date validation
setOperator ( $value ) Sets the comparison operation to perform
setValueToCompare ( $value ) Sets the constant value to compare with the value entered by the user into the input component being validated.

Méthodes protégées

Méthode Description
getClientClassName ( ) : string Gets the name of the javascript class responsible for performing validation for this control.
getClientScriptOptions ( ) : array Returns an array of javascript validator options.
getComparisonValues ( $value1, $value2 ) : array Parse the pair of values into the appropriate value type.

Method Details

evaluateIsValid() public méthode

The validation succeeds if the input data compares successfully. The validation always succeeds if ControlToValidate is not specified or the input data is empty.
public evaluateIsValid ( ) : boolean
Résultat boolean whether the validation succeeds

getClientClassName() protected méthode

This method overrides the parent implementation.
protected getClientClassName ( ) : string
Résultat string the javascript class name

getClientScriptOptions() protected méthode

Returns an array of javascript validator options.
protected getClientScriptOptions ( ) : array
Résultat array javascript validator options.

getComparisonValues() protected méthode

Parse the pair of values into the appropriate value type.
protected getComparisonValues ( $value1, $value2 ) : array
Résultat array appropriate type of the value pair, array($value1, $value2);

getControlToCompare() public méthode

public getControlToCompare ( ) : string
Résultat string the input component to compare with the input control being validated.

getDataType() public méthode

public getDataType ( ) : TValidationDataType
Résultat TValidationDataType the data type that the values being compared are converted to before the comparison is made. Defaults to TValidationDataType::String.

getDateFormat() public méthode

public getDateFormat ( ) : string
Résultat string the date validation date format if any

getOperator() public méthode

public getOperator ( ) : TValidationCompareOperator
Résultat TValidationCompareOperator the comparison operation to perform. Defaults to TValidationCompareOperator::Equal.

getValueToCompare() public méthode

public getValueToCompare ( ) : string
Résultat string the constant value to compare with the value entered by the user into the input component being validated.

setControlToCompare() public méthode

Sets the input component to compare with the input control being validated.
public setControlToCompare ( $value )

setDataType() public méthode

Sets the data type that the values being compared are converted to before the comparison is made.
public setDataType ( $value )

setDateFormat() public méthode

Sets the date format for a date validation
public setDateFormat ( $value )

setOperator() public méthode

Sets the comparison operation to perform
public setOperator ( $value )

setValueToCompare() public méthode

Sets the constant value to compare with the value entered by the user into the input component being validated.
public setValueToCompare ( $value )