Begin main content
Methods: Source: Variables:
[All Methods | Documented Methods | Hide Methods] [Display Source | Hide Source] [Show Variables | Hide Variables]

::xo::db::CrClass[i] ::xo::db::CrFolder

Class Hierarchy of ::xo::db::CrFolder

  • ::xotcl::Object[i]
    Methods for instances:
    __api_make_doc, __api_make_forward_doc, __timediff, abstract, ad_doc, ad_forward, ad_proc, appendC, arrayC, asHTML, autonameC, check, classC, cleanupC, configureC, containsC, copyC, db_0or1rowC, db_1rowC, debug, defaultmethodC, destroyC, destroy_on_cleanup, ds, evalC, existsC, extractConfigureArg, filterC, filterguardC, filtersearch, forward, hasclass, incrC, infoC, init, instvarC, invarC, isclass, ismetaclass, ismixin, isobject, istype, lappendC, log, method, mixinC, mixinguardC, moveC, msg, noinitC, objectparameter, parametercmdC, proc, procsearch, qn, requireNamespaceC, residualargsC, self, serialize, setC, set_instance_vars_defaults, show-object, substC, traceC, unknown, unsetC, uplevelC, upvarC, volatileC, vwait
    Methods to be applied on the class (in addition to the methods provided by the meta-class):
    getExitHandler, setExitHandler, unsetExitHandler
    • ::xo::db::Object[i]
      Methods for instances:
      db_1row, delete, initialize_loaded_object, insert, object_idC, object_titleC, save, save_new
      Methods to be applied on the class:
      Methods provided by the meta-class
      • ::xo::db::CrItem[i]
        Parameter for instances:
        package_id, parent_id (default "-100"), publish_status (default "ready")
        Methods for instances:
        current_user_id, delete, descriptionC, fix_content, initialize_loaded_object, item_idC, mime_typeC, nameC, nls_languageC, privilege=creator, publish_dateC, rename, revision_idC, revisions, save, save_new, set_live_revision, textC, titleC, update_attribute_from_slot, update_content, update_revision
        Methods to be applied on the class:
        Methods provided by the meta-class
This is a generic class that represents a "cr_folder" XoWiki specific methods are currently directly mixed into all instances of this class.
Defined in packages/xotcl-core/tcl/cr-procs.tcl

Class Relations

  • superclass: ::xo::db::CrItem[i]


  • proc fetch_object (public)

    ::xo::db::CrFolder[i] fetch_object -item_id item_id  \
        [ -revision_id revision_id ] -object object  \
        [ -initialize initialize ]
    We overwrite the default fetch_object method here. We join acs_objects, cr_items and cr_folders and fetch all attributes. The revision_id is completely ignored.

    -item_id (required)
    -revision_id (defaults to "0") (optional)
    -object (required)
    -initialize (defaults to "true") (optional)

    See Also:
    • CrClass fetch_object
  • proc get_instance_from_db (public)

    ::xo::db::CrFolder[i] get_instance_from_db [ -item_id item_id ] \
        [ -revision_id revision_id ]
    The "standard" get_instance_from_db methods return objects following the naming convention "::", e.g. ::1234 Usually, the id of the item that is fetched from the database is used. However, XoWiki's "folder objects" (i.e. an ::xowiki::Object instance that can be used to configure the respective instance) are created using the acs_object_id of the root folder of the xowiki instance, which is actually the id of another acs_object. Because of this, we cannot simply create the instances of CrFolder using the "standard naming convention". Instead we create them as ::cr_folder

    -item_id (defaults to "0") (optional)
    -revision_id (defaults to "0") (optional)
  • proc instance_select_query (public)

    ::xo::db::CrFolder[i] instance_select_query \
        [ -select_attributes select_attributes ] [ -orderby orderby ] \
        [ -where_clause where_clause ] [ -from_clause from_clause ] \
        [ -with_subtypes on|off ] [ -with_children on|off ] \
        [ -publish_status publish_status ] [ -count on|off ] \
        [ -folder_id folder_id ] [ -parent_id parent_id ] \
        [ -page_size page_size ] [ -page_number page_number ] \
        [ -base_table base_table ]
    returns the SQL-query to select the CrItems of the specified object_type

    -select_attributes (optional)
    -orderby (optional)
    for ordering the solution set
    -where_clause (optional)
    clause for restricting the answer set
    -from_clause (optional)
    -with_subtypes (boolean) (defaults to "true") (optional)
    return subtypes as well
    -with_children (boolean) (defaults to "true") (optional)
    return immediate child objects of all objects as well
    -publish_status (optional)
    one of 'live', 'ready', or 'production'
    -count (boolean) (defaults to "false") (optional)
    return the query for counting the solutions
    -folder_id (optional)
    -parent_id (optional)
    -page_size (defaults to "20") (optional)
    -page_number (optional)
    -base_table (defaults to "cr_folders") (optional)
    typically automatic view, must contain title and revision_id
    sql query
  • proc register_content_types (public)

    ::xo::db::CrFolder[i] register_content_types -folder_id folder_id  \
        [ -content_types content_types ]
    Register the specified content types for the folder. If a content_type ends with a *, include its subtypes

    -folder_id (required)
    -content_types (optional)
  • instproc delete

  • instproc is_package_root_folder

  • instproc save (public)

    <instance of ::xo::db::CrFolder[i]> save args [ args... ]

  • instproc save_new (public)

    <instance of ::xo::db::CrFolder[i]> save_new \
        [ -creation_user creation_user ]

    -creation_user (optional)

Methods: Source: Variables:
[All Methods | Documented Methods | Hide Methods] [Display Source | Hide Source] [Show Variables | Hide Variables]