|
Class TCompareValidator
TCompareValidator class
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
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 setValueToCompare ValueToCompare property.
The 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
setDateFormat DateFormat property
- String A string data type.
Use the setOperator Operator property to specify the type of
comparison to perform. Valid operators include Equal, NotEqual, GreaterThan,
GreaterThanEqual, LessThan and LessThanEqual.
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
TLabel
implements
IDataRenderer
-
TBaseValidator
implements
IValidator
-
TCompareValidator
Methods summary
protected
string
|
#
getClientClassName( )
Gets the name of the javascript class responsible for performing validation
for this control. This method overrides the parent implementation.
Gets the name of the javascript class responsible for performing validation
for this control. This method overrides the parent implementation.
Returns
string the javascript class name
|
public
TValidationDataType
|
#
getDataType( )
Returns
TValidationDataType
the data type that the values being compared are converted to before the
comparison is made. Defaults to TValidationDataType::String.
|
public
|
#
setDataType( TValidationDataType $value )
Sets the data type that the values being compared are converted to before the
comparison is made.
Sets the data type that the values being compared are converted to before the
comparison is made.
Parameters
|
public
string
|
#
getControlToCompare( )
Returns
string the input component to compare with the input control being validated.
|
public
|
#
setControlToCompare( string $value )
Sets the input component to compare with the input control being
validated.
Sets the input component to compare with the input control being
validated.
Parameters
- $value
string the ID path of the component to compare with
|
public
string
|
#
getValueToCompare( )
Returns
string the constant value to compare with the value entered by the user into the input
component being validated.
|
public
|
#
setValueToCompare( string $value )
Sets the constant value to compare with the value entered by the user into
the input component being validated.
Sets the constant value to compare with the value entered by the user into
the input component being validated.
Parameters
- $value
string the constant value
|
public
TValidationCompareOperator
|
|
public
|
#
setOperator( TValidationCompareOperator $value )
Sets the comparison operation to perform
Sets the comparison operation to perform
Parameters
|
public
|
#
setDateFormat( string $value )
Sets the date format for a date validation
Sets the date format for a date validation
Parameters
- $value
string the date format value
|
public
string
|
#
getDateFormat( )
Returns
string the date validation date format if any
|
public
boolean
|
#
evaluateIsValid( )
This method overrides the parent's implementation. The validation succeeds if
the input data compares successfully. The validation always succeeds if
ControlToValidate is not specified or the input data is empty.
This method overrides the parent's implementation. The validation succeeds if
the input data compares successfully. The validation always succeeds if
ControlToValidate is not specified or the input data is empty.
Returns
boolean whether the validation succeeds
|
protected
array
|
#
getComparisonValues( string $value1, string $value2 )
Parse the pair of values into the appropriate value type.
Parse the pair of values into the appropriate value type.
Parameters
- $value1
string value one
- $value2
string second value
Returns
array appropriate type of the value pair, array($value1, $value2);
|
protected
array
|
#
getClientScriptOptions( )
Returns an array of javascript validator options.
Returns an array of javascript validator options.
Returns
array javascript validator options.
Overrides
|
Methods inherited from TBaseValidator
__construct(),
addAttributesToRender(),
createClientSide(),
getClientSide(),
getControlCssClass(),
getControlToValidate(),
getDisplay(),
getEnableClientScript(),
getErrorMessage(),
getFocusElementID(),
getFocusOnError(),
getIsValid(),
getValidationGroup(),
getValidationTarget(),
getValidationValue(),
onInit(),
onPreRender(),
onUnload(),
onValidate(),
onValidationError(),
onValidationSuccess(),
registerClientScriptValidator(),
renderClientControlScript(),
renderContents(),
setControlCssClass(),
setControlToValidate(),
setDisplay(),
setEnableClientScript(),
setEnabled(),
setErrorMessage(),
setFocusElementID(),
setFocusOnError(),
setForControl(),
setIsValid(),
setValidationGroup(),
updateControlCssClass(),
validate()
|
Methods inherited from TWebControl
clearStyle(),
copyBaseAttributes(),
createStyle(),
getAccessKey(),
getBackColor(),
getBorderColor(),
getBorderStyle(),
getBorderWidth(),
getCssClass(),
getDecorator(),
getEnsureId(),
getFont(),
getForeColor(),
getHasStyle(),
getHeight(),
getStyle(),
getTabIndex(),
getToolTip(),
getWidth(),
renderBeginTag(),
renderEndTag(),
setAccessKey(),
setBackColor(),
setBorderColor(),
setBorderStyle(),
setBorderWidth(),
setCssClass(),
setEnsureId(),
setForeColor(),
setHeight(),
setStyle(),
setTabIndex(),
setToolTip(),
setWidth()
|
Methods inherited from TControl
__get(),
addParsedObject(),
addToPostDataLoader(),
addedControl(),
applyStyleSheetSkin(),
autoBindProperty(),
autoDataBindProperties(),
bindProperty(),
broadcastEvent(),
bubbleEvent(),
clearChildState(),
clearControlState(),
clearNamingContainer(),
clearViewState(),
convertUniqueIdToClientId(),
createChildControls(),
createControlCollection(),
dataBind(),
dataBindChildren(),
dataBindProperties(),
ensureChildControls(),
findControl(),
findControlsByID(),
findControlsByType(),
focus(),
getAdapter(),
getAllowChildControls(),
getAttribute(),
getAttributes(),
getChildControlsCreated(),
getClientID(),
getControlStage(),
getControlState(),
getControls(),
getCustomData(),
getEnableTheming(),
getEnableViewState(),
getEnabled(),
getHasAdapter(),
getHasAttributes(),
getHasChildInitialized(),
getHasControls(),
getHasInitialized(),
getHasLoaded(),
getHasLoadedPostData(),
getHasPreRendered(),
getID(),
getIsSkinApplied(),
getNamingContainer(),
getPage(),
getParent(),
getRegisteredObject(),
getSkinID(),
getSourceTemplateControl(),
getTemplateControl(),
getUniqueID(),
getViewState(),
getVisible(),
hasAttribute(),
initRecursive(),
isDescendentOf(),
isObjectRegistered(),
loadRecursive(),
loadState(),
loadStateRecursive(),
onDataBinding(),
onLoad(),
preRenderRecursive(),
raiseBubbleEvent(),
registerObject(),
removeAttribute(),
removedControl(),
renderChildren(),
renderControl(),
saveState(),
saveStateRecursive(),
setAdapter(),
setAttribute(),
setChildControlsCreated(),
setControlStage(),
setControlState(),
setCustomData(),
setEnableTheming(),
setEnableViewState(),
setID(),
setPage(),
setSkinID(),
setTemplateControl(),
setViewState(),
setVisible(),
trackViewState(),
traverseChildControls(),
unbindProperty(),
unloadRecursive(),
unregisterObject()
|
Methods inherited from TComponent
__call(),
__destruct(),
__isset(),
__set(),
__sleep(),
__unset(),
__wakeup(),
asa(),
attachBehavior(),
attachBehaviors(),
attachClassBehavior(),
attachEventHandler(),
canGetProperty(),
canSetProperty(),
clearBehaviors(),
createdOnTemplate(),
detachBehavior(),
detachBehaviors(),
detachClassBehavior(),
detachEventHandler(),
disableBehavior(),
disableBehaviors(),
enableBehavior(),
enableBehaviors(),
evaluateExpression(),
evaluateStatements(),
fxAttachClassBehavior(),
fxDetachClassBehavior(),
getAutoGlobalListen(),
getBehaviorsEnabled(),
getClassHierarchy(),
getEventHandlers(),
getListeningToGlobalEvents(),
getSubProperty(),
hasEvent(),
hasEventHandler(),
hasProperty(),
isa(),
listen(),
raiseEvent(),
setSubProperty(),
unlisten()
|
Constants inherited from TControl
AUTOMATIC_ID_PREFIX,
CLIENT_ID_SEPARATOR,
CS_CHILD_INITIALIZED,
CS_CONSTRUCTED,
CS_INITIALIZED,
CS_LOADED,
CS_PRERENDERED,
CS_STATE_LOADED,
ID_FORMAT,
ID_SEPARATOR,
IS_CHILD_CREATED,
IS_CREATING_CHILD,
IS_DISABLE_THEMING,
IS_DISABLE_VIEWSTATE,
IS_ID_SET,
IS_SKIN_APPLIED,
IS_STYLESHEET_APPLIED,
RF_ADAPTER,
RF_AUTO_BINDINGS,
RF_CHILD_STATE,
RF_CONTROLS,
RF_CONTROLSTATE,
RF_DATA_BINDINGS,
RF_EVENTS,
RF_NAMED_CONTROLS,
RF_NAMED_CONTROLS_ID,
RF_NAMED_OBJECTS,
RF_SKIN_ID
|
|