Dispatch procedure for the transform method. "transformation" in template systemspeak means to convert the submitted data to the custom datatype structure, usually a list for complex datatypes, just the value for simple datatypes. The transform method is called after the datatype is validated.

Parameters:

type (required)

The data type to be transformed.

value_ref (required)

Testcases:

No testcase defined.

This proc invokes the validation code for a given type.

Parameters:

type (required)

value_ref (required)

message_ref (required)

See Also:

• template::data::validate::boolean
• template::data::validate::date
• template::data::validate::email
• template::data::validate::enumeration
• template::data::validate::filename
• template::data::validate::float
• template::data::validate::integer
• template::data::validate::keyword
• template::data::validate::naturalnum
• template::data::validate::number
• template::data::validate::search
• template::data::validate::string
• template::data::validate::nomarkup
• template::data::validate::text
• template::data::validate::textdate
• template::data::validate::timestamp
• template::data::validate::time_of_day
• template::data::validate::url
• template::data::validate::oneof

Testcases:

validate_boolean, validate_email, validate_integer, validate_naturalnum, validate_float, validate_number, validate_text, validate_search, validate_file, validate_keyword, validate_filename, validate_url, validate_url_element, validate_date, validate_enumeration, validate_textdate, validate_oneof, validate_currency

Validates boolean data types.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Author:

Roberto Mello

Testcases:

validate_boolean

Validate that a submitted date conforms to the template system's notion of what a date should be.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Testcases:

validate_date

Validate that a submitted email address is syntactically correct.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Testcases:

validate_email

Validate enumeration as a unique csv alphanum list.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Testcases:

validate_enumeration

Validate that a submitted filename consists of alphanumeric, "_", or "-" characters.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Testcases:

validate_filename

Validate that a submitted fla contains only an optional sign, and a whole part and fractional part.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Testcases:

validate_float

Validate that a submitted integer contains only an optional sign and the digits 0-9.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Testcases:

validate_integer

Validate that a submitted keyword consists of alphnumeric or "_" characters.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Testcases:

validate_keyword

Validates natural numbers data types. Will trim leading 0 in order to avoid Tcl interpreting it as octal (code borrowed from ad_page_contract_filter_proc_naturalnum)

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Author:

Rocael Hernandez

Testcases:

validate_naturalnum

Checks if supplied string contains markup.

Parameters:

value_ref (required)

message_ref (required)

Author:

Guenter Ernst

Testcases:

No testcase defined.

Validate number - any float - should be any rational number?

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Testcases:

validate_number

Checks whether the submitted value is contained in the list of values provided via the "-options" parameter of "::template::element::create". If it is set an error is thrown.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

See Also:

• template::element::create

Testcases:

validate_oneof

It was necessary to declare a datatype of "search" in order for the transformation to be applied correctly. In reality, the transformation should be on the element, not on the datatype. DRB: in practice a template form datatype is defined by the presence of a validate procedure for that type.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1)

Testcases:

validate_search

Validate that a submitted string is valid. Hmmm ... all submitted strings are valid, that's easy!

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1)

Testcases:

validate_text

Validate that submitted text is valid. Hmmm ... all submitted text is valid, that's easy!

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1)

Testcases:

validate_text

Validate that a submitted textdate if properly formatted.

Parameters:

value_ref (required)

Reference variable to the submitted value.

message_ref (required)

Reference variable for returning an error message.

Returns:

True (1) if valid, false (0) if not.

Testcases:

validate_textdate

Validate time of day.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Testcases:

validate_date

Validate that a submitted date conforms to the template system's notion of what a date should be.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Testcases:

validate_date

Validate that a submitted url is correct. Accepts an optional http:// or https:// prefix, path, and query string.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Testcases:

validate_url

Beautiful URL elements that may only contain lowercase characters, numbers and hyphens.

Parameters:

value_ref (required)

Reference variable to the submitted value

message_ref (required)

Reference variable for returning an error message

Returns:

True (1) if valid, false (0) if not

Author:

Tilmann Singer

See Also:

• util_text_to_url if you want to offer auto-generation of URLs based on a pretty name

Testcases:

validate_url_element