---

Class ::xo::Context

::xo::Context create ... \
           [ -actual_query (default " ") ] \
           [ -invoke_object invoke_object ] \
           [ -locale locale ] \
           [ -package_id (default "0") ] \
           [ -parameter_declaration (default "") ]

This class provides a context for evaluation, somewhat similar to an activation record in programming languages. It combines the parameter declaration (e.g. of a page, an includelet) with the actual parameters (specified in an includelet) and the provided query values (from the url). The parameter decaration are actually XOTcl's non positional arguments.

Defined in packages/xotcl-core/tcl/context-procs.tcl

Class Relations

• class: ::xotcl::Class
• superclass: ::xotcl::Object
• subclass: ::xowiki::Includelet, ::xo::ConnectionContext

Methods (to be applied on instances)

• exists_query_parameter (scripted)

   <instance of xo::Context> exists_query_parameter

  Partial Call Graph (max 5 caller/called nodes):

  Testcases:

  test_xo_cc, xotcl-core

• export_vars (scripted, public)

   <instance of xo::Context> export_vars [ -all ] [ -level level ]

  Export either the declared query variables (default) or all (when explicitly demanded).

  Switches:

  -all

  (optional)

  when specified, export all query variables

  -level

  (defaults to "1") (optional)

  target level

  Partial Call Graph (max 5 caller/called nodes):

  Testcases:

  package_normalize_path, xowiki_test_cases, link_tests, slot_interactions, path_resolve

• get_parameters (scripted, public)

   <instance of xo::Context> get_parameters

  Convenience routine for includelets. It combines the actual parameters from the call in the page (highest priority) with the values from the url (second priority) and the default values from the signature.

  Partial Call Graph (max 5 caller/called nodes):

  Testcases:

  xowiki_test_cases

• invoke_object (setter)

   <instance of xo::Context> invoke_object

  Partial Call Graph (max 5 caller/called nodes):

  Testcases:

  create_folder_with_page, xowf, create_workflow_with_instance, create_form_with_form_instance

• original_url_and_query (scripted)

   <instance of xo::Context> original_url_and_query

  Partial Call Graph (max 5 caller/called nodes):

  Testcases:

  package_normalize_path, xowiki, xowiki_test_cases, link_tests, slot_interactions, path_resolve

• package_id (setter)

   <instance of xo::Context> package_id

  Partial Call Graph (max 5 caller/called nodes):

  Testcases:

  xotcl_core_tutorial_2, xotcl-core, xowiki_test_cases, link_tests

• process_query_parameter (scripted)

   <instance of xo::Context> process_query_parameter

  Partial Call Graph (max 5 caller/called nodes):

  Testcases:

  api__context, xotcl-core

---