---

Class ::xowiki::PageInstance

::xowiki::PageInstance create ...

Defined in

Class Relations

• class: ::xo::db::CrClass
• superclass: ::xowiki::Page
• subclass: ::xowiki::FormPage

::xo::db::CrClass create ::xowiki::PageInstance \
     -superclass ::xowiki::Page

Methods (to be applied on instances)

• get_from_template (scripted, public)

   <instance of xowiki::PageInstance> get_from_template var \
      [ default ]

  Get a property from the parent object (template). The parent object might by either an ::xowiki::Form or an ::xowiki::FormPage

  Parameters:

  var (required)

  default (optional)

  Returns:

  either the property value or a default value

  Testcases:

  create_form_with_form_instance

  set form_obj [:get_template_object]
  
  #:msg "get $var from template form_obj=$form_obj [$form_obj info class]"
  
  # The resulting page should be either a Form (PageTemplate) or
  # a FormPage (PageInstance)
  #
  #:msg "parent of self ${:name} is [$form_obj name] type [$form_obj info class]"
  #
  # If it is as well a PageInstance, we find the information in the
  # properties of this page. Note that we cannot distinguish here between
  # intrinsic (starting with _) and extension variables, since get_from
  # template does not know about the logic with "_" (just "property" does).
  #
  if {[$form_obj istype ::xowiki::PageInstance]} {
    #:msg "returning property $var from parent formpage $form_obj => '[$form_obj property $var $default]'"
    return [$form_obj property $var $default]
  }
  
  #
  # .... otherwise, it should be an instance variable ....
  #
  if {[$form_obj exists $var]} {
    #:msg "returning parent instvar [$form_obj set $var]"
    return [$form_obj set $var]
  }
  #
  # .... or, we try to resolve it against a local property.
  #
  # This case is currently needed in the workflow case, where
  # e.g. anon_instances is tried to be fetched from the first form,
  # which might not contain it, if e.g. the first form is a plain
  # wiki page.
  #
  #:msg "resolve local property $var=>[:exists_property $var]"
  if {[:istype ::xowiki::FormPage] && [:exists_property $var]} {
    #:msg "returning local property [:property $var]"
    return [:property $var]
  }
  #
  # if everything fails, return the default.
  #
  #:msg "returning the default <$default>, parent is of type [$form_obj info class]"
  return $default

• www-use-template (scripted, public)

   <instance of xowiki::PageInstance> www-use-template

  This web-callable method can be used to change the "template" of a PageInstance. The caller provides the "form" as query parameter which should be used in future for handling the instance parameters of the PageInstance. This method can be as well be used for changing the associated workflow of a workflow instance.

  Testcases:

  No testcase defined.

  set formName [:query_parameter "form" ""]
  if {$formName eq ""} {
    error "no form specified"
  }
  ::${:package_id} get_lang_and_name -default_lang [::xo::cc lang] -path $formName lang stripped_url
  set d [::${:package_id} item_ref -default_lang $lang -parent_id [::${:package_id} folder_id] $formName]
  set item_id [dict get $d item_id]
  if {$item_id == 0} {
    error "cannot lookup page $formName"
  }
  ::xo::db::CrClass get_instance_from_db -item_id $item_id
  if {![nsf::is object ::$item_id]
      || "::xowiki::PageTemplate" ni [::$item_id info precedence]} {
    error "OK $formName is not suited to be used as template. Should be a Form!"
  }
  if {${:page_template} == $item_id} {
    :msg "old page_template $item_id is already the same as the new one"
  } else {
    set msg "change template_id ${:page_template} to $item_id"
    :page_template $item_id
    :save
    #:msg "ok $msg"
  }
  ::${:package_id} returnredirect [ad_return_url]

---