Class: TCompareValidator

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

Class Overview

TComponent
   |
   --TControl
      |
      --TWebControl
         |
         --TValidator
            |
            --TCompareValidator

TCompareValidator class

Class Details

[line 70]
TCompareValidator class

TCompareValidator compares the value entered by the user into an input component with the value entered into another input component or a constant value. To specify the input component to validate, set the ControlToValidate property to the ID of the input component.

To compare the associated input component with another input component, set the ControlToCompare property to the ID of the component to compare with.

To compare the associated input component with a constant value, specify the constant value to compare with by setting the ValueToCompare property.

The ValueType 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.
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.

Use the Operator property to specify the type of comparison to perform, such as Equal, NotEqual, GreaterThan, GreaterThanEqual, LessThan, LessThanEqual, DataTypeCheck. If you set the Operator property to DataTypeCheck, the TCompareValidator component will ignore the ControlToCompare and ValueToCompare properties and simply indicates whether the value entered into the input component can be converted to the data type specified by the ValueType property.

Namespace: System.Web.UI.WebControls

Properties

ControlToCompare, string, kept in viewstate
Gets or sets the input component to compare with the input control being validated.
ValueToCompare, string, kept in viewstate
Gets or sets a constant value to compare with the value entered by the user into the input component being validated.
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.
Operator, string, default=Equal, kept in viewstate
Gets or sets the comparison operation to perform (Equal, NotEqual, GreaterThan, GreaterThanEqual, LessThan, LessThanEqual, DataTypeCheck)

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 evaluateDataTypeCheck [line 217]

boolean evaluateDataTypeCheck(
string
$value)

Determine if the given value is of a particular type using RegExp.

return:	true if value fits the type expression.
access:	protected

Parameters:

string

$value

value to check

[ Top ]

method evaluateIsValid [line 168]

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.

return:	whether the validation succeeds
access:	public

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

[ Top ]

method getComparisonValues [line 244]

array getComparisonValues(
string
$value1, string
$value2)

Parse the pair of values into the appropriate value type.

return:	appropriate type of the value pair, array($value1, $value2);
access:	protected

Parameters:

string	$value1	value one
string	$value2	second value

[ Top ]

method getControlToCompare [line 94]

string getControlToCompare(
)

return:	the input component to compare with the input control being validated.
access:	public

[ Top ]

method getDateFormat [line 156]

string getDateFormat(
)

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

[ Top ]

method getJsOptions [line 277]

array getJsOptions(
)

Get a list of options for the client-side javascript validator

return:	list of options for the validator
access:	protected

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

[ Top ]

method getOperator [line 128]

string getOperator(
)

return:	the comparison operation to perform (Equal, NotEqual, GreaterThan, GreaterThanEqual, LessThan, LessThanEqual, DataTypeCheck)
access:	public

[ Top ]

method getValueToCompare [line 111]

string getValueToCompare(
)

return:	the constant value to compare with the value entered by the user into the input component being validated.
access:	public

[ Top ]

method getValueType [line 75]

string getValueType(
)

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

[ Top ]

method onPreRender [line 304]

void onPreRender(
mixed
$param)

Update the control to compare Css class. Override and calls parent onPreRender.

access:

public

Overrides TValidator::onPreRender() (Overrides parent implementation by registering necessary Javascripts for validation.)

[ Top ]

method setControlToCompare [line 103]

void setControlToCompare(
string
$value)

Sets the input component to compare with the input control being validated.

access:

public

Parameters:

string

$value

the ID path of the component to compare with

[ Top ]

method setDateFormat [line 148]

void setDateFormat(
string
$value)

Sets the date format for a date validation

access:

public

Parameters:

string

$value

the date format value

[ Top ]

method setOperator [line 137]

void setOperator(
string
$value)

Sets the comparison operation to perform (Equal, NotEqual, GreaterThan, GreaterThanEqual, LessThan, LessThanEqual, DataTypeCheck)

access:

public

Parameters:

string

$value

the comparison operation

[ Top ]

method setValueToCompare [line 120]

void setValueToCompare(
string
$value)

Sets the constant value to compare with the value entered by the user into the input component being validated.

access:

public

Parameters:

string

$value

the constant value

[ Top ]

method setValueType [line 84]

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 ]