%3 ::xo::Package ::xo::Package exists_form_parameter exists_query_parameter form_parameter get_parameter handle_http_caching init initialize insert instantiate_forms process_init_parameter query_parameter reply_to_user require_root_folder return_page returnredirect set_url update ::xo::db::Object ::xo::db::Object delete initialize_loaded_object insert save save_new update ::xo::Package->::xo::db::Object ::xo::db::apm_parameter ::xo::db::apm_parameter insert update ::xo::db::apm_parameter->::xo::db::Object ::xo::parameter ::xo::parameter ::xo::db::apm_parameter->::xo::parameter instmixin ::xo::db::chat_room ::xo::db::chat_room ban_user count_messages create_transcript delete delete_messages flush grant_creator grant_moderator grant_user insert post_message revoke_moderator revoke_user save_new transcript_messages unban_user update ::xo::db::chat_room->::xo::db::Object ::xo::db::chat_transcript ::xo::db::chat_transcript insert save_new update ::xo::db::chat_transcript->::xo::db::Object ::xo::db::CrItem ::xo::db::CrItem changed_redirect_url current_user_id delete fix_content initialize_loaded_object is_cached_object is_package_root_folder privilege=creator rename save save_new set_live_revision update update_attribute_from_slot update_content update_item_index update_revision www-revisions ::xo::db::CrItem->::xo::db::Object ::xo::db::CrCache::Item ::xo::db::CrCache::Item ::xo::db::CrItem->::xo::db::CrCache::Item instmixin ::xotcl::Object ::xotcl::Object ::xo::db::Object->::xotcl::Object ::xo::oauth::ClientMetadata ::xo::oauth::ClientMetadata ::xo::oauth::ClientMetadata->::xo::db::CrItem ::xo::oauth::ServerMetadata ::xo::oauth::ServerMetadata update ::xo::oauth::ServerMetadata->::xo::db::CrItem ::xo::db::image ::xo::db::image update ::xo::db::image->::xo::db::CrItem ::xo::db::CrFolder ::xo::db::CrFolder → delete → fetch_object → get_instance_from_db → instance_select_query → register_content_types delete save save_new update ::xo::db::CrFolder->::xo::db::CrItem ::xowiki::Page ::xowiki::Page → container_already_rendered → find_slot → get_tags → import → quoted_html_content → save_tags __debug_known_field_names add_computed_instance_attributes adp_subst anchor anchor_parent_id build_instance_attribute_map build_name can_be_linked can_contain can_link can_save category_export category_import changed_redirect_url check_adp_include_path check_unresolved_references condition=is_folder_page condition=match condition=regexp content_header_append content_header_get copy_content_vars create_form_field create_form_fields create_form_fields_from_form_constraints create_form_page_instance create_link create_raw_form_field css_class_name default_instance_attributes demarshall detail_link div edit_set_default_values edit_set_file_selector_folder error_during_render error_in_includelet evaluate_form_field_condition exists_form_parameter exists_query_parameter field_names find_slot footer form_field_exists form_field_flush_cache form_field_index form_parameter get_anchor_and_query get_content get_description get_folder get_form_data get_html_from_content get_ids_for_bulk_actions get_instance_attributes get_nls_language_from_lang get_parent_object get_property_from_link_page get_query_parameter_return_url get_rich_text_spec get_target_from_link_page htmlFooter include include_content initialize_loaded_object instantiate_includelet is_folder_page is_form is_link_page is_new_entry is_unprefixed item_ref lang lookup_cached_form_field lookup_form_field map_categories map_party marshall mutual_overwrite_occurred new_link normalize_internal_link_name notification_detail_link notification_notify notification_render notification_subject physical_item_id physical_package_id physical_parent_id pretty_link pretty_name query_parameter record_last_visited references references_update regsub_eval rename render render_content render_icon render_includelet reset_resolve_context resolve_included_page_name return_redirect_without_params reverse_map_party reverse_map_party_attribute save save_data save_new search_render self_link_ids serialize_relocatable set_content set_resolve_context show_fields stats_record_count stats_record_detail substitute_markup translate unescape unset_temporary_instance_variables update update_publish_status validate=form_constraints validate=form_input_fields validate=name validate=page_order www-autosave-attribute www-bulk-delete www-clipboard-add www-clipboard-clear www-clipboard-content www-clipboard-copy www-clipboard-export www-create-new www-create-or-use www-csv-dump www-delete www-delete-revision www-diff www-duplicate www-edit www-list www-make-live-revision www-popular-tags www-revisions www-save-attributes www-save-tags www-toggle-publish-status www-validate-attribute www-view ::xowiki::Page->::xo::db::CrItem ::xo::oauth::Credentials ::xo::oauth::Credentials as_encoded_string update ::xo::oauth::Credentials->::xo::db::CrItem ::xowiki::PageTemplate ::xowiki::PageTemplate → count_usages count_usages update www-delete ::xowiki::PageTemplate->::xowiki::Page ::xowiki::PageInstance ::xowiki::PageInstance → get_list_from_form_constraints → get_short_spec_from_form_constraints adp_subst count_usages create_raw_form_field demarshall field_names_from_form_constraints get_field_label get_field_type get_form get_form_constraints get_from_template get_short_spec get_template_object render_content template_vars update widget_spec_from_folder_object www-use-template ::xowiki::PageInstance->::xowiki::Page ::xowiki::File ::xowiki::File build_name demarshall full_file_name html_content marshall pretty_name render_content render_icon search_render www-download ::xowiki::File->::xowiki::Page ::xowiki::PlainPage ::xowiki::PlainPage render_content set_content substitute_markup unescape ::xowiki::PlainPage->::xowiki::Page ::xo::oauth::TokenCredentials ::xo::oauth::TokenCredentials ::xo::oauth::TokenCredentials->::xo::oauth::Credentials ::xo::oauth::ClientCredentials ::xo::oauth::ClientCredentials ::xo::oauth::ClientCredentials->::xo::oauth::Credentials ::xo::oauth::TempCredentials ::xo::oauth::TempCredentials update ::xo::oauth::TempCredentials->::xo::oauth::Credentials

Class ::xo::db::CrItem

::xo::db::CrItem[i] create ... \
           [ -package_id package_id ] \
           [ -parent_id (default "-100") ] \
           [ -publish_status (default "ready") ] \
           [ -storage_type (default "text") ]

Class Relations

  • class: ::xo::db::CrClass[i]
  • superclass: ::xo::db::Object[i]
  • instmixin: ::xo::db::CrCache::Item[i]
  • subclass: ::xo::oauth::ClientMetadata[i], ::xo::oauth::ServerMetadata[i], ::xo::db::image[i], ::xo::db::CrFolder[i], ::xowiki::Page[i], ::xo::oauth::Credentials[i]

Methods (to be applied on instances)

  • changed_redirect_url (scripted)

  • current_user_id (scripted)

  • delete (scripted, public)

     <instance of xo::db::CrItem[i]> delete

    Delete the item from the content repository with the item_id taken from the instance variable.

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_test_cr_items test_cr_items (test xotcl-core) xo::db::CrItem instproc delete xo::db::CrItem instproc delete test_test_cr_items->xo::db::CrItem instproc delete

    Testcases:
    test_cr_items
  • description (setter)

  • fix_content (scripted)

  • initialize_loaded_object (scripted)

  • is_cached_object (scripted)

  • is_package_root_folder (scripted, public)

     <instance of xo::db::CrItem[i]> is_package_root_folder

    # In general, every cr_item may be in the role of a # "root-folder" of a package.

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_folder_with_page create_folder_with_page (test xowf) xo::db::CrItem instproc is_package_root_folder xo::db::CrItem instproc is_package_root_folder test_create_folder_with_page->xo::db::CrItem instproc is_package_root_folder test_create_workflow_with_instance create_workflow_with_instance (test xowf) test_create_workflow_with_instance->xo::db::CrItem instproc is_package_root_folder

    Testcases:
    create_folder_with_page, create_workflow_with_instance
  • item_id (setter)

  • mime_type (setter)

  • name (setter)

  • nls_language (setter)

  • package_id (setter)

  • parent_id (setter)

  • privilege=creator (scripted, public)

     <instance of xo::db::CrItem[i]> privilege=creator [ -login login ] \
        user_id package_id method

    Define an object specific privilege to be used in the policies. Grant access to a content item for the creator (creation_user) of the item, and for the package admin.

    Switches:
    -login
    (defaults to "true") (optional)
    Parameters:
    user_id
    package_id
    method

    Partial Call Graph (max 5 caller/called nodes):
    %3

    Testcases:
    No testcase defined.
  • publish_date (setter)

  • publish_status (setter)

  • rename (scripted, public)

     <instance of xo::db::CrItem[i]> rename -old_name old_name  \
        -new_name new_name 

    Rename a content item

    Switches:
    -old_name
    (required)
    -new_name
    (required)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_form_with_form_instance create_form_with_form_instance (test xowiki) xo::db::CrItem instproc rename xo::db::CrItem instproc rename test_create_form_with_form_instance->xo::db::CrItem instproc rename

    Testcases:
    create_form_with_form_instance
  • revision_id (setter)

  • save (scripted, public)

     <instance of xo::db::CrItem[i]> save \
        [ -modifying_user modifying_user ] [ -live_p on|off ] \
        [ -use_given_publish_date on|off ]

    Updates an item in the content repository. We insert a new revision instead of changing the current revision.

    Switches:
    -modifying_user
    (optional)
    -live_p
    (boolean) (defaults to "true") (optional)
    make this revision the live revision
    -use_given_publish_date
    (boolean) (defaults to "false") (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_test_cr_items test_cr_items (test xotcl-core) xo::db::CrItem instproc save xo::db::CrItem instproc save test_test_cr_items->xo::db::CrItem instproc save test_xotcl_core_tutorial_4 xotcl_core_tutorial_4 (test xotcl-core) test_xotcl_core_tutorial_4->xo::db::CrItem instproc save _ _ (public) xo::db::CrItem instproc save->_ ad_conn ad_conn (public) xo::db::CrItem instproc save->ad_conn cr_check_mime_type cr_check_mime_type (public) xo::db::CrItem instproc save->cr_check_mime_type cr_create_content_file cr_create_content_file (public) xo::db::CrItem instproc save->cr_create_content_file

    Testcases:
    xotcl_core_tutorial_4, test_cr_items
  • save_new (scripted, public)

     <instance of xo::db::CrItem[i]> save_new [ -package_id package_id ] \
        [ -creation_user creation_user ] [ -creation_ip creation_ip ] \
        [ -context_id context_id ] [ -live_p on|off ] \
        [ -use_given_publish_date on|off ]

    Insert a new item to the content repository.

    Switches:
    -package_id
    (optional)
    -creation_user
    (optional)
    user_id if the creating user
    -creation_ip
    (optional)
    -context_id
    (optional)
    -live_p
    (boolean) (defaults to "true") (optional)
    make this revision the live revision
    -use_given_publish_date
    (boolean) (defaults to "false") (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_test_cr_items test_cr_items (test xotcl-core) xo::db::CrItem instproc save_new xo::db::CrItem instproc save_new test_test_cr_items->xo::db::CrItem instproc save_new test_xotcl_core_tutorial_4 xotcl_core_tutorial_4 (test xotcl-core) test_xotcl_core_tutorial_4->xo::db::CrItem instproc save_new _ _ (public) xo::db::CrItem instproc save_new->_ cr_check_mime_type cr_check_mime_type (public) xo::db::CrItem instproc save_new->cr_check_mime_type cr_create_content_file cr_create_content_file (public) xo::db::CrItem instproc save_new->cr_create_content_file

    Testcases:
    xotcl_core_tutorial_4, test_cr_items
  • set_live_revision (scripted, public)

     <instance of xo::db::CrItem[i]> set_live_revision \
        -revision_id revision_id  [ -publish_status publish_status ] \
        [ -is_latest on|off ]
    Switches:
    -revision_id
    (required)
    -publish_status
    (defaults to "ready") (optional)
    one of 'live', 'ready' or 'production'
    -is_latest
    (boolean) (defaults to "false") (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_folder_with_page create_folder_with_page (test xowf) xo::db::CrItem instproc set_live_revision xo::db::CrItem instproc set_live_revision test_create_folder_with_page->xo::db::CrItem instproc set_live_revision test_create_workflow_with_instance create_workflow_with_instance (test xowf) test_create_workflow_with_instance->xo::db::CrItem instproc set_live_revision

    Testcases:
    create_folder_with_page, create_workflow_with_instance
  • storage_type (setter)

  • text (setter)

  • title (setter)

  • update (scripted)

  • update_attribute_from_slot (scripted)

     <instance of xo::db::CrItem[i]> update_attribute_from_slot

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_slot_interactions slot_interactions (test ) xo::db::CrItem instproc update_attribute_from_slot xo::db::CrItem instproc update_attribute_from_slot test_slot_interactions->xo::db::CrItem instproc update_attribute_from_slot test_xowiki xowiki (test ) test_xowiki->xo::db::CrItem instproc update_attribute_from_slot

    Testcases:
    slot_interactions, xowiki
  • update_content (scripted)

  • update_item_index (scripted, public)

     <instance of xo::db::CrItem[i]> update_item_index

    Dummy stub to allow subclasses to produce a more efficient index for items based on live revisions.

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_xotcl_core_tutorial_4 xotcl_core_tutorial_4 (test xotcl-core) xo::db::CrItem instproc update_item_index xo::db::CrItem instproc update_item_index test_xotcl_core_tutorial_4->xo::db::CrItem instproc update_item_index test_xowiki_test_cases xowiki_test_cases (test xowiki) test_xowiki_test_cases->xo::db::CrItem instproc update_item_index

    Testcases:
    xotcl_core_tutorial_4, xowiki_test_cases
  • update_revision (scripted)

  • www-revisions (scripted)