|
Class TRangeValidator
TRangeValidator class
TRangeValidator tests whether an input value is within a specified range.
TRangeValidator uses three key properties to perform its validation. The
setMinValue MinValue and setMaxValue MaxValue properties specify
the minimum and maximum values of the valid range. The setDataType
DataType property is used to specify the data type of the value and the minimum
and maximum range values. These values are converted to this data type before
the validation 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 date format can be specified by setting
setDateFormat DateFormat property, which must be recognizable by
TSimpleDateFormatter . If the property is not set, the GNU date syntax is
assumed.
- String A string data type.
- StringLength check for string length.
If setStrictComparison StrictComparison is true, then the ranges are
compared as strictly less than the max value and/or strictly greater than the
min value.
The TRangeValidator allows a special DataType "StringLength" that can be used
to verify minimum and maximum string length. The setCharset Charset
property can be used to force a particular charset for comparison. Otherwise,
the application charset is used and is defaulted as UTF-8.
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
TLabel
implements
IDataRenderer
-
TBaseValidator
implements
IValidator
-
TRangeValidator
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
string
|
#
getMinValue( )
Returns
string the minimum value of the validation range.
|
public
|
#
setMinValue( string $value )
Sets the minimum value of the validation range.
Sets the minimum value of the validation range.
Parameters
- $value
string the minimum value
|
public
string
|
#
getMaxValue( )
Returns
string the maximum value of the validation range.
|
public
|
#
setMaxValue( string $value )
Sets the maximum value of the validation range.
Sets the maximum value of the validation range.
Parameters
- $value
string the maximum value
|
public
|
#
setStrictComparison( boolean $value )
Parameters
- $value
boolean true to perform strict comparison (i.e. strictly less than max and/or strictly
greater than min).
|
public
boolean
|
#
getStrictComparison( )
Returns
boolean true to perform strict comparison.
|
public
TRangeValidationDataType
|
#
getDataType( )
Returns
TRangeValidationDataType
the data type that the values being compared are converted to before the
comparison is made. Defaults to TRangeValidationDataType::String.
|
public
|
#
setDataType( TRangeValidationDataType $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
|
#
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
|
#
setCharset( string $value )
Parameters
- $value
string charset for string length comparison.
|
public
string
|
#
getCharset( )
Returns
string charset for string length comparison.
|
protected
boolean
|
#
evaluateIsValid( )
This method overrides the parent's implementation. The validation succeeds if
the input data is within the range. The validation always succeeds if the input
data is empty.
This method overrides the parent's implementation. The validation succeeds if
the input data is within the range. The validation always succeeds if the input
data is empty.
Returns
boolean whether the validation succeeds
|
protected
boolean
|
#
isValidInteger( string $value )
Determine if the value is within the integer range.
Determine if the value is within the integer range.
Parameters
- $value
string value to validate true
Returns
boolean true if within integer range.
|
protected
|
#
isLessThan( mixed $left, mixed $right )
|
protected
|
#
isGreaterThan( mixed $left, mixed $right )
|
protected
boolean
|
#
isValidFloat( string $value )
Determine if the value is within the specified float range.
Determine if the value is within the specified float range.
Parameters
- $value
string value to validate
Returns
boolean true if within range.
|
protected
boolean
|
#
isValidDate( string $value )
Determine if the date is within the specified range. Uses pradoParseDate and
strtotime to get the date from string.
Determine if the date is within the specified range. Uses pradoParseDate and
strtotime to get the date from string.
Parameters
- $value
string date as string to validate
Returns
boolean true if within range.
|
protected
boolean
|
#
isValidString( string $value )
Compare the string with a minimum and a maxiumum value. Uses strcmp for
comparision.
Compare the string with a minimum and a maxiumum value. Uses strcmp for
comparision.
Parameters
- $value
string value to compare with.
Returns
boolean true if the string is within range.
|
protected
boolean
|
#
isValidStringLength( string $value )
Parameters
- $value
string string for comparision
Returns
boolean true if min and max string length are satisfied.
|
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
|
|