- Methods: All Methods Documented Methods Hide Methods
- Source: Display Source Hide Source
- Variables: Show Variables Hide Variables
Class ::xo::db::CrItem
::xo::db::CrItem create ... \
[ -package_id package_id ] \
[ -parent_id (default "-100") ] \
[ -publish_status (default "ready") ] \
[ -storage_type (default "text") ]
Defined in
Class Relations
- class: ::xo::db::CrClass
- superclass: ::xo::db::Object
- instmixin: ::xo::db::CrCache::Item
- subclass: ::xo::oauth::ServerMetadata, ::xo::db::image, ::xo::oauth::ClientMetadata, ::xowiki::Page, ::xo::db::CrFolder, ::xo::oauth::Credentials
Methods (to be applied on instances)
changed_redirect_url (scripted)
current_user_id (scripted)
delete (scripted, public)
<instance of xo::db::CrItem> deleteDelete the item from the content repository with the item_id taken from the instance variable.
- 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> is_package_root_folder# In general, every cr_item may be in the role of a # "root-folder" of a package.
- 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> privilege=creator [ -login login ] \ user_id package_id methodDefine 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 (optional, defaults to
"true"
)- Parameters:
- user_id (required)
- package_id (required)
- method (required)
- Testcases:
- No testcase defined.
publish_date (setter)
publish_status (setter)
rename (scripted, public)
<instance of xo::db::CrItem> rename -old_name old_name \ -new_name new_nameRename a content item
- Switches:
- -old_name (required)
- -new_name (required)
- Testcases:
- create_form_with_form_instance
revision_id (setter)
save (scripted, public)
<instance of xo::db::CrItem> 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 (optional, boolean, defaults to
"true"
)- make this revision the live revision
- -use_given_publish_date (optional, boolean, defaults to
"false"
)- Testcases:
- xotcl_core_tutorial_4, test_cr_items
save_new (scripted, public)
<instance of xo::db::CrItem> 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 (optional, boolean, defaults to
"true"
)- make this revision the live revision
- -use_given_publish_date (optional, boolean, defaults to
"false"
)- Testcases:
- xotcl_core_tutorial_4, test_cr_items
set_live_revision (scripted, public)
<instance of xo::db::CrItem> set_live_revision \ -revision_id revision_id [ -publish_status publish_status ] \ [ -is_latest on|off ]
- Switches:
- -revision_id (required)
- -publish_status (optional, defaults to
"ready"
)- one of 'live', 'ready' or 'production'
- -is_latest (optional, boolean, defaults to
"false"
)- 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> update_attribute_from_slot
- Testcases:
- slot_interactions, xowiki
update_content (scripted)
update_item_index (scripted, public)
<instance of xo::db::CrItem> update_item_indexDummy stub to allow subclasses to produce a more efficient index for items based on live revisions.
- Testcases:
- xotcl_core_tutorial_4, xowiki_test_cases
update_revision (scripted)
www-revisions (scripted)
Variables
::xo::db::CrItem set __default_metaclass ::xotcl::Class ::xo::db::CrItem set __default_superclass ::xotcl::Object ::xo::db::CrItem set abstract_p f ::xo::db::CrItem set auto_save false ::xo::db::CrItem array set db_constraints {nls_language {{default en_US}} mime_type \ {{references cr_mime_types} {default text/plain}} item_id {{references \ {cr_items on delete cascade}}}} ::xo::db::CrItem array set db_slot \ {creation_date ::xo::db::Object::slot::creation_date creation_user \ ::xo::db::Object::slot::creation_user object_id ::xo::db::Object::slot::object_id description \ ::xo::db::CrItem::slot::description creation_ip ::xo::db::Object::slot::creation_ip text \ ::xo::db::CrItem::slot::text nls_language ::xo::db::CrItem::slot::nls_language object_title \ ::xo::db::Object::slot::object_title package_id ::xo::db::Object::slot::package_id name \ ::xo::db::CrItem::slot::name security_inherit_p ::xo::db::Object::slot::security_inherit_p \ context_id ::xo::db::Object::slot::context_id mime_type ::xo::db::CrItem::slot::mime_type \ title ::xo::db::CrItem::slot::title revision_id ::xo::db::CrItem::slot::revision_id item_id \ ::xo::db::CrItem::slot::item_id last_modified ::xo::db::Object::slot::last_modified \ publish_date ::xo::db::CrItem::slot::publish_date modifying_user \ ::xo::db::Object::slot::modifying_user modifying_ip ::xo::db::Object::slot::modifying_ip} ::xo::db::CrItem set folder_id -100 ::xo::db::CrItem set id_column revision_id ::xo::db::CrItem set mime_type text/plain ::xo::db::CrItem set name_method {} ::xo::db::CrItem set non_cached_instance_var_patterns __* ::xo::db::CrItem set object_type content_revision ::xo::db::CrItem set object_type_key 0000000000001111 ::xo::db::CrItem set pretty_name CrItem ::xo::db::CrItem set pretty_plural CrItem ::xo::db::CrItem set security_inherit_p t ::xo::db::CrItem set sql_package_name ::xo::db::CrItem ::xo::db::CrItem set storage_type text ::xo::db::CrItem set supertype content_revision ::xo::db::CrItem set table_name cr_revisions ::xo::db::CrItem set with_table true
- Methods: All Methods Documented Methods Hide Methods
- Source: Display Source Hide Source
- Variables: Show Variables Hide Variables