PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TActiveCustomValidator

TActiveCustomValidator Class

Performs custom validation using only server-side onServerValidate onServerValidate validation event. The client-side uses callbacks to raise the onServerValidate onServerValidate event.

Beware that the onServerValidate onServerValidate may be raised when the control to validate on the client side changes value, that is, the server validation may be called many times.

After the callback or postback, the onServerValidate onServerValidate is raised once more. The getIsCallback IsCallback property will be true when validation is made during a callback request.

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TLabel implements IDataRenderer
Extended by TBaseValidator implements IValidator
Extended by TCustomValidator
Extended by TActiveCustomValidator implements ICallbackEventHandler, IActiveControl
Package: System\Web\UI\ActiveControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Wei Zhuo <weizhuo[at]gmail[dot]com>
Since: 3.1
Located at Web/UI/ActiveControls/TActiveCustomValidator.php
Methods summary
public boolean
# getIsCallback( )

Returns

boolean
true if validation is made during a callback request.
public
# __construct( )

Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.

Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.

Overrides

TBaseValidator::__construct()
public TBaseActiveCallbackControl
# getActiveControl( )

Returns

TBaseActiveCallbackControl
standard callback control options.

Implementation of

IActiveControl::getActiveControl()
public TCallbackClientSide
# getClientSide( )

Returns

TCallbackClientSide
client side request options.

Overrides

TBaseValidator::getClientSide()
public
# setClientValidationFunction( string $value )

Client validation function is NOT supported.

Client validation function is NOT supported.

Parameters

$value
string
the script function name

Overrides

TCustomValidator::setClientValidationFunction()
public
# raiseCallbackEvent( TCallbackEventParameter $param )

Raises the callback event. This method is required by ICallbackEventHandler interface. The onServerValidate OnServerValidate event is raised first and then the onCallback OnCallback event. This method is mainly used by framework and control developers.

Raises the callback event. This method is required by ICallbackEventHandler interface. The onServerValidate OnServerValidate event is raised first and then the onCallback OnCallback event. This method is mainly used by framework and control developers.

Parameters

$param
TCallbackEventParameter
the event parameter

Implementation of

ICallbackEventHandler::raiseCallbackEvent()
public
# setIsValid( boolean $value )

Parameters

$value
boolean
whether the value is valid; this method will trigger a clientside update if needed

Overrides

TBaseValidator::setIsValid()
public
# onCallback( TCallbackEventParameter $param )

This method is invoked when a callback is requested. The method raises 'OnCallback' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.

This method is invoked when a callback is requested. The method raises 'OnCallback' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.

Parameters

$param
TCallbackEventParameter
event parameter to be passed to the event handlers
protected array
# getClientScriptOptions( )

Returns an array of javascript validator options.

Returns an array of javascript validator options.

Returns

array
javascript validator options.

Overrides

TCustomValidator::getClientScriptOptions()
public
# setErrorMessage( string $value )

Sets the text for the error message. Updates client-side erorr message.

Sets the text for the error message. Updates client-side erorr message.

Parameters

$value
string
the error message

Overrides

TBaseValidator::setErrorMessage()
public boolean
# getEnableClientScript( )

It's mandatory for the EnableClientScript to be activated or the TActiveCustomValidator won't work.

It's mandatory for the EnableClientScript to be activated or the TActiveCustomValidator won't work.

Returns

boolean
whether client-side validation is enabled.

Overrides

TBaseValidator::getEnableClientScript()
protected
# addAttributesToRender( THtmlWriter $writer )

Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.

Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.

Parameters

$writer
THtmlWriter
the renderer

Throws

TInvalidDataValueException
if associated control cannot be found using the ID

Overrides

TBaseValidator::addAttributesToRender()
protected string
# getClientClassName( )

Returns

string
corresponding javascript class name for this this.

Overrides

TCustomValidator::getClientClassName()
Methods inherited from TCustomValidator
evaluateIsValid(), getClientValidationFunction(), getValidationTarget(), onServerValidate(), registerClientScriptValidator()
Methods inherited from TBaseValidator
createClientSide(), getControlCssClass(), getControlToValidate(), getDisplay(), getErrorMessage(), getFocusElementID(), getFocusOnError(), getIsValid(), getValidationGroup(), getValidationValue(), onInit(), onPreRender(), onUnload(), onValidate(), onValidationError(), onValidationSuccess(), renderClientControlScript(), renderContents(), setControlCssClass(), setControlToValidate(), setDisplay(), setEnableClientScript(), setEnabled(), setFocusElementID(), setFocusOnError(), setForControl(), setValidationGroup(), updateControlCssClass(), validate()
Methods inherited from TLabel
getData(), getForControl(), getTagName(), getText(), render(), setData(), setText()
Methods inherited from TWebControl
clearStyle(), copyBaseAttributes(), createStyle(), getAccessKey(), getBackColor(), getBorderColor(), getBorderStyle(), getBorderWidth(), getCssClass(), getDecorator(), getEnsureId(), getFont(), getForeColor(), getHasStyle(), getHeight(), getStyle(), getTabIndex(), getToolTip(), getWidth(), renderBeginTag(), renderEndTag(), setAccessKey(), setBackColor(), setBorderColor(), setBorderStyle(), setBorderWidth(), setCssClass(), setEnsureId(), setForeColor(), setHeight(), setStyle(), setTabIndex(), setToolTip(), setWidth()
Methods inherited from TControl
__get(), addParsedObject(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), bubbleEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createChildControls(), createControlCollection(), dataBind(), dataBindChildren(), dataBindProperties(), ensureChildControls(), findControl(), findControlsByID(), findControlsByType(), focus(), getAdapter(), getAllowChildControls(), getAttribute(), getAttributes(), getChildControlsCreated(), getClientID(), getControlStage(), getControlState(), getControls(), getCustomData(), getEnableTheming(), getEnableViewState(), getEnabled(), getHasAdapter(), getHasAttributes(), getHasChildInitialized(), getHasControls(), getHasInitialized(), getHasLoaded(), getHasLoadedPostData(), getHasPreRendered(), getID(), getIsSkinApplied(), getNamingContainer(), getPage(), getParent(), getRegisteredObject(), getSkinID(), getSourceTemplateControl(), getTemplateControl(), getUniqueID(), getViewState(), getVisible(), hasAttribute(), initRecursive(), isDescendentOf(), isObjectRegistered(), loadRecursive(), loadState(), loadStateRecursive(), onDataBinding(), onLoad(), preRenderRecursive(), raiseBubbleEvent(), registerObject(), removeAttribute(), removedControl(), renderChildren(), renderControl(), saveState(), saveStateRecursive(), setAdapter(), setAttribute(), setChildControlsCreated(), setControlStage(), setControlState(), setCustomData(), setEnableTheming(), setEnableViewState(), setID(), setPage(), setSkinID(), setTemplateControl(), setViewState(), setVisible(), trackViewState(), traverseChildControls(), unbindProperty(), unloadRecursive(), unregisterObject()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __destruct(), __isset(), __set(), __sleep(), __unset(), __wakeup(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TControl
AUTOMATIC_ID_PREFIX, CLIENT_ID_SEPARATOR, CS_CHILD_INITIALIZED, CS_CONSTRUCTED, CS_INITIALIZED, CS_LOADED, CS_PRERENDERED, CS_STATE_LOADED, ID_FORMAT, ID_SEPARATOR, IS_CHILD_CREATED, IS_CREATING_CHILD, IS_DISABLE_THEMING, IS_DISABLE_VIEWSTATE, IS_ID_SET, IS_SKIN_APPLIED, IS_STYLESHEET_APPLIED, RF_ADAPTER, RF_AUTO_BINDINGS, RF_CHILD_STATE, RF_CONTROLS, RF_CONTROLSTATE, RF_DATA_BINDINGS, RF_EVENTS, RF_NAMED_CONTROLS, RF_NAMED_CONTROLS_ID, RF_NAMED_OBJECTS, RF_SKIN_ID
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Properties inherited from TWebControl
$_decorator
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO