Class \Prado\Web\UI\WebControls\TRangeValidator

TRangeValidator class

TRangeValidator tests whether an input value is within a specified range.

TRangeValidator uses three key properties to perform its validation. The \Prado\Web\UI\WebControls\setMinValue and \Prado\Web\UI\WebControls\setMaxValue properties specify the minimum and maximum values of the valid range. The \Prado\Web\UI\WebControls\setDataType 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 \Prado\Web\UI\WebControls\setDateFormat 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 \Prado\Web\UI\WebControls\setStrictComparison 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 \Prado\Web\UI\WebControls\setCharset property can be used to force a particular charset for comparison. Otherwise, the application charset is used and is defaulted as UTF-8.

Class hierarchy

\Prado\Web\UI\WebControls\TRangeValidator

\Prado\Web\UI\WebControls\TBaseValidator implements IValidator

\Prado\Web\UI\WebControls\TLabel implements IDataRenderer

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`getCharset() : string`
`public`	`getDataType() : TRangeValidationDataType`
`public`	`getDateFormat() : string`
`public`	`getMaxValue() : string`
`public`	`getMinValue() : string`
`public`	`getStrictComparison() : bool`
`public`	`setCharset(string $value) : mixed`
`public`	`setDataType(TRangeValidationDataType $value) : mixed` Sets the data type that the values being compared are converted to before the comparison is made.
`public`	`setDateFormat(string $value) : mixed` Sets the date format for a date validation
`public`	`setMaxValue(string $value) : mixed` Sets the maximum value of the validation range.
`public`	`setMinValue(string $value) : mixed` Sets the minimum value of the validation range.
`public`	`setStrictComparison(bool $value) : mixed`
`protected`	`evaluateIsValid() : bool` 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.
`protected`	`getClientClassName() : string` Gets the name of the javascript class responsible for performing validation for this control. This method overrides the parent implementation.
`protected`	`getClientScriptOptions() : array<string\|int, mixed>` Returns an array of javascript validator options.
`protected`	`isGreaterThan(mixed $left, mixed $right) : mixed`
`protected`	`isLessThan(mixed $left, mixed $right) : mixed`
`protected`	`isValidDate(string $value) : bool` Determine if the date is within the specified range. Uses pradoParseDate and strtotime to get the date from string.
`protected`	`isValidFloat(string $value) : bool` Determine if the value is within the specified float range.
`protected`	`isValidInteger(string $value) : bool` Determine if the value is within the integer range.
`protected`	`isValidString(string $value) : bool` Compare the string with a minimum and a maxiumum value. Uses strcmp for comparision.
`protected`	`isValidStringLength(string $value) : bool`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getClassHierarchy, getClientID, getClientSide, getControlCssClass, getControls, getControlToValidate, getCssClass, getCustomData, getData, getDecorator, getDisplay, getEnableClientScript, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getErrorMessage, getEventHandlers, getFocusElementID, getFocusOnError, getFont, getForControl, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getIsValid, getListeningToGlobalEvents, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getText, getToolTip, getUniqueID, getUser, getValidationGroup, getValidationTarget, getViewState, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onInit, onLoad, onPreRender, onUnload, onValidate, onValidationError, onValidationSuccess, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderClientControlScript, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAttribute, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setControlCssClass, setControlToValidate, setCssClass, setCustomData, setData, setDisplay, setEnableClientScript, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setErrorMessage, setFocusElementID, setFocusOnError, setForControl, setForeColor, setHeight, setID, setIsValid, setPage, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setText, setToolTip, setValidationGroup, setViewState, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, validate, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createClientSide, createControlCollection, createStyle, dataBindChildren, dataBindProperties, evaluateIsValid, getCallChain, getChildControlsCreated, getClassFxEvents, getClientClassName, getClientScriptOptions, getControlStage, getControlState, getTagName, getValidationValue, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, registerClientScriptValidator, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, updateControlCssClass, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID, getClientControlClass

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TRangeValidator

Class hierarchy