+Public Methods:
+
content::add_attribute_element
|
@@ -68,34 +68,34 @@
- Parameters:
+ Parameters:
- form_name
+ | form_name
* |
-
+ |
The name of the ATS form object to which the element should be added. |
- content_type
+ | content_type
* |
-
+ |
The content type keyword to which this attribute belongs. |
- attribute
+ | attribute
* |
-
+ |
The name of the attribute, as represented in the attribute_name column of the acs_attributes table. |
- attribute_data
+ | attribute_data
* |
-
+ |
Optional nested list of parameter data for the the attribute (generated by get_attribute_params). |
@@ -107,7 +107,7 @@
-
+
content::add_attribute_elements
|
@@ -118,33 +118,33 @@
- Parameters:
+ Parameters:
- form_name
+ | form_name
* |
-
+ |
The name of the ATS form object to which objects should be added. |
- content_type
+ | content_type
* |
-
+ |
The content type keyword for which attribute widgets should be added. |
- revision_id
+ | revision_id
* |
-
+ |
The revision from which default values should be queried |
- - Returns:
+
- Returns:
-
The list of attributes that were added.
@@ -154,7 +154,7 @@
-
+
content::add_basic_revision
|
@@ -165,52 +165,52 @@
- Parameters:
+ Parameters:
- item_id
+ | item_id
* |
-
+ |
|
- revision_id
+ | revision_id
* |
-
+ |
|
- title
+ | title
* |
-
+ |
|
- - Options:
+
- Options:
- description |
-
+ | description |
+
|
- mime_type |
-
+ | mime_type |
+
|
- text |
-
+ | text |
+
|
- tmpfile |
-
+ | tmpfile |
+
|
@@ -222,7 +222,7 @@
-
+
content::add_child_relation_element
|
@@ -233,28 +233,28 @@
- Parameters:
+ Parameters:
- form_name
+ | form_name
* |
-
+ |
The name of the form |
- - Options:
+
- Options:
- section |
-
+ | section |
+
- none If present, creates a new form section for the element. |
+ none If present, creates a new form section for the element.
- label |
-
+ | label |
+
{Child relation tag} The label for the element |
@@ -266,7 +266,7 @@
-
+
content::add_content
|
@@ -277,13 +277,13 @@
- Parameters:
+ Parameters:
- revision_id
+ | revision_id
* |
-
+ |
The object ID of the revision to be updated. |
@@ -295,7 +295,7 @@
-
+
content::add_content_element
|
@@ -306,20 +306,20 @@
- Parameters:
+ Parameters:
- form_name
+ | form_name
* |
-
+ |
The name of the form to which the object should be added. |
- content_method
+ | content_method
* |
-
+ |
One of no_content, text_entry or file_upload |
@@ -331,7 +331,7 @@
-
+
content::add_revision
|
@@ -342,20 +342,20 @@
- Parameters:
+ Parameters:
- form_name
+ | form_name
* |
-
+ |
Name of the form from which to obtain attribute values. The form should include an item_id and revision_id. |
- tmpfile
+ | tmpfile
* |
-
+ |
Name of the temporary file containing the content to upload. |
@@ -367,7 +367,7 @@
-
+
content::add_revision_form
|
@@ -378,41 +378,41 @@
- - Options:
+
- Options:
- form_name |
-
+ | form_name |
+
The name of the ATS form object. Defaults to { new_item} . |
- content_type |
-
+ | content_type |
+
The content_type of the item. Defaults to { content_revision} . |
- content_method |
-
+ | content_method |
+
The method to use for uploading the content body. If the content type is text, defaults to text entry, otherwise defaults to file upload. |
- item_id |
-
+ | item_id |
+
The item ID of the revision. Defaults to null (item_id must be set by the calling code). |
- revision_id |
-
+ | revision_id |
+
The revision ID from which to draw default values. Defaults to the latest revision |
- attributes |
-
+ | attributes |
+
A list of attribute names for which to create form elements. |
- action |
-
+ | action |
+
The URL to which the form should redirect following a successful form submission. |
@@ -424,7 +424,7 @@
-
+
content::copy_content
|
@@ -435,20 +435,20 @@
- Parameters:
+ Parameters:
- revision_id_src
+ | revision_id_src
* |
-
+ |
The object ID of the revision with the content to be copied. |
- revision_id_dest
+ | revision_id_dest
* |
-
+ |
The object ID of the revision to be updated. copied. |
@@ -460,7 +460,7 @@
-
+
content::get_attribute_enum_values
|
@@ -471,13 +471,13 @@
- Parameters:
+ Parameters:
- attribute_id
+ | attribute_id
* |
-
+ |
The primary key of the attribute as in the attribute_id column of the acs_attributes table. |
@@ -489,7 +489,7 @@
-
+
content::get_latest_revision
|
@@ -500,13 +500,13 @@
- Parameters:
+ Parameters:
- item_id
+ | item_id
* |
-
+ |
The ID of the content item. |
@@ -518,7 +518,7 @@
-
+
-
+
content::new_item
|
@@ -546,26 +546,26 @@
- Parameters:
+ Parameters:
- form_name
+ | form_name
* |
-
+ |
Name of the form from which to obtain item attributes, as well as attributes of the initial revision. The form should include an item_id, name and revision_id. |
- tmpfile
+ | tmpfile
* |
-
+ |
Name of the temporary file containing the content to upload for the initial revision. |
- - See Also:
+
- See Also:
- add_revision -
@@ -574,7 +574,7 @@
-
+
content::new_item_form
|
@@ -585,41 +585,41 @@
- - Options:
+
- Options:
- form_name |
-
+ | form_name |
+
The name of the ATS form object. Defaults to { new_item} . |
- content_type |
-
+ | content_type |
+
The content_type of the item. Defaults to { content_revision} . |
- content_method |
-
+ | content_method |
+
The method to use for uploading the content body. Valid values are { no_content} , { text_entry} , and { file_upload} . If the content type allows text, defaults to text entry, otherwise defaults to file upload. |
- parent_id |
-
+ | parent_id |
+
The item ID of the parent. Defaults to null (Parent is the root folder). |
- name |
-
+ | name |
+
The default name of the item. Default is an empty string (User must supply name). |
- attributes |
-
+ | attributes |
+
A list of attribute names for which to create form elements. |
- action |
-
+ | action |
+
The URL to which the form should redirect following a successful form submission. |
@@ -631,7 +631,7 @@
-
+
content::validate_name
|
@@ -642,19 +642,19 @@
- Parameters:
+ Parameters:
- form_name
+ | form_name
* |
-
+ |
The name of the form (containing name and parent_id) |
- - Returns:
+
- Returns:
-
0 if there are items with the same name, 1 otherwise
@@ -669,8 +669,8 @@
-Private Methods:
-
+Private Methods:
+
content::add_revision_dml
|
@@ -681,40 +681,40 @@
- Parameters:
+ Parameters:
- statement
+ | statement
* |
-
+ |
The DML for the insert statement, specifying a bind variable for each column value. |
- bind_vars
+ | bind_vars
* |
-
+ |
An ns_set containing the values for all bind variables. |
- tmpfile
+ | tmpfile
* |
-
+ |
The server-side name of the file containing the body of the revision to upload into the content BLOB column of cr_revisions. |
- filename
+ | filename
* |
-
+ |
The client-side name of the file containing the body of the revision to upload into the content BLOB column of cr_revisions |
- - See Also:
+
- See Also:
- add_revision -
@@ -723,7 +723,7 @@
-
+
content::attribute_insert_statement
|
@@ -734,34 +734,34 @@
- Parameters:
+ Parameters:
- content_type
+ | content_type
* |
-
+ |
The content type of the item for which a new revision is being prepared. |
- table_name
+ | table_name
* |
-
+ |
The storage table of the content type. |
- bind_vars
+ | bind_vars
* |
-
+ |
The name of an ns_set in which to store the attribute values for the revision. (Typically duplicates the contents of {[ns_getform].} |
- form_name
+ | form_name
* |
-
+ |
The name of the ATS form object used to process the submission. |
@@ -773,7 +773,7 @@
-
+
content::get_attribute_params
|
@@ -784,20 +784,20 @@
- Parameters:
+ Parameters:
- content_type
+ | content_type
* |
-
+ |
The content type keyword to which this attribute belongs. |
- attribute_name
+ | attribute_name
* |
-
+ |
The name of the attribute, as represented in the attribute_name column of the acs_attributes table. |
@@ -809,7 +809,7 @@
-
+
content::get_attributes
|
@@ -820,20 +820,20 @@
- Parameters:
+ Parameters:
- content_type
+ | content_type
* |
-
+ |
The name of the content type (ACS Object Type) for which to obtain the list of attributes. |
- args
+ | args
* |
-
+ |
Names of columns to query. If no columns are specified, returns a simple list of attribute names. |
@@ -845,7 +845,7 @@
-
+
content::get_default_content_method
|
@@ -856,13 +856,13 @@
- Parameters:
+ Parameters:
- content_type
+ | content_type
* |
-
+ |
The content type for which an input method is needed. |
@@ -874,7 +874,7 @@
-
+
content::get_sql_value
|
@@ -885,20 +885,20 @@
- Parameters:
+ Parameters:
- name
+ | name
* |
-
+ |
The name of the column and bind variable (they should be the same). |
- datatype
+ | datatype
* |
-
+ |
The datatype of the column. |
@@ -910,7 +910,7 @@
-
+
content::get_type_attribute_params
|
@@ -921,19 +921,19 @@
- Parameters:
+ Parameters:
- args
+ | args
* |
-
+ |
Any number of object types |
- - Returns:
+
- Returns:
-
A list of attribute parameters nested by object_type, attribute_name and the is_html flag. For attributes with no parameters, there is a single entry with is_html as null.
@@ -943,7 +943,7 @@
-
+
content::get_type_info
|
@@ -954,27 +954,27 @@
- Parameters:
+ Parameters:
- object_type
+ | object_type
* |
-
+ |
Object type key for which info is required. |
- ref
+ | ref
* |
-
+ |
If no further arguments, name of the column value to return. If further arguments are specified, name of the array in which to store info in the calling |
- args
+ | args
* |
-
+ |
Column names to query. |
@@ -986,7 +986,7 @@
-
+
content::get_widget_param_value
|
@@ -997,20 +997,20 @@
- Parameters:
+ Parameters:
- array_ref
+ | array_ref
* |
-
+ |
The name of an array in the calling frame containing parameter data selected from the form metadata. |
- content_type
+ | content_type
* |
-
+ |
The current content {type;} defaults to content_revision |
@@ -1022,7 +1022,7 @@
-
+
content::prepare_content_file
|
@@ -1033,19 +1033,19 @@
- Parameters:
+ Parameters:
- form_name
+ | form_name
* |
-
+ |
The name of the form object in which content was submitted. |
- - Returns:
+
- Returns:
-
The path of the temporary file containing the content, or an empty string if the form does not include a content element or the value of the element is null.
@@ -1055,7 +1055,7 @@
-
+
content::set_attribute_values
|
@@ -1066,34 +1066,34 @@
- Parameters:
+ Parameters:
- form_name
+ | form_name
* |
-
+ |
The name of the ATS form object containing the attribute elements. |
- content_type
+ | content_type
* |
-
+ |
The type of item being revised in the form. |
- revision_id
+ | revision_id
* |
-
+ |
The revision ID from where to get the default values |
- attributes
+ | attributes
* |
-
+ |
The list of attributes whose values should be set. |
@@ -1105,7 +1105,7 @@
-
+
content::set_content_value
|
@@ -1116,20 +1116,20 @@
- Parameters:
+ Parameters:
- form_name
+ | form_name
* |
-
+ |
The name of the ATS form object containing the content element. |
- revision_id
+ | revision_id
* |
-
+ |
The revision ID of the content to revise |
@@ -1141,7 +1141,7 @@
-
+
content::string_to_file
|
@@ -1152,13 +1152,13 @@
- Parameters:
+ Parameters:
- s
+ | s
* |
-
+ |
The string to write to the file. |
@@ -1170,7 +1170,7 @@
-
+
content::update_content_from_file
|
@@ -1181,20 +1181,20 @@
- Parameters:
+ Parameters:
- revision_id
+ | revision_id
* |
-
+ |
The object ID of the revision to update. |
- tmpfile
+ | tmpfile
* |
-
+ |
The name of a temporary file containing the content. The file is deleted following the update. |
@@ -1206,7 +1206,7 @@
-
+
content::upload_content
|
@@ -1217,34 +1217,34 @@
- Parameters:
+ Parameters:
- db
+ | db
* |
-
+ |
A db handle |
- revision_id
+ | revision_id
* |
-
+ |
The revision to which the content belongs |
- tmpfile
+ | tmpfile
* |
-
+ |
The server-side name of the file containing the body of the revision to upload into the content BLOB column of cr_revisions. |
- filename
+ | filename
* |
-
+ |
The client-side name of the file containing the body of the revision to upload into the content BLOB column of cr_revisions |
@@ -1258,7 +1258,7 @@
-
+
* indicates required
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|