Class TRegularExpressionValidator

Description

TRegularExpressionValidator class

TRegularExpressionValidator validates whether the value of an associated input component matches the pattern specified by a regular expression.

You can specify the regular expression by setting the RegularExpression property. Some commonly used regular expressions include:

 French Phone Number: (0( \d|\d ))?\d\d \d\d(\d \d| \d\d )\d\d
 French Postal Code: \d{5}
 German Phone Number: ((\(0\d\d\) |(\(0\d{3}\) )?\d )?\d\d \d\d \d\d|\(0\d{4}\) \d \d\d-\d\d?)
 German Postal Code: (D-)?\d{5}
 Email Address: \w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*
 Japanese Phone Number: (0\d{1,4}-|\(0\d{1,4}\) ?)?\d{1,4}-\d{4}
 Japanese Postal Code: \d{3}(-(\d{4}|\d{2}))?
 P.R.C. Phone Number: (\(\d{3}\)|\d{3}-)?\d{8}
 P.R.C. Postal Code: \d{6}
 P.R.C. Social Security Number: \d{18}|\d{15}
 U.S. Phone Number: ((\(\d{3}\) ?)|(\d{3}-))?\d{3}-\d{4}
 U.S. ZIP Code: \d{5}(-\d{4})?
 U.S. Social Security Number: \d{3}-\d{2}-\d{4}

Note, the validation succeeds if the associated input control contains empty input. Use a TRequiredFieldValidator to ensure the input is not empty.

  • since: 3.0
  • version: $Id: TRegularExpressionValidator.php 1892 2007-05-01 03:19:30Z wei $
  • author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/UI/WebControls/TRegularExpressionValidator.php (line 50)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TLabel
               |
               --TBaseValidator
                  |
                  --TRegularExpressionValidator
Direct descendents
Class Description
TEmailAddressValidator TEmailAddressValidator class
Method Summary
boolean evaluateIsValid ()
string getClientClassName ()
void setPatternModifiers (string $value)
void setRegularExpression (string $value)
Methods
evaluateIsValid (line 85)

This method overrides the parent's implementation.

The validation succeeds if the input data matches the regular expression. The validation always succeeds if ControlToValidate is not specified or the regular expression is empty, or the input data is empty.

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

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

Redefined in descendants as:
getClientClassName (line 57)

Gets the name of the javascript class responsible for performing validation for this control.

This method overrides the parent implementation.

  • return: the javascript class name
  • access: protected
string getClientClassName ()

Redefinition of:
TBaseValidator::getClientClassName()
Gets the name of the javascript class responsible for performing validation for this control.

Redefined in descendants as:
getClientScriptOptions (line 119)

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.
getPatternModifiers (line 110)
  • return: pattern modifiers, no modifiers by default.
  • access: public
string getPatternModifiers ()
getRegularExpression (line 65)
  • return: the regular expression that determines the pattern used to validate a field.
  • access: public
string getRegularExpression ()

Redefined in descendants as:
setPatternModifiers (line 102)
  • access: public
void setPatternModifiers (string $value)
  • string $value: pattern modifiers, see http://www.php.net/manual/en/reference.pcre.pattern.modifiers.php
setRegularExpression (line 73)
  • access: public
void setRegularExpression (string $value)
  • string $value: the regular expression that determines the pattern used to validate a field.

Inherited Methods

Inherited From TBaseValidator

TBaseValidator::__construct()
TBaseValidator::addAttributesToRender()
TBaseValidator::createClientSide()
TBaseValidator::evaluateIsValid()
TBaseValidator::getClientClassName()
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::onValidate()
TBaseValidator::onValidationError()
TBaseValidator::onValidationSuccess()
TBaseValidator::registerClientScriptValidator()
TBaseValidator::renderClientControlScript()
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::getData()
TLabel::getForControl()
TLabel::getTagName()
TLabel::getText()
TLabel::render()
TLabel::renderContents()
TLabel::setData()
TLabel::setForControl()
TLabel::setText()

Inherited From TWebControl

TWebControl::addAttributesToRender()
TWebControl::clearStyle()
TWebControl::copyBaseAttributes()
TWebControl::createStyle()
TWebControl::getAccessKey()
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getDisplay()
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::setDisplay()
TWebControl::setForeColor()
TWebControl::setHeight()
TWebControl::setStyle()
TWebControl::setTabIndex()
TWebControl::setToolTip()
TWebControl::setWidth()

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::addToPostDataLoader()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::convertUniqueIdToClientId()
TControl::createChildControls()
TControl::createControlCollection()
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::getCustomData()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasChildInitialized()
TControl::getHasControls()
TControl::getHasInitialized()
TControl::getHasLoaded()
TControl::getHasLoadedPostData()
TControl::getHasPreRendered()
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::setCustomData()
TControl::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
TControl::trackViewState()
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::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
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

Documentation generated on Mon, 21 Apr 2008 11:35:58 -0400 by phpDocumentor 1.3.0RC4