Index: openacs-4/packages/acs-content-repository/www/doc/api/folder.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-content-repository/www/doc/api/folder.adp,v diff -u -r1.2 -r1.2.2.1 --- openacs-4/packages/acs-content-repository/www/doc/api/folder.adp 27 Oct 2014 16:39:14 -0000 1.2 +++ openacs-4/packages/acs-content-repository/www/doc/api/folder.adp 25 Aug 2015 18:02:03 -0000 1.2.2.1 @@ -2,24 +2,35 @@ {/doc/acs-content-repository {Content Repository}} {Package: content_folder} Package: content_folder - - -

content_folder

Content Repository : -content_folder

Overview
Related Objects
API

Overview

Content folders contain related content items and allow content +

Overview

Content folders contain related content items and allow content managers to group content as they see fit. Within a content folder, content items must have unique names since this is where they will be served from. For example within the folder "movies" (served from "/movies") all items must have unique names, such as: "terminator," "terminator2" (served from "/movies/terminator, -"/movies/terminator2" respectively).

Related Objects

+"/movies/terminator2" respectively).

Related Objects

+ See also: Content Item -

API

Function: -content_folder.get_index_page

Returns the item ID of the index page of the folder, null -otherwise

+content_folder.get_index_page +

Returns the item ID of the index page of the folder, null +otherwise

@@ -32,9 +43,13 @@ ) return cr_items.item_id%TYPE; -

Author:	Michael Pih

-Function: content_folder.get_label

Returns the label for the folder. This function is the default -name method for the folder object.

+Function: content_folder.get_label

Returns the label for the folder. This function is the default +name method for the folder object.

+ @@ -50,8 +65,12 @@ -

Author:	Karl Goldstein
See Also:	acs_object_type.create_type, the docs for the name_method parameter

-Function: content_folder.is_empty

Determine if the folder is empty

+Function: content_folder.is_empty

Determine if the folder is empty

+ @@ -67,8 +86,12 @@ -

Author:	Karl Goldstein
See Also:	content_folder.is_folder

-Function: content_folder.is_folder

Determine if the item is a folder

+Function: content_folder.is_folder

Determine if the item is a folder

+ @@ -83,11 +106,15 @@ -

Author:	Karl Goldstein
See Also:	content_folder.new, content_folder.is_sub_folder

+ +

+
- Function: -content_folder.is_registered
change this to is_type_registered Determines if a content type +content_folder.is_registered

change this to is_type_registered Determines if a content type is registered to the folder Only items of the registered type(s) -may be added to the folder.

+may be added to the folder.

@@ -114,11 +141,15 @@ -

Author:	Karl Goldstein
See Also:	content_folder.register_content_type, content_folder.unregister_content_type,

+ +

+
- Function: -content_folder.is_sub_folder
Determine if the item target_folder_id is a subfolder +content_folder.is_sub_folder

Determine if the item target_folder_id is a subfolder of the item folder_id -

@@ -139,8 +170,12 @@ -

Author:	Karl Goldstein
See Also:	content_folder.is_folder

-Function: content_folder.new

Create a new folder

+Function: content_folder.new

Create a new folder

+ @@ -185,11 +220,15 @@ -

Author:	Karl Goldstein
See Also:	acs_object.new, content_item.new

-Procedure: content_folder.copy

Recursively copy the folder and all items in into a new + +

+Procedure: content_folder.copy

Recursively copy the folder and all items in into a new location. An error is thrown if either of the parameters is not a folder. The root folder of the sitemap and the root folder of the -templates cannot be copied

+templates cannot be copied

Author:

Karl Goldstein

Parameters:

@@ -207,9 +246,13 @@ -
See Also: content_folder.new, content_folder.copy

-Procedure: content_folder.delete
Delete a folder. An error is thrown if the folder is not -empty
+
+

+
+Procedure: content_folder.delete
+
Delete a folder. An error is thrown if the folder is not +empty
+

Author: Karl Goldstein
Parameters:
@@ -222,11 +265,15 @@ -
See Also: acs_object.delete, content_item.delete

-Procedure: content_folder.move
Recursively move the folder and all items in into a new +
+

+
+Procedure: content_folder.move
+
Recursively move the folder and all items in into a new location. An error is thrown if either of the parameters is not a folder. The root folder of the sitemap and the root folder of the -templates cannot be moved.
+templates cannot be moved.
+

Author: Karl Goldstein
Parameters:
@@ -244,11 +291,15 @@ -
See Also: content_folder.new, content_folder.copy

+
+

+
Procedure: -content_folder.register_content_type
Register a content type to the folder, if it is not already +content_folder.register_content_type +
Register a content type to the folder, if it is not already registered. Only items of the registered type(s) may be added to -the folder.
+the folder.
+

Author: Karl Goldstein
Parameters:
@@ -268,8 +319,12 @@ -
See Also: content_folder.unregister_content_type, content_folder.is_registered

-Procedure: content_folder.edit_name
Change the name, label and/or description of the folder
+
+

+
+Procedure: content_folder.edit_name
+
Change the name, label and/or description of the folder
+

Author: Karl Goldstein
Parameters:
@@ -297,12 +352,16 @@ -
See Also: content_folder.new

+
+

+
Procedure: -content_folder.unregister_content_type
Unregister a content type from the folder, if it has been +content_folder.unregister_content_type +
Unregister a content type from the folder, if it has been registered. Only items of the registered type(s) may be added to the folder. If the folder already contains items of the type to be -unregistered, the items remain in the folder.
+unregistered, the items remain in the folder.
+

Author: Karl Goldstein
Parameters:
@@ -325,7 +384,8 @@ -
See Also: content_folder.register_content_type, content_folder.is_registered

+
+

+ Last Modified: $Id: folder.html,v 1.2 2004/06/01 22:54:18 donb Exp $ -