xo::ConnectionContext instproc form_parameter (public)

 <instance of xo::ConnectionContext[i]> form_parameter spec \
    [ default ]

Defined in /var/www/openacs/packages/xotcl-core/tcl/context-procs.tcl

Read a form parameter, loading the request form on demand.

Parameters:
spec (required)
Parameter name, optionally followed by :constraint.
default (optional)
Value to return when the parameter is absent.
Returns:
The value, or a list for a parameter marked as multiple.

Testcases:
create_workflow_with_instance, xowiki_test_cases
Source code:
:require_form_parameter

set name $spec
regexp {^([^:]+):(.*)$} $spec . name constraint

if {[info exists :form_parameter($name)]} {
  if {[info exists :form_parameter_multiple($name)]} {
    set value [set :form_parameter($name)]
  } else {
    set value [lindex [set :form_parameter($name)] 0]
  }
  if {[info exists constraint]} {
    set r [xo::validate_parameter_constraints $name $constraint $value]
    if {$r ne $value} {
      ns_log notice "converting value checker: form parameter validate <$spec> -> '$value' -> '$r'"
      set value $r
    }
  } else {
    #:msg "FORM_PARAMETER spec <$spec> no constraint -> '$value'"
  }
  return $value
} else {
  return $default
}
XQL Not present:
Generic, PostgreSQL, Oracle
[ hide source ] | [ make this the default ]
Show another procedure: