From 9d42606405caa3f0deadd0241ef3b763f45d1a97 Mon Sep 17 00:00:00 2001 From: wei <> Date: Thu, 27 Apr 2006 13:14:29 +0000 Subject: Add effects to validation summary. --- framework/Web/UI/WebControls/TBaseValidator.php | 69 +++++++++-- .../Web/UI/WebControls/TValidationSummary.php | 129 +++++++++++++++++++++ 2 files changed, 190 insertions(+), 8 deletions(-) (limited to 'framework/Web/UI/WebControls') diff --git a/framework/Web/UI/WebControls/TBaseValidator.php b/framework/Web/UI/WebControls/TBaseValidator.php index 4ca4c1f6..01d1b978 100644 --- a/framework/Web/UI/WebControls/TBaseValidator.php +++ b/framework/Web/UI/WebControls/TBaseValidator.php @@ -43,7 +43,7 @@ * * You can also customized the client-side behaviour by adding javascript * code to the subproperties of the {@link getClientValidation ClientValidation} - * property. + * property. See quickstart documentation for further details. * * You can also place a {@link TValidationSummary} control on a page to display error messages * from the validators together. In this case, only the {@link setErrorMessage ErrorMessage} @@ -79,7 +79,9 @@ abstract class TBaseValidator extends TLabel implements IValidator * @var boolean whether the validator has been registered with the page */ private $_registered=false; - + /** + * @var TValidatorClientScript validator client-script options. + */ private $_clientScript; /** @@ -186,7 +188,7 @@ abstract class TBaseValidator extends TLabel implements IValidator */ protected function createClientScript() { - return new TValidatorClientScript($this->getPage()->getClientScript()); + return new TValidatorClientScript; } /** @@ -491,7 +493,21 @@ abstract class TBaseValidator extends TLabel implements IValidator /** * TValidatorClientScript class. * - * @todo Add doc to quickstart and classes. + * Client-side validator events can be modified through the {@link + * TBaseValidator::getClientValidation ClientValidation} property of a + * validator. The subproperties of ClientValidation are those of the + * TValidatorClientScript properties. The client-side validator supports the + * following events. + * + * The OnValidate event is raise before the validator validation + * functions are called. + * + * The OnSuccess event is raised after the validator has successfully + * validate the control. + * + * The OnError event is raised after the validator fails validation. + * + * See the quickstart documentation for further details. * * @author Wei Zhuo * @version $Revision: $ $Date: $ @@ -500,51 +516,88 @@ abstract class TBaseValidator extends TLabel implements IValidator */ class TValidatorClientScript extends TComponent { + /** + * @var TMap client-side validator event javascript code. + */ private $_options; - private $_manager; - private $_effectsEnabled = false; - public function __construct($manager) + /** + * Constructor. + */ + public function __construct() { $this->_options = new TMap; - $this->_manager = $manager; } + /** + * @return string javascript code for client-side OnValidate event. + */ public function getOnValidate() { return $this->_options->itemAt['OnValidate']; } + /** + * Client-side OnValidate validator event is raise before the validators + * validation functions are called. + * @param string javascript code for client-side OnValidate event. + */ public function setOnValidate($javascript) { $this->_options->add('OnValidate', $this->ensureFunction($javascript)); } + /** + * Client-side OnSuccess event is raise after validation is successfull. + * This will override the default client-side validator behaviour. + * @param string javascript code for client-side OnSuccess event. + */ public function setOnSuccess($javascript) { $this->_options->add('OnSuccess', $this->ensureFunction($javascript)); } + /** + * @return string javascript code for client-side OnSuccess event. + */ public function getOnSuccess() { return $this->_options->itemAt('OnSuccess'); } + /** + * Client-side OnError event is raised after validation failure. + * This will override the default client-side validator behaviour. + * @param string javascript code for client-side OnError event. + */ public function setOnError($javascript) { $this->_options->add('OnError', $this->ensureFunction($javascript)); } + /** + * @return string javascript code for client-side OnError event. + */ public function getOnError() { return $this->_options->itemAt('OnError'); } + /** + * @return array list of client-side event code. + */ public function getOptions() { return $this->_options->toArray(); } + /** + * Ensure the string is a valid javascript function. If the string begins + * with "javascript:" valid javascript function is assumed, otherwise the + * code block is enclosed with "function(validator, invoker){ }" block. + * @param string javascript code. + * @return string javascript function code. + */ private function ensureFunction($javascript) { if(TJavascript::isFunction($javascript)) diff --git a/framework/Web/UI/WebControls/TValidationSummary.php b/framework/Web/UI/WebControls/TValidationSummary.php index 2bc3f62c..aa46142b 100644 --- a/framework/Web/UI/WebControls/TValidationSummary.php +++ b/framework/Web/UI/WebControls/TValidationSummary.php @@ -36,6 +36,11 @@ */ class TValidationSummary extends TWebControl { + /** + * @var TValidatorClientScript validator client-script options. + */ + private $_clientScript; + /** * Constructor. * This method sets the foreground color to red. @@ -242,9 +247,32 @@ class TValidationSummary extends TWebControl $options['Refresh'] = $this->getAutoUpdate(); $options['ValidationGroup'] = $this->getValidationGroup(); $options['Display'] = $this->getDisplay(); + + if(!is_null($this->_clientScript)) + $options = array_merge($options,$this->_clientScript->getOptions()); + return $options; } + /** + * @return TValidationSummaryClientScript client-side validation summary + * event options. + */ + public function getClientValidation() + { + if(is_null($this->_clientScript)) + $this->_clientScript = $this->createClientScript(); + return $this->_clientScript; + } + + /** + * @return TValidationSummaryClientScript javascript validation summary + * event options. + */ + protected function createClientScript() + { + return new TValidationSummaryClientScript; + } /** * Get the list of validation error messages. * @return array list of validator error messages. @@ -343,4 +371,105 @@ class TValidationSummary extends TWebControl } } +/** + * TValidationSummaryClientScript class. + * + * Client-side validation summary events such as {@link setOnHideSummary + * OnHideSummary} and {@link setOnShowSummary OnShowSummary} can be modified + * through the {@link TBaseValidator:: getClientValidation ClientValidation} + * property of a validation summary. + * + * The OnHideSummary event is raise when the validation summary + * requests to hide the messages. + * + * The OnShowSummary event is raised when the validation summary + * requests to show the messages. + * + * See the quickstart documentation for further details. + * + * @author Wei Zhuo + * @version $Revision: $ $Date: $ + * @package System.Web.UI.WebControls + * @since 3.0 + */ +class TValidationSummaryClientScript extends TComponent +{ + /** + * @var TMap client-side validation summary event javascript code. + */ + private $_options; + + /** + * Constructor. + */ + public function __construct() + { + $this->_options = new TMap; + } + + /** + * @return string javascript code for client-side OnHideSummary event. + */ + public function getOnHideSummary() + { + return $this->_options->itemAt['OnHideSummary']; + } + + /** + * Client-side OnHideSummary validation summary event is raise when all the + * validators are valid. This will override the default client-side + * validation summary behaviour. + * @param string javascript code for client-side OnHideSummary event. + */ + public function setOnHideSummary($javascript) + { + $this->_options->add('OnHideSummary', $this->ensureFunction($javascript)); + } + + /** + * Client-side OnShowSummary event is raise when one or more validators are + * not valid. This will override the default client-side validation summary + * behaviour. + * @param string javascript code for client-side OnShowSummary event. + */ + public function setOnShowSummary($javascript) + { + $this->_options->add('OnShowSummary', $this->ensureFunction($javascript)); + } + + /** + * @return string javascript code for client-side OnShowSummary event. + */ + public function getOnShowSummary() + { + return $this->_options->itemAt('OnShowSummary'); + } + + /** + * @return array list of client-side event code. + */ + public function getOptions() + { + return $this->_options->toArray(); + } + + /** + * Ensure the string is a valid javascript function. If the string begins + * with "javascript:" valid javascript function is assumed, otherwise the + * code block is enclosed with "function(summary, validators){ }" block. + * @param string javascript code. + * @return string javascript function code. + */ + private function ensureFunction($javascript) + { + if(TJavascript::isFunction($javascript)) + return $javascript; + else + { + $code = "function(summary, validators){ {$javascript} }"; + return TJavascript::quoteFunction($code); + } + } +} + ?> \ No newline at end of file -- cgit v1.2.3