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
Datei anzeigen Open project: pradosoft/prado

Public Methods

Method 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.

Protected Methods

Method 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 method

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
return boolean whether the validation succeeds

getClientClassName() protected method

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

getClientScriptOptions() protected method

Returns an array of javascript validator options.
protected getClientScriptOptions ( ) : array
return array javascript validator options.

getComparisonValues() protected method

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

getControlToCompare() public method

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

getDataType() public method

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

getDateFormat() public method

public getDateFormat ( ) : string
return string the date validation date format if any

getOperator() public method

public getOperator ( ) : TValidationCompareOperator
return TValidationCompareOperator the comparison operation to perform. Defaults to TValidationCompareOperator::Equal.

getValueToCompare() public method

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

setControlToCompare() public method

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

setDataType() public method

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

setDateFormat() public method

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

setOperator() public method

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

setValueToCompare() public method

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