---

Class ::xo::ConnectionContext

::xo::ConnectionContext create ... \
           [ -mobile mobile ] \
           [ -requester requester ] \
           [ -url url ] \
           [ -user user ] \
           [ -user_id user_id ]

Defined in

Class Relations

• class: ::xotcl::Class
• superclass: ::xo::Context

Methods (to be applied on the object)

• require (scripted)

   xo::ConnectionContext require

  Testcases:

  test_xo_cc, xotcl-core

• require_package_id_from_url (scripted)

Methods (to be applied on instances)

• cache (scripted)

• cache_exists (scripted)

• cache_get (scripted)

• cache_set (scripted)

• cache_unset (scripted)

• eval_as_user (scripted, public)

   <instance of xo::ConnectionContext> eval_as_user \
      [ -user_id user_id ] cmd

  Run a command as the specified different user. Essentially, this method updates xo::cc and the ad_conn array array with the specified user, runs the command and resets the user to the previous value.

  Switches:

  -user_id (optional, integer)

  switch temporarily to this user

  Parameters:

  cmd (required)

  command to be exevuted

  Testcases:

  create_test_items

• exists_form_parameter (scripted)

• exists_parameter (scripted)

• form_parameter (scripted)

   <instance of xo::ConnectionContext> form_parameter

  Testcases:

  create_workflow_with_instance, xowf, xowiki_test_cases

• get_all_form_parameter (scripted)

   <instance of xo::ConnectionContext> get_all_form_parameter

  Testcases:

  xowiki_test_cases, xowiki, create_form_with_form_instance

• get_parameter (scripted)

   <instance of xo::ConnectionContext> get_parameter

  Testcases:

  xowiki_test_cases, xowiki, link_tests

• get_user_id (scripted)

• init (scripted)

• lang (scripted)

• load_form_parameter (scripted)

• load_form_parameter_from_values (scripted)

• mobile (setter)

   <instance of xo::ConnectionContext> mobile

  Testcases:

  create_workflow_with_instance, xowf

• perconnection_parameter_get_all (scripted)

• perconnection_parameter_set_all (scripted)

• permission (scripted, public)

   <instance of xo::ConnectionContext> permission \
      -object_id object_id  -privilege privilege  [ -party_id party_id ]

  Call ::permission::permission_p but avoid multiple calls in the same request through caching in the connection context

  Switches:

  -object_id (required, integer)

  -privilege (required)

  -party_id (optional, integer)

  Testcases:

  xowiki_test_cases

• query_parameter (scripted, public)

   <instance of xo::ConnectionContext> query_parameter __spec \
      [ default ]

  Get query parameter with default and optional value constraints. In case the value check for the query parameter fails, and no further precautions are performed (::aa_test_noabort is set), the method raises an exception with "ad_return_complaint" and aborts the script.

  Parameters:

  __spec (required)

  has the formname or name:value_constraint

  default (optional)

  default value

  Returns:

  actual value of the query parameter

  Testcases:

  api__context, test_xo_cc, path_resolve

• requester (setter)

• requestor (scripted)

• require_form_parameter (scripted)

• returnredirect (scripted)

   <instance of xo::ConnectionContext> returnredirect

  Testcases:

  xowiki_test_cases, xowiki

• role=admin (scripted)

• role=all (scripted)

• role=app_group_member (scripted)

• role=community_member (scripted)

• role=creator (scripted)

• role=registered_user (scripted)

• role=swa (scripted)

• role=unregistered_user (scripted)

• set_parameter (scripted)

   <instance of xo::ConnectionContext> set_parameter

  Testcases:

  create_workflow_with_instance, xowf

• set_user_id (scripted)

• unset_parameter (scripted)

• url (setter)

   <instance of xo::ConnectionContext> url

  Testcases:

  create_workflow_with_instance, xowf, xowiki_test_cases

• user (setter)

• user_id (setter)

   <instance of xo::ConnectionContext> user_id

  Testcases:

  xotcl_core_tutorial_2, xotcl-core, create_workflow_with_instance, package_normalize_path, xowiki_test_cases, link_tests, slot_interactions, path_resolve, create_form_with_form_instance

Variables

::xo::ConnectionContext set __default_metaclass ::xotcl::Class
::xo::ConnectionContext set __default_superclass ::xotcl::Object

---