The datasource will contain a column called "text", representing the main content (blob) of the revision, but only if the revision has a textual mime-type. - + @param revision_id The revision whose attributes are to be retrieved - + @option item_id The item_id of the corresponding item. You can provide this as an optimization. - If you don't provide revision_id, you must provide item_id, + If you don't provide revision_id, you must provide item_id, and the item must have a live revision. - + @return 1 on success (and set the array in the calling frame), - 0 on failure - + 0 on failure + @see content::item::get_content } { @@ -375,25 +375,25 @@ if { $item_id eq "" } { ns_log notice "item::get_content: no such revision: $revision_id" return 0 - } + } } elseif { $revision_id eq "" } { set revision_id [::content::item::get_live_revision -item_id $item_id] } if { $revision_id eq "" } { error "You must supply revision_id, or the item must have a live revision." } - + return [item::get_revision_content $revision_id $item_id] } ad_proc -public -deprecated item::content_is_null { revision_id } { @public content_is_null - + Determines if the content for the revision is null (not mereley zero-length) @param revision_id The revision id - + @return 1 if the content is null, 0 otherwise @see content::item::content_is_null @@ -407,52 +407,52 @@ ad_proc -public -deprecated item::get_revision_content { revision_id args } { @public get_revision_content - + Create a onerow datasource called content in the calling frame which contains all attributes for the revision (including inherited ones).
The datasource will contain a column called "text", representing the main content (blob) of the revision, but only if the revision has a textual mime-type. - + @param revision_id The revision whose attributes are to be retrieved - + @option item_id {default auto-generated} The item_id of the corresponding item. - + @return 1 on success (and create a content array in the calling frame), - 0 on failure - + 0 on failure + @see content::item::get_revision_content } { template::util::get_opts $args - + if { ![info exists opts(item_id)] } { # Get the item id set item_id [::content::revision::item_id -revision_id $revision_id] if { [template::util::is_nil item_id] } { ns_log warning "item::get_revision_content: No such revision: $revision_id" return 0 - } + } } else { set item_id $opts(item_id) } # Get the mime type, decide if we want the text content::item::get -item_id $item_id -array_name item_info - if { [info exists item_info(mime_type)] - && $item_info(mime_type) ne "" - && [string match "text/*" $item_info(mime_type)] + if { [info exists item_info(mime_type)] + && $item_info(mime_type) ne "" + && [string match "text/*" $item_info(mime_type)] } { set text_sql [db_map grc_get_all_content_1] } else { set text_sql "" } - + # Get the content type set content_type $item_info(content_type) @@ -464,38 +464,38 @@ # Get (all) the content (note this is really dependent on file type) db_0or1row grc_get_all_content "" -column_array content - if { ![array exists content] } { + if { ![array exists content] } { ns_log warning "item::get_revision_content: No data found for item $item_id, revision $revision_id" return 0 } - + return 1 } ad_proc -public -deprecated item::content_methods_by_type { content_type args } { @public content_methods_by_type - - Determines all the valid content methods for instantiating + + Determines all the valid content methods for instantiating a content type. - Possible choices are text_entry, file_upload, no_content and + Possible choices are text_entry, file_upload, no_content and xml_import. Currently, this proc merely removes the text_entry method if the item does not have a text mime type registered to it. In the future, a more sophisticated mechanism will be implemented. - + @param content_type The content type - + @option get_labels Return not just a list of types, but a list of name-value pairs, as in the -options - ATS switch for form widgets - + ATS switch for form widgets + @return A Tcl list of all possible content methods @see content::item::content_methods_by_type } { - + template::util::get_opts $args set types [db_list cmbt_get_content_mime_types ""] @@ -509,14 +509,14 @@ if { $need_text } { lappend methods [list "Text Entry" text_entry] - } + } lappend methods [list "XML Import" xml_import] } else { set methods [list no_content file_upload] if { $need_text } { lappend methods text_entry - } + } lappend methods xml_import } @@ -528,16 +528,16 @@ ad_proc -public -deprecated item::get_mime_info { revision_id {datasource_ref mime_info} } { @public get_mime_info - + Creates a onerow datasource in the calling frame which holds the mime_type and file_extension of the specified revision. If the revision does not exist, does not create the datasource. - + @param revision_id The revision id @param datasource_ref {default mime_info} The name of the - datasource to be created. The datasource will have two columns, + datasource to be created. The datasource will have two columns, mime_type and file_extension. - + return 1 (one) if the revision exists, 0 (zero) otherwise. @see proc content::item::get @@ -550,22 +550,22 @@ ad_proc -public -deprecated item::get_extended_url { item_id args } { Retrieves the relative URL of the item with a file extension based - on the item's mime_type (Example: "/foo/bar/baz.html"). - + on the item's mime_type (Example: "/foo/bar/baz.html"). + @param item_id The item id - + @option template_extension Signifies that the file extension should be retrieved using the mime_type of the template assigned to the item, not from the item itself. The live revision of the template is used. If there is no template which could be used to render the item, or if the template has no live revision, the extension defaults to ".html" - + @option revision_id {default the live revision} Specifies the revision_id which will be used to retrieve the item's mime_type. - This option is ignored if the -template_extension + This option is ignored if the -template_extension option is specified. - + @return The relative URL of the item with the appropriate file extension or an empty string on failure @see proc item::get_url @@ -595,11 +595,11 @@ set template_id [get_template_id $item_id] if { ![template::util::is_nil template_id] } { - # Get extension from the template mime type + # Get extension from the template mime type set template_revision_id [::content::item::get_best_revision -item_id $template_id] if { ![template::util::is_nil template_revision_id] } { - get_mime_info $template_revision_id mime_info + get_mime_info $template_revision_id mime_info if { [info exists mime_info(file_extension)] } { set file_extension $mime_info(file_extension) @@ -623,16 +623,16 @@ set revision_id $opts(revision_id) } - get_mime_info $revision_id mime_info + get_mime_info $revision_id mime_info if { [info exists mime_info(file_extension)] } { set file_extension $mime_info(file_extension) - } else { + } else { set file_extension "html" } } append file_url ".$file_extension" - + return $file_url } @@ -691,22 +691,22 @@ ####################################################### # -# all the following procs are deprecated and do not have +# all the following procs are deprecated and do not have # direct sql calls. # ####################################################### ad_proc -public -deprecated item::get_title { item_id } { @public get_title - + Get the title for the item. If a live revision for the item exists, use the live revision. Otherwise, use the latest revision. - + @param item_id The item id - + @return The title of the item - + @see item::get_best_revision @see content::item::get_title @@ -717,22 +717,22 @@ ad_proc -public -deprecated item::get_publish_status { item_id } { @public get_publish_status - + Get the publish status of the item. The publish status will be one of - the following: + the following: