Index: openacs-4/packages/acs-templating/www/doc/TclDocs/request.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/TclDocs/request.html,v diff -u -r1.1 -r1.2 --- openacs-4/packages/acs-templating/www/doc/TclDocs/request.html 13 Mar 2001 22:59:27 -0000 1.1 +++ openacs-4/packages/acs-templating/www/doc/TclDocs/request.html 19 Jan 2002 23:45:46 -0000 1.2 @@ -27,15 +27,15 @@ Listing of public methods:
- template::request::create
+
- template::request::error
+
- template::request::get_param
+
- template::request::is_valid
+
- template::request::set_param
+
@@ -47,61 +47,58 @@ Public Methods:
- template::request::create +
-Create the request data structure. Typically called at the beginning of the code for any page that accepts query parameters. +Checks for any param errors. If errors are found, sets the display template to the specified URL (a system-wide request error page by default).
-
Options: + Parameters: - - + + - A block of parameter declarations, separated by newlines. Equivalent to calling set_param for each parameter, but requiring slightly less typing. - -
params +
url + * + + The URL of the template to use to display error messages. The special value { self} may be used to indicate that the template for the requested page itself will handle reporting error conditions.
+
+
Returns: +
+ 1 if no error conditions exist, 0 otherwise. +

- template::request::error +
-Manually report request error(s) by setting error messages and then calling is_valid to handle display. Useful for conditions not tied to a single query parameter. The arguments to the procedure may be any number of name-message combinations. +Create the request data structure. Typically called at the beginning of the code for any page that accepts query parameters.
- Parameters: +
Options: - - - + + - - + A block of parameter declarations, separated by newlines. Equivalent to calling set_param for each parameter, but requiring slightly less typing. -
name - * - - A unique identifier for the error condition, which may be used for layout purposes.
params -
msg - * - - The message text associated with the condition.
+
@@ -110,13 +107,13 @@

+ The name of the parameter to declare.
- template::request::get_param +
-Retrieves the value(s) of the specified parameter. +Declares a query parameter as part of the page request. Validates the values associated with the parameter, in the same fashion as for form elements.
@@ -128,61 +125,93 @@ *
 - The name of the parameter.
-

Returns: -
- The value of the specified parameter. +
Options: + + + + + + + + + + + + + + + + + +
name + + The name of parameter in the query (may be different from the reference name).
multiple + + A flag indicating that multiple values may be specified for this parameter.
datatype + + The name of a datatype for the element values. Valid datatypes must have a validation procedure defined in the template::data::validate namespace.
optional + + A flag indicating that no value is required for this element. If a default value is specified, the default is used instead.
validate + + A list of custom validation blocks in the form { name { expression } { message } \ name { expression } { message } ...} where name is a unique identifier for the validation step, expression is a block to Tcl code that evaluates to 1 or 0, and message is to be displayed to the user when the validation step fails.
+
See Also: + +
element::create -

- template::request::is_valid +
-Checks for any param errors. If errors are found, sets the display template to the specified URL (a system-wide request error page by default). +Manually report request error(s) by setting error messages and then calling is_valid to handle display. Useful for conditions not tied to a single query parameter. The arguments to the procedure may be any number of name-message combinations.
Parameters: - + A unique identifier for the error condition, which may be used for layout purposes. + + + +
url + name * - The URL of the template to use to display error messages. The special value { self} may be used to indicate that the template for the requested page itself will handle reporting error conditions.
msg + * + + The message text associated with the condition.
-
Returns: -
- 1 if no error conditions exist, 0 otherwise. -

+ The name of the parameter.
- template::request::set_param +
-Declares a query parameter as part of the page request. Validates the values associated with the parameter, in the same fashion as for form elements. +Retrieves the value(s) of the specified parameter.
@@ -194,43 +223,14 @@ *
 - The name of the parameter to declare.
-

Options: - - - - - - - - - - - - - - - - - -
name - - The name of parameter in the query (may be different from the reference name).
multiple - - A flag indicating that multiple values may be specified for this parameter.
datatype - - The name of a datatype for the element values. Valid datatypes must have a validation procedure defined in the template::data::validate namespace.
optional - - A flag indicating that no value is required for this element. If a default value is specified, the default is used instead.
validate - - A list of custom validation blocks in the form { name { expression } { message } \ name { expression } { message } ...} where name is a unique identifier for the validation step, expression is a block to Tcl code that evaluates to 1 or 0, and message is to be displayed to the user when the validation step fails.
+
Returns: +
+ The value of the specified parameter. -
See Also: - -
element::create -