---

Class ::xotcl::Object

::xotcl::Object create ...

Defined in

Class Relations

• class: ::xotcl::Class
• subclass: ::xowf::mypolicy::FormPage, ::xowf::mypolicy::Object, ::xowf::mypolicy::Page, ::xowf::mypolicy::Package, ::xowf::mypolicy::File, ::xowf::mypolicy::Form, ::xo::db::DBI::Profile, ::xo::db::sql::timespan, ::xo::db::sql::acs, ::xowiki::policy1::CrFolder, ::xo::db::sql::person, ::xo::db::sql::pa_collection, ::xowf::test_item::test-item-policy-publish::Form, ::xo::db::sql::pinds_blog_category, ::xo::db::sql::membership_rel, ::xowiki::policy1::Object, ::xo::db::sql::acs_object_util, ::xo::db::sql::forums_reading_info, ::xo::db::sql::rel_segment, ::xowiki::policy1::FormPage, ::xowiki::policy1::Form, ::xo::db::sql::bt_patch, ::xo::db::sql::workflow, ::xowiki::policy5::Form, ::xowf::test_item::test-item-policy-edit::Page, ::xo::db::sql::wp_attachment, ::xowiki::policy3::Page, ::xo::db::sql::time_interval, ::xo::db::sql::acs_rel, ::xowiki::policy1::Package, ::xo::db::sql::apm_parameter_value, ::xowf::test_item::test-item-policy-answer::Page, ::xo::db::sql::workflow_case_log_entry, ::xo::db::sql::fs_url, ::xo::db::sql::acs_object_type, ::xowf::test_item::test-item-policy-publish::Object, ::xo::db::sql::content_template, ::xowf::conf2022policy::CrFolder, ::xowf::conf2022policy::Page, ::xowf::conf2022policy::FormPage, ::xowiki::policy3::Object, ::xo::db::sql::photo_album, ::xo::db::sql::wf_article_callback, ::xowiki::policy5::FormPage, ::xo::db::sql::acs_mail_link, ::xowiki::openacspolicy::FormPage, ::xo::db::sql::bt_project, ::xo::db::sql::views, ::xowf::test_item::test-item-policy-publish::File, ::xo::db::sql::forums_forum, ::xo::Table::TABLE::HiddenField, ::xo::db::sql::acs_sc_binding, ::xowiki::policy1::File, ::xo::db::sql::acs_log, ::xowiki::policy5::File, ::xo::db::sql::wp_presentation, ::xo::db::sql::acs_activity, ::xo::db::sql::party_approved_member, ::xo::db::sql::util, ::xo::db::sql::acs_mail_multipart, ::xowiki::policy5::Object, ::xo::db::sql::acs_event, ::xowiki::TreeRenderer=bootstrap3, ::xo::db::sql::admin_rel, ::xowiki::policy2::Form, ::xo::db::sql::workflow_case_pkg, ::xo::db::sql::acs_sc_contract, ::xowf::conf2022policy::Package, ::xo::db::sql::acs_mail_queue_message, ::xowiki::policy2::FormPage, ::xo::db::sql::forums_message, ::xo::db::sql::bookmark, ::xo::db::sql::notification_request, ::xo::db::sql::acs_object, ::xo::db::sql::ec_product, ::xo::db::sql::category, ::xo::db::sql::content_type, ::xo::db::sql::image, ::xo::db::sql::search_observer, ::xo::db::sql::content_extlink, ::xo::db::sql::acs_datatype, ::xo::db::sql::fs_simple_object, ::xo::db::sql::category_synonym, ::xo::db::sql::category_link, ::xo::db::sql::site_node, ::xowiki::openacspolicy::Form, ::xo::db::sql::wp_slide, ::xowiki::policy2::File, ::xo::db::sql::views_by_type, ::xo::db::sql::apm_package_type, ::xo::db::sql::authority, ::xo::db::sql::content_item, ::xo::db::sql::apm_application, ::xo::db::sql::acs_sc_impl_alias, ::xowiki::BootstrapCollapseButton, ::xo::db::sql::acs_sc_impl, ::xowf::test_item::test-item-policy-answer::Package, ::xo::db::sql::acs_privilege, ::xo::db::sql::notification, ::xo::db::sql::bt_bug, ::xo::db::sql::content_folder, ::xowf::test_item::test-item-policy-edit::Form, ::xowiki::openacspolicy::File, ::xo::db::sql::acs_group, ::xowiki::policy3::Form, ::xo::db::sql::acs_mail_nt, ::xowf::test_item::test-item-policy-publish::Page, ::xo::db::sql::cal_uid, ::xowiki::policy1::Page, ::xo::db::sql::pa_album, ::xowf::test_item::test-item-policy-answer::Form, ::xowf::test_item::test-item-policy-edit::Object, ::xowiki::policy5::Page, ::xowiki::policy2::Object, ::xo::db::sql::bt_version, ::xowf::conf2022policy::Form, ::xo::db::sql::url, ::xowiki::policy3::FormPage, ::xo::db::sql::acs_message, ::xo::db::sql::content_revision, ::xo::db::sql::workflow_case, ::xowiki::TreeRenderer=list, ::xo::db::sql::acs_content, ::xo::db::sql::journal_entry, ::xo::db::sql::rel_constraint, ::xo::db::sql::wp_style, ::xowf::test_item::test-item-policy-edit::File, ::xo::db::sql::notification_reply, ::xowiki::policy3::File, ::xowf::test_item::test-item-policy-answer::File, ::xo::db::sql::pinds_blog_entry, ::xo::db::sql::static_page, ::xowf::test_item::test-item-policy-publish::Package, ::xo::db::sql::news, ::xo::db::sql::apm_service, ::xo::db::sql::calendar, ::xowf::conf2022policy::Object, ::xowf::test_item::test-item-policy-edit::CrFolder, ::xowf::conf2022policy::File, ::xo::db::sql::content_keyword, ::xo::db::sql::rss_gen_subscr, ::xowf::test_item::test-item-policy-publish::CrFolder, ::xowf::test_item::test-item-policy-edit::FormPage, ::xo::db::sql::content_symlink, ::xo::db::sql::site_node_object_map, ::xowf::test_item::test-item-policy-answer::Object, ::xo::db::sql::application_group, ::xowf::test_item::test-item-policy-publish::FormPage, ::xo::db::sql::apm_package, ::xowiki::policy5::Package, ::xowiki::openacspolicy::Package, ::xo::db::sql::apm_package_version, ::xo::db::sql::timezone, ::xo::db::sql::notification_delivery_method, ::xowiki::openacspolicy::Object, ::xo::db::sql::acs_util, ::xo::db::sql::acs_attribute, ::xo::db::sql::composition_rel, ::xo::db::sql::acs_user, ::xo::db::Object, ::xo::db::sql::acs_sc_operation, ::xo::db::sql::weblogger_blogroll_entry, ::xowiki::policy2::Page, ::xo::db::sql::category_tree, ::xo::db::sql::subsite_callback, ::xo::db::sql::acs_mail_body, ::xo::db::sql::user_profile, ::xo::db::sql::weblogger_channel, ::xo::db::sql::acs_sc_msg_type, ::xo::db::sql::search, ::xo::db::sql::acs_mail_gc_object, ::xo::db::sql::cal_item, ::xo::db::sql::bt_bug_revision, ::xo::db::sql::etp, ::xo::db::sql::download_rep, ::xo::db::sql::acs_reference, ::xo::db::sql::acs_rel_type, ::xowiki::policy3::Package, ::xowf::test_item::test-item-policy-answer::CrFolder, ::xo::db::sql::faq, ::xowiki::openacspolicy::Page, ::xowf::test_item::test-item-policy-edit::Package, ::xo::db::sql::doc, ::xo::db::sql::notification_interval, ::xowf::test_item::test-item-policy-answer::FormPage, ::xo::db::sql::wf_callback, ::xo::db::sql::party, ::xo::db::sql::file_storage, ::xo::db::sql::sec_session_property, ::xo::db::sql::recurrence, ::xo::db::sql::acs_permission, ::xo::db::sql::apm, ::xo::db::sql::template_demo_note, ::xo::db::sql::pa_photo, ::xowiki::policy2::Package, ::xo::db::sql::notification_type, ::xowiki::Weblog::EntryRenderer, ::xotcl::THREAD::Client, ::xo::OrderedComposite::MethodCompare, ::xo::OrderedComposite::IndexCompare, ::xo::db::CrCache::Item, ::xo::OrderedComposite::Child, ::xowiki::RSS-client::item, ::xo::db::CrCache::Class, ::xo::OrderedComposite::ChildManager, ::xowiki::RSS-client::channel, ::xo::ical::VCALENDAR, ::xowiki::Weblog::WeblogRenderer, ::xowiki::ParameterCache, ::xowf::Context, ::xowiki::includelet::decoration=edit, ::xo::OrderedComposite, ::xo::TRN-Mode, ::xo::tdom::AttributeManager, ::xo::Timestamp, ::xowiki::ArchiveFile, ::xo::ProtocolHandler, ::xo::InstanceManager, ::xo::Policy, ::xowf::WorkflowObject, ::xo::Localizer, ::xowiki::includelet::PageReorderSupport, ::Generic::Form, ::xowiki::RSS-client, ::Generic::List, ::RR, ::xowiki::Weblog, ::xowiki::includelet::form-menu-button, ::xo::db::SQL, ::xotcl::THREAD, ::xo::oauth::Signature, ::xowiki::includelet::page_fragment_cache, ::xowiki::includelet::highcharts, ::chat::Package, ::xowiki::LinkTemplate, ::xowiki::Category, ::xo::Message, ::xowiki::MenuBar, ::xowiki::BaseLink, ::xo::Context, ::xo::db::Driver, ::xowiki::includelet::decoration=portlet, ::xowiki::includelet::decoration=plain, ::xowiki::XMLSyndication, ::xo::db::CrCache, ::xo::Module, ::xo::Page, ::xo::role::Role, ::xowiki::includelet::decoration=rightbox, ::xowf::WorkflowPage, ::xo::db::temp_table, ::xowiki::Importer, ::xowf::atjob, ::xowiki::ADP_Generator, ::xo::parameter, ::xotcl::Class

::xotcl::Class create ::xotcl::Object

Methods (to be applied on the object)

• getExitHandler (scripted)

  ::nsf::exithandler get

• setExitHandler (scripted)

  ::nsf::exithandler set $newbody

• unsetExitHandler (scripted)

  ::nsf::exithandler unset

Methods (to be applied on instances)

• __object_configureparameter (scripted)

  set slotObjects [nsf::directdispatch [self] ::nsf::methods::object::info::lookupslots -type ::nx::Slot]
  set parameterDefinitions [::nsf::parameter::specs $slotObjects]
  lappend parameterDefinitions args:alias,method=residualargs,args

• __timediff (scripted)

  set now [ns_time get]
  if {[ns_conn isconnected]} {
    set start_time [ns_conn start]
  } else {
    if {![info exists ::__start_time]} {set ::__start_timestamp $now}
    set start_time $::__start_timestamp
  }
  set t [ns_time diff $now $start_time]
  set ms [expr {[ns_time seconds $t]*1000 + [ns_time microseconds $t]/1000}]
  if {[info exists ::__last_timestamp]} {
    set t [ns_time diff $now $::__last_timestamp]
    set dms [expr {[ns_time seconds $t]*1000 + [ns_time microseconds $t]/1000}]
    set diff ", ${dms}ms"
  } else {
    set diff ""
  }
  set ::__last_timestamp $now
  return "${ms}ms$diff"

• abstract (scripted)

  if {$methtype ne "proc" && $methtype ne "instproc" && $methtype ne "method"} {
    error "invalid method type '$methtype',  must be either 'proc', 'instproc' or 'method'."
  }
  set arglist2 $arglist
  regsub -all {\"} $arglist {\\"} arglist2
  :$methtype $methname $arglist "
    if {!\[::xotcl::self isnextcall\]} {
      error \"Abstract method $methname $arglist2 called\"
    } else {::xotcl::next}
  "
  # balance " for emacs syntax highlighter

• ad_doc (scripted)

  ::xo::api update_object_doc [::xo::api scope] [self] $doc_string

• ad_forward (scripted)

  set flags [::xo::api get_proc_definition_flags $debug $deprecated]
  uplevel [self] forward {*}$flags $method_name $args
  ::xo::api update_method_doc  -protection [expr {$private ? "private" : "public"}]  -deprecated=$deprecated  -debug=$debug  [::xo::api scope] [self]  "" $method_name $doc

• ad_proc (scripted)

  set flags [::xo::api get_proc_definition_flags $debug $deprecated]
  set returnSpec [::xo::api get_returns_spec $returns]
  uplevel [list [self] proc {*}$flags $proc_name $arguments {*}$returnSpec $body]
  ::xo::api update_method_doc  -protection [expr {$private ? "private" : "public"}]  -deprecated=$deprecated  -debug=$debug  [::xo::api scope] [self]  "" $proc_name $doc

• append (alias)

• array (alias)

• asHTML (scripted)

  ::xo::require_html_procs
  dom createDocument html doc
  set root [$doc documentElement]
  if {!$page} {
    $root appendFromScript {:render}
    set nodes [$root childNode]
    return [join [lmap n $nodes {$n asHTML}] \n]
  } else {
    set slave [$master decorate $root]
    $slave appendFromScript {:render}
    ns_return 200 text/html [$root asHTML]
  }

• autoname (alias)

• check (scripted)

  ::nsf::method::assertion [self] check [::xotcl::checkoption_xotcl1_to_internal $checkoptions]

• class (forward)

• cleanup (alias)

• configure (alias)

• contains (alias)

• copy (alias)

• db_0or1row (forward)

• db_1row (forward)

• debug (scripted)

  set msg [join $args { }]
  ns_log debug "[self] [self callingclass]->[self callingproc]: $msg"

• defaultmethod (alias)

• destroy (alias)

• destroy_on_cleanup (scripted)

  #:log "--cleanup adding ::xo::cleanup([self]) [list [self] destroy]"
  set ::xo::cleanup([self]) [list [self] destroy]

• dict (alias)

• ds (scripted)

  set msg [join $args { }]
  ds_comment "[self] [self callingclass]->[self callingproc]: $msg ([:__timediff])"

• eval (alias)

• exists (alias)

• extractConfigureArg (scripted)

  set value ""
  ::upvar $al argList
  set largs [llength $argList]
  for {set i 0} {$i < $largs} {incr i} {
    if {[lindex $argList $i] == $name && $i + 1 < $largs} {
      set startIndex $i
      set endIndex [expr {$i + 1}]
      while {$endIndex < $largs &&
             [string first - [lindex $argList $endIndex]] != 0} {
        lappend value [lindex $argList $endIndex]
        incr endIndex
      }
    }
  }
  if {[info exists startIndex] && $cutTheArg != 0} {
    set argList [lreplace $argList $startIndex [expr {$endIndex - 1}]]
  }
  return $value

• filter (forward)

• filterguard (alias)

• filtersearch (scripted)

  set handle [::nsf::directdispatch [::nsf::current object]  ::nsf::methods::object::info::lookupfilter $filter]
  return [method_handle_to_xotcl $handle]

• forward (scripted)

  set arglist [list]
  if {[info exists target] && [string index $target 0] eq "-"} {
    error "target '$target' must not start with a dash"
  }
  if {[info exists default]} {lappend arglist -default $default}
  if {$earlybinding} {lappend arglist -earlybinding}
  if {[info exists methodprefix]} {lappend arglist -prefix $methodprefix}
  if {$objscope} {lappend arglist -frame object}
  if {[info exists onerror]} {lappend arglist -onerror $onerror}
  if {$verbose} {lappend arglist -verbose}
  if {[info exists target]} {lappend arglist $target}
  if {[llength $args] > 0} {lappend arglist {*}$args}
  set r [::nsf::method::forward [self] -per-object $method {*}$arglist]
  if {$debug} {::nsf::method::property [self] $r debug true}
  if {$deprecated} {::nsf::method::property [self] $r deprecated true}
  return $r

• hasclass (scripted)

  if {![::nsf::is class $cl]} {return 0}
  if {[::nsf::directdispatch [self] ::nsf::methods::object::info::hasmixin $cl]} {return 1}
  ::nsf::directdispatch [self] ::nsf::methods::object::info::hastype $cl

• incr (alias)

• info (alias)

• init (scripted)

  if {![::nsf::current isnextcall] && [llength $args] > 0 && [::nsf::configure debug] > 0} {
    ::nsf::log Warning "Arguments '$args' to constructor of object [self] are most likely not processed"
  }

• instvar (alias)

• invar (forward)

• isclass (scripted)

  ::nsf::is class $class

• ismetaclass (scripted)

  ::nsf::is metaclass $class

• ismixin (scripted)

  return [expr {[::nsf::is class $class] &&
            [my ::nsf::methods::object::info::hasmixin $class]}]

• isobject (scripted)

  ::nsf::object::exists $object

• istype (scripted)

  return [expr {[::nsf::is class $class] &&
            [::nsf::directdispatch [self] ::nsf::methods::object::info::hastype $class]}]

• lappend (alias)

• log (scripted)

  set msg [join $args { }]
  ns_log notice "[self] [self callingclass]->[self callingproc]: $msg ([:__timediff])"

• method (scripted)

  set returns_flag [expr {[info exists returns] ? [list -returns $returns] : {}}]
  :proc -debug=$debug -deprecated=$deprecated $name $arguments {*}$returns_flag $body

• mixin (forward)

• mixinguard (alias)

• move (alias)

• mset (scripted)

  #
  # Import all attribute value pairs into the current XOTcl object.
  #
  if {[llength $pairs] > 0} {
    nsf::directdispatch [self] -frame object ::lassign [dict values $pairs] {*}[dict keys $pairs]
  }

• msg (scripted)

  set msg [join $args { }]
  if {[ns_conn isconnected]} {
    set msg "[self]: $msg  ([self callingclass]->[self callingproc])"
    if {$html} {
      util_user_message -html -message $msg
    } else {
      util_user_message -message $msg
    }
  }

• noinit (alias)

• parametercmd (forward)

• proc (scripted)

  set conditions [list]
  if {[info exists precondition]}  {lappend conditions -precondition  $precondition}
  if {[info exists postcondition]} {lappend conditions -postcondition $postcondition}
  set r [::nsf::method::create [self] -per-object $name $arguments $body {*}$conditions]
  if {$debug} {::nsf::method::property [self] $r debug true}
  if {$deprecated} {::nsf::method::property [self] $r deprecated true}
  if {[info exists returns]} {::nsf::method::property [self] $r returns $returns}
  return $r

• procsearch (scripted)

  set handle [::nsf::directdispatch [::nsf::current object]  ::nsf::methods::object::info::lookupmethod $name]
  return [method_handle_to_xotcl $handle]

• qn (scripted)

  #set qn "dbqd.[:uplevel [list self class]]-[:uplevel [list self proc]].$query_name"
  set l [info level]
  if {$l < 2} {
    set prefix topLevel
  } else {
    set prefix [lindex [:uplevel {info level 0}] 0]
    #ns_log notice "QN <$query_name> -> PREFIX <$prefix>"
  }
  return "dbqd.$prefix.$query_name"

• requireNamespace (alias)

• residualargs (alias)

• self (scripted)

  ::xotcl::self

• serialize (scripted)

  set objmap [expr {[info exists target] ? [list [::nsf::current object] $target] : ""}]
  ::Serializer deepSerialize -objmap $objmap [::nsf::current object]

• set (alias)

• set_instance_vars_defaults (scripted)

  :configure

• subst (alias)

• trace (alias)

• unknown (scripted)

  if {![self isnext]} {
    error "[self]: unable to dispatch method '$m'"
  }

• unset (alias)

   <instance of xotcl::Object> unset

  Testcases:

  xowiki_test_cases, xowiki

• uplevel (alias)

• upvar (alias)

• volatile (alias)

• vwait (scripted)

  if {[regexp {:[^:]*} $varName]} {
    error "invalid varName '$varName'; only plain or fully qualified variable names allowed"
  }
  if {[string match ::* $varName]} {
    ::vwait $varName
  } else {
    ::vwait :$varName
  }

• www-show-object (scripted)

  #
  # Allow to show an arbitrary object via API-browser.  Per-default,
  # e.g. a site-wide admin can use e.g. /xowiki/index?m=show-object
  #
  if {[ns_conn isconnected]} {
    set form [ns_getform]
    ns_set update $form object [self]
    ns_set update $form show_source    [::xo::cc query_parameter show_source:integer 1]
    ns_set update $form show_methods   [::xo::cc query_parameter show_methods:integer 2]
    ns_set update $form show_variables [::xo::cc query_parameter show_variables:integer 1]
    ns_set update $form as_img 1
    rp_internal_redirect /packages/xotcl-core/www/show-object
  } else {
    ns_log error "show-object can only be called with an active connection"
  }
  ad_script_abort

---