- 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)
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
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
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.
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
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
update_attribute_from_slot (scripted)
<instance of xo::db::CrItem> update_attribute_from_slot
- Testcases:
- slot_interactions, xowiki
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
- Methods: All Methods Documented Methods Hide Methods
- Source: Display Source Hide Source
- Variables: Show Variables Hide Variables