Class TRangeValidator

Description

TRangeValidator class

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

TRangeValidator uses three key properties to perform its validation. The MinValue and MaxValue properties specify the minimum and maximum values of the valid range. The 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 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.

Located in /Web/UI/WebControls/TRangeValidator.php (line 43)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TLabel
               |
               --TBaseValidator
                  |
                  --TRangeValidator
Method Summary
boolean evaluateIsValid ()
string getDataType ()
string getDateFormat ()
string getMaxValue ()
string getMinValue ()
boolean isValidDate (string $value)
boolean isValidFloat (string $value)
boolean isValidInteger (string $value)
boolean isValidString (string $value)
void setDataType (string $value)
void setDateFormat (string $value)
void setMaxValue (string $value)
void setMinValue (string $value)
Methods
evaluateIsValid (line 121)

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.

  • return: whether the validation succeeds
  • access: protected
boolean evaluateIsValid ()

Redefinition of:
TBaseValidator::evaluateIsValid()
This is the major method for validation.
getClientScriptOptions (line 236)

Returns an array of javascript validator options.

  • return: javascript validator options.
  • access: protected
array getClientScriptOptions ()

Redefinition of:
TBaseValidator::getClientScriptOptions()
Returns an array of javascript validator options.
getDataType (line 83)
  • return: the data type that the values being compared are converted to before the comparison is made. Defaults to String.
  • access: public
string getDataType ()
getDateFormat (line 110)
  • return: the date validation date format if any
  • access: public
string getDateFormat ()
getMaxValue (line 65)
  • return: the maximum value of the validation range.
  • access: public
string getMaxValue ()
getMinValue (line 48)
  • return: the minimum value of the validation range.
  • access: public
string getMinValue ()
isValidDate (line 184)

Determine if the date is within the specified range.

Uses pradoParseDate and strtotime to get the date from string.

  • return: true if within range.
  • access: protected
boolean isValidDate (string $value)
  • string $value: date as string to validate
isValidFloat (line 164)

Determine if the value is within the specified float range.

  • return: true if within range.
  • access: protected
boolean isValidFloat (string $value)
  • string $value: value to validate
isValidInteger (line 145)

Determine if the value is within the integer range.

  • return: true if within integer range.
  • access: protected
boolean isValidInteger (string $value)
  • string $value: value to validate true
isValidString (line 219)

Compare the string with a minimum and a maxiumum value.

Uses strcmp for comparision.

  • return: true if the string is within range.
  • access: protected
boolean isValidString (string $value)
  • string $value: value to compare with.
setDataType (line 93)

Sets the data type (Integer, Float, Date, String) that the values being compared are converted to before the comparison is made.

  • access: public
void setDataType (string $value)
  • string $value: the data type
setDateFormat (line 102)

Sets the date format for a date validation

  • access: public
void setDateFormat (string $value)
  • string $value: the date format value
setMaxValue (line 74)

Sets the maximum value of the validation range.

  • access: public
void setMaxValue (string $value)
  • string $value: the maximum value
setMinValue (line 57)

Sets the minimum value of the validation range.

  • access: public
void setMinValue (string $value)
  • string $value: the minimum value

Inherited Methods

Inherited From TBaseValidator

TBaseValidator::__construct()
TBaseValidator::addAttributesToRender()
TBaseValidator::createClientScript()
TBaseValidator::evaluateIsValid()
TBaseValidator::getClientScriptOptions()
TBaseValidator::getClientSide()
TBaseValidator::getControlCssClass()
TBaseValidator::getControlToValidate()
TBaseValidator::getDisplay()
TBaseValidator::getEnableClientScript()
TBaseValidator::getErrorMessage()
TBaseValidator::getFocusElementID()
TBaseValidator::getFocusOnError()
TBaseValidator::getIsValid()
TBaseValidator::getValidationGroup()
TBaseValidator::getValidationTarget()
TBaseValidator::getValidationValue()
TBaseValidator::onInit()
TBaseValidator::onPreRender()
TBaseValidator::onUnload()
TBaseValidator::registerClientScriptValidator()
TBaseValidator::renderContents()
TBaseValidator::setControlCssClass()
TBaseValidator::setControlToValidate()
TBaseValidator::setDisplay()
TBaseValidator::setEnableClientScript()
TBaseValidator::setEnabled()
TBaseValidator::setErrorMessage()
TBaseValidator::setFocusElementID()
TBaseValidator::setFocusOnError()
TBaseValidator::setForControl()
TBaseValidator::setIsValid()
TBaseValidator::setValidationGroup()
TBaseValidator::updateControlCssClass()
TBaseValidator::validate()

Inherited From TLabel

TLabel::addAttributesToRender()
TLabel::getForControl()
TLabel::getTagName()
TLabel::getText()
TLabel::renderContents()
TLabel::setForControl()
TLabel::setText()

Inherited From TWebControl

TWebControl::addAttributesToRender()
TWebControl::copyBaseAttributes()
TWebControl::createStyle()
TWebControl::getAccessKey()
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setForeColor()
TWebControl::setHeight()
TWebControl::setStyle()
TWebControl::setTabIndex()
TWebControl::setToolTip()
TWebControl::setWidth()

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::broadcastEventInternal()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::createChildControls()
TControl::createControlCollection()
TControl::createdOnTemplate()
TControl::dataBind()
TControl::dataBindChildren()
TControl::dataBindProperties()
TControl::ensureChildControls()
TControl::findControl()
TControl::findControlsByID()
TControl::findControlsByType()
TControl::focus()
TControl::getAdapter()
TControl::getAllowChildControls()
TControl::getAttribute()
TControl::getAttributes()
TControl::getChildControlsCreated()
TControl::getClientID()
TControl::getControls()
TControl::getControlStage()
TControl::getControlState()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasControls()
TControl::getID()
TControl::getNamingContainer()
TControl::getPage()
TControl::getParent()
TControl::getRegisteredObject()
TControl::getSkinID()
TControl::getSourceTemplateControl()
TControl::getTemplateControl()
TControl::getUniqueID()
TControl::getViewState()
TControl::getVisible()
TControl::hasAttribute()
TControl::initRecursive()
TControl::isDescendentOf()
TControl::isObjectRegistered()
TControl::loadRecursive()
TControl::loadState()
TControl::loadStateRecursive()
TControl::onDataBinding()
TControl::onInit()
TControl::onLoad()
TControl::onPreRender()
TControl::onUnload()
TControl::preRenderRecursive()
TControl::raiseBubbleEvent()
TControl::registerObject()
TControl::removeAttribute()
TControl::removedControl()
TControl::render()
TControl::renderChildren()
TControl::renderControl()
TControl::saveState()
TControl::saveStateRecursive()
TControl::setAdapter()
TControl::setAttribute()
TControl::setChildControlsCreated()
TControl::setControlStage()
TControl::setControlState()
TControl::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
TControl::traverseChildControls()
TControl::unbindProperty()
TControl::unloadRecursive()
TControl::unregisterObject()
TControl::__get()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

Inherited From TComponent

TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()
Class Constants

Inherited Constants

Inherited from TControl

Documentation generated on Sun, 04 Jun 2006 19:00:07 -0400 by phpDocumentor 1.3.0RC4