Class: TRangeValidator

Source Location: /Web/UI/WebControls/TRangeValidator.php

Class Overview

TComponent
   |
   --TControl
      |
      --TWebControl
         |
         --TValidator
            |
            --TRangeValidator

TRangeValidator class

Class Details

[line 55]
TRangeValidator class

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

The TRangeValidator component uses three key properties to perform its validation. The MinValue and MaxValue properties specify the minimum and maximum values of the valid range. The ValueType property is used to specify the data type of the values to compare. The values to compare 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.
Double A double-precision floating point number data type.
Currency A decimal data type that can contain currency symbols.
Date A date data type. The format follows the GNU date syntax.
String A string data type.

Namespace: System.Web.UI.WebControls

Properties

MinValue, string, kept in viewstate
Gets or sets the minimum value of the validation range.
MaxValue, string, kept in viewstate
Gets or sets the maximum value of the validation range.
ValueType, string, default=String, kept in viewstate
Gets or sets the data type (Integer, Double, Currency, Date, String) that the values being compared are converted to before the comparison is made.

version:	v1.0, last update on 2004/08/13 21:44:52
author:	Qiang Xue <qiang.xue@gmail.com>

[ Top ]

Methods

Inherited Variables

Class: TComponent

TComponent::$children

Inherited Methods

Class: TValidator

TValidator::enableClientScript(): Sets the value indicating whether client-side validation is enabled.
TValidator::escapeJS(): Escape javascript strings.
TValidator::evaluateIsValid(): This is the major method for validation.
TValidator::getAnchor(): Get the anchor href link for the error messages.
TValidator::getAnchoredMessage(): Returns the error message of which an link anchor and javascript focus call is added if the property Anchor is set.
TValidator::getControlCssClass(): Get the CssClass for the ControlToValidate when the validation failes. The CSS is appended to the control.
TValidator::getControlToValidate()
TValidator::getDisplay()
TValidator::getErrorMessage()
TValidator::getJsOptions(): Get a list of options for the client-side javascript validator
TValidator::getMessage(): Get the validation error message.
TValidator::getTargetControl()
TValidator::getText()
TValidator::isClientScriptEnabled()
TValidator::isEncodeText()
TValidator::isValid()
TValidator::onPreRender(): Overrides parent implementation by registering necessary Javascripts for validation.
TValidator::render(): Overrides parent implementation by rendering TValidator-specific presentation.
TValidator::renderJsOptions(): Render the array as javascript list.
TValidator::renderJsValidator(): Render the client-side javascript code.
TValidator::setAnchor(): Set the anchor ID for the error message link. If the value is "true" then the ID of the ControlToValidate will be used otherwise the given value will be used as the anchor.
TValidator::setControlCssClass(): Set the CssClass for the ControlToValidate component when the validation fails.
TValidator::setControlToValidate(): Sets the ID path of the input component to validate
TValidator::setDisplay(): Sets the display behavior (None, Static, Dynamic) of the error message in a validation component.
TValidator::setEnabled(): This method overrides parent's implementation by setting isValid to true if disabled.
TValidator::setEncodeText(): Sets the value indicating whether the text should be HTML encoded before rendering
TValidator::setErrorMessage(): Sets the text for the error message.
TValidator::setText(): Sets the text content of the validator.
TValidator::setValid(): Sets the value indicating whether the validation succeeds
TValidator::updateControlCssClass(): Update the ControlToValidate component's css class depending if the ControlCssClass property is set, and whether this is valid.
TValidator::validate(): Validates the specified component.

Class: TWebControl

TWebControl::appendJavascriptEvent(): Append a javascript statement to a particular attribute, e.g. "onclick".
TWebControl::getAccessKey()
TWebControl::getAttributesToRender(): This overrides the parent implementation by rendering more TWebControl-specific attributes.
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getForeColor()
TWebControl::getHeight()
TWebControl::getJavascriptEvents(): Get the list of all the javascript statements.
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::isEnabled()
TWebControl::parseStyle(): Parses a CSS style string into an array representation.
TWebControl::removeJavascriptEvent(): Remove all or a particular javascript statements.
TWebControl::setAccessKey(): Sets the access key of the control.
TWebControl::setBackColor(): Sets the background color of the control
TWebControl::setBorderColor(): Sets the border color of the control
TWebControl::setBorderStyle(): Sets the border style of the control
TWebControl::setBorderWidth(): Sets the border width of the control
TWebControl::setCssClass(): Sets the CSS class name of the control
TWebControl::setEnabled(): Enables or disables a control.
TWebControl::setForeColor(): Sets the foreground color of the control
TWebControl::setHeight(): Sets the height of the control
TWebControl::setStyle(): Sets the CSS style of the control.
TWebControl::setTabIndex(): Sets the tab index of the control.
TWebControl::setToolTip(): Sets the tooltip of the control.
TWebControl::setWidth(): Sets the width of the control

Class: TControl

TControl::__construct(): Constructor.
TControl::addBody(): Appends an object into the body collection of this control.
TControl::addParsedObject(): Adds the object parsed in template as a body of the component.
TControl::allowBody(): Determines whether the control can add the object as a body.
TControl::clearViewState(): Clears viewstate
TControl::findBodyControl()
TControl::getAttribute()
TControl::getAttributes(): Returns the attribute list object.
TControl::getAttributesToRender(): Returns attributes to be rendered.
TControl::getBodies()
TControl::getClientID(): Returns the client ID of the component.
TControl::getContainer(): Returns the container of this component.
TControl::getSkinName()
TControl::getTagName()
TControl::getViewState(): Returns a viewstate value.
TControl::initSkin(): Initializes a skin for the control. If a skin name is provided then that skin will be loaded.
TControl::isViewStateEnabled()
TControl::isVisible(): This method checks whether a control is visible.
TControl::loadViewState(): Loads viewstate into this component and its children.
TControl::onBubbleEvent(): This method responds to a bubbled event.
TControl::onInit(): This method is invoked when the control enters 'Init' stage.
TControl::onInitRecursive(): Calls onInit of this control and its children recursively.
TControl::onLoad(): This method is invoked when the control enters 'Load' stage.
TControl::onLoadRecursive(): Calls onLoad of this control and its children recursively.
TControl::onPreRender(): This method is invoked when the control enters 'PreRender' stage.
TControl::onPreRenderRecursive(): Calls onPreRender of this control and its children recursively.
TControl::onUnload(): This method is invoked when the control enters 'Unload' stage.
TControl::onUnloadRecursive(): Calls onUnload of this control and its children recursively.
TControl::raiseBubbleEvent(): Invokes the parent's onBubbleEvent method.
TControl::removeBodies(): Removes all body content.
TControl::render(): Renders this control.
TControl::renderAttributes(): Renders the attributes.
TControl::renderBody(): Renders the body content.
TControl::saveViewState(): Returns the viewstate of this component and its children.
TControl::setAttribute(): Sets an attribute.
TControl::setContainer(): Sets the container of this component
TControl::setEnableViewState()
TControl::setSkinName(): Sets the skin to use for this control
TControl::setTagName(): Sets the tag name.
TControl::setViewState(): Sets a viewstate value.
TControl::setVisible()
TControl::synchronizeControl(): This method should only be used by framework developer.

Class: TComponent

TComponent::__construct(): Constructor.
TComponent::addChild(): Adds a child component.
TComponent::addParsedObject(): Handles a component or string met in template.
TComponent::attachEventHandler(): Attaches a handler function to an event.
TComponent::bindProperty(): Sets up the binding between a property and an expression.
TComponent::canGetProperty(): Determines whether a property can be read.
TComponent::canSetProperty(): Determines whether a property can be written.
TComponent::createComponent(): Creates a child component.
TComponent::dataBind(): Performs the databinding for this component.
TComponent::evaluateExpression(): Evaluates a PHP expression.
TComponent::evaluateStatements(): Evaluates a list of PHP statements.
TComponent::findObject(): Finds an object by its ID path.
TComponent::getApplication()
TComponent::getChild()
TComponent::getChildren()
TComponent::getDefinition(): Returns or builds a component definition.
TComponent::getGlobalization(): Returns the Globalization instance for the application.
TComponent::getID()
TComponent::getModule(): Returns the module object that contains the component or the page containing the component.
TComponent::getPage()
TComponent::getParent()
TComponent::getPropertyInitValue(): Gets the initial value of a property.
TComponent::getPropertyType(): Returns the type of a property
TComponent::getRequest(): Returns the request object associated with application.
TComponent::getServiceManager(): Returns the service manager for this application.
TComponent::getSession(): Returns the session object associated with the application.
TComponent::getSessionState(): Returns a session variable.
TComponent::getUniqueID(): Returns the unique ID of the component.
TComponent::getUser(): Returns the user object associated with the application.
TComponent::hasChildren()
TComponent::hasEvent(): Determines whether an event is defined.
TComponent::hasProperty(): Determines whether a property is defined.
TComponent::initProperties(): Initializes the property values.
TComponent::instantiateTemplate(): Parses a template string and instantiates the content.
TComponent::onDataBinding(): This method is invoked when dataBind is invoked for the component.
TComponent::raiseEvent(): Invokes all attached event handler functions for a particular event.
TComponent::removeChild(): Removes a child component.
TComponent::removeChildren(): Removes all child components.
TComponent::setAttribute(): Sets an attribute.
TComponent::setDefinition(): Sets a component definition.
TComponent::setID(): Sets a component ID.
TComponent::setParent(): Sets the parent of this component.
TComponent::setPropertyInitValue(): Sets the initial value of a property.
TComponent::setRoot(): Sets the root component in the component hierarchy.
TComponent::setSessionState(): Sets a session variable.
TComponent::unbindProperty(): Breaks the binding between a property and an expression.
TComponent::__get(): Returns a property value by name or a child component by ID.
TComponent::__set(): Sets value of a component property.

Class Methods

method evaluateIsValid [line 136]

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 ControlToValidate is not specified or the input data is empty.

return:	whether the validation succeeds
access:	public

Overrides TValidator::evaluateIsValid() (This is the major method for validation.)

[ Top ]

method getCurrencyValue [line 227]

float getCurrencyValue(
string
$value)

Parse the string into a currency value, return the float value of the currency.

return:	currency value.
access:	protected

Parameters:

string

$value

currency as string

[ Top ]

method getDateFormat [line 124]

string getDateFormat(
)

return:	the date validation date format if any
access:	public

[ Top ]

method getJsOptions [line 293]

ArrayObject getJsOptions(
)

Returns the attributes to be rendered as javascript.

This method overrides the parent's implementation.

return:	attributes to be rendered
access:	protected

Overrides TValidator::getJsOptions() (Get a list of options for the client-side javascript validator)

[ Top ]

method getMaxValue [line 77]

string getMaxValue(
)

return:	the maximum value of the validation range.
access:	public

[ Top ]

method getMinValue [line 60]

string getMinValue(
)

return:	the minimum value of the validation range.
access:	public

[ Top ]

method getValueType [line 95]

string getValueType(
)

return:	the data type that the values being compared are converted to before the comparison is made.
access:	public

[ Top ]

method isValidCurrency [line 208]

boolean isValidCurrency(
string
$value)

Determine if the value is a valid currency range,

return:	true if within range.
access:	protected

Parameters:

string

$value

currency value

[ Top ]

method isValidDate [line 241]

boolean isValidDate(
string
$value)

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

Parameters:

string

$value

date as string to validate

[ Top ]

method isValidDouble [line 189]

boolean isValidDouble(
string
$value)

Determine if the value is within the specified double range.

return:	true if within range.
access:	protected

Parameters:

string

$value

value to validate

[ Top ]

method isValidInteger [line 170]

boolean isValidInteger(
string
$value)

Determine if the value is within the integer range.

return:	true if within integer range.
access:	protected

Parameters:

string

$value

value to validate true

[ Top ]

method isValidString [line 275]

boolean isValidString(
string
$value)

Compare the string with a minimum and a maxiumum value.

Uses strcmp for comparision.

return:	true if the string is within range.
access:	protected

Parameters:

string

$value

value to compare with.

[ Top ]

method setDateFormat [line 116]

void setDateFormat(
string
$value)

Sets the date format for a date validation

access:

public

Parameters:

string

$value

the date format value

[ Top ]

method setMaxValue [line 86]

void setMaxValue(
string
$value)

Sets the maximum value of the validation range.

access:

public

Parameters:

string

$value

the maximum value

[ Top ]

method setMinValue [line 69]

void setMinValue(
string
$value)

Sets the minimum value of the validation range.

access:

public

Parameters:

string

$value

the minimum value

[ Top ]

method setValueType [line 105]

void setValueType(
string
$value)

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

access:

public

Parameters:

string

$value

the data type

[ Top ]