---

Class ::xo::Package

::xo::Package create ... \
           [ -context (default "::xo::cc") ] \
           [ -force_refresh_login (default "false") ] \
           [ -id:integer id:integer ] \
           [ -package_url package_url ] \
           [ -url url ]

Defined in

Class Relations

• class: ::xo::PackageMgr
• superclass: ::xo::db::Object
• subclass: ::xo::oauth::Package, ::xowiki::Package

Methods (to be applied on instances)

• context (setter)

• default_locale (setter)

• exists_form_parameter (forward)

• exists_query_parameter (forward)

• force_refresh_login (setter)

• form_parameter (forward)

• get_parameter (scripted)

• handle_http_caching (scripted)

• id (setter)

• init (scripted)

• initialize (scripted)

   <instance of xo::Package> initialize

  Testcases:

  create_form_with_form_instance, xowiki

• insert (scripted)

• instance_name (setter)

• instantiate_forms (scripted)

• package_id (setter)

• package_key (setter)

• package_url (setter)

• process_init_parameter (scripted)

• query_parameter (forward)

• reply_to_user (scripted)

   <instance of xo::Package> reply_to_user

  Testcases:

  create_folder_with_page, xowf, create_workflow_with_instance, create_form_with_form_instance

• require_root_folder (scripted, public)

   <instance of xo::Package> require_root_folder \
      [ -parent_id parent_id ] [ -content_types content_types ] \
      -name name 

  Make sure, the root folder for the given package exists. If not, create it and register all allowed content types. Note that xowiki (and derived packages) define their own version of "require_root_folder" based on form pages. Therefore, this function is just for packages not based on xowiki.

  Switches:

  -parent_id (optional, defaults to "-100")

  -content_types (optional)

  -name (required)

  Returns:

  folder_id

  Testcases:

  xowiki_test_cases

• return_page (scripted)

• returnredirect (forward)

• set_url (scripted)

• update (scripted)

• url (setter)

---