• Publicity: Public Only All

filter-procs.tcl


Procedures in this file

Detailed information

content::deploy (public, deprecated)

 content::deploy url_stub
Deprecated. Invoking this procedure generates a warning.

render the template and write it to the filesystem with template::util::write_file DEPRECATED: since its birth ~2003 this proc refers to a nonexistent variable and is therefore broken.

Parameters:
url_stub
See Also:
  • modern ways to produce templated content e.g. theme packages or xowiki pages

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) content::init content::init (public) template::adp_parse template::adp_parse (public) template::util::write_file template::util::write_file (public) content::deploy content::deploy content::deploy->ad_log_deprecated content::deploy->content::init content::deploy->template::adp_parse content::deploy->template::util::write_file

Testcases:
No testcase defined.

content::get_content (public)

 content::get_content [ content_type ]

sets the content in the array "content" in the callers scope assumes item_id or revision_id is set in the ::content namespace.

Parameters:
content_type (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 acs_object_type::get_table_name acs_object_type::get_table_name (public) db_0or1row db_0or1row (public) db_map db_map (public) db_string db_string (public) template::util::is_nil template::util::is_nil (public) content::get_content content::get_content content::get_content->acs_object_type::get_table_name content::get_content->db_0or1row content::get_content->db_map content::get_content->db_string content::get_content->template::util::is_nil

Testcases:
No testcase defined.

content::get_content_value (public)

 content::get_content_value revision_id
Parameters:
revision_id
Returns:
content element corresponding to the provided revision_id

Partial Call Graph (max 5 caller/called nodes):
%3 content::init content::init (public) content::get_content_value content::get_content_value content::init->content::get_content_value db_exec_plsql db_exec_plsql (public) content::get_content_value->db_exec_plsql db_string db_string (public) content::get_content_value->db_string db_transaction db_transaction (public) content::get_content_value->db_transaction

Testcases:
No testcase defined.

content::get_item_id (public)

 content::get_item_id
Returns:
current value of ::content::item_id

Partial Call Graph (max 5 caller/called nodes):
%3

Testcases:
No testcase defined.

content::get_template_root (public)

 content::get_template_root

Find the directory in the filesystem where templates are stored. There are a variety of ways in which this can be set. The proc looks for that directory in the following places in this order: (1) the TemplateRoot parameter of the package for which the request is made, i.e., [ad_conn package_id] (2) the TemplateRoot parameter of the acs-content-repository If it is not found in any of these places, it defaults to $::acs::rootdir/templates If the value resulting from the search does not start with a '/' it is taken to be relative to $::acs::rootdir

Returns:
the template root (full path from /)

Partial Call Graph (max 5 caller/called nodes):
%3 content::init content::init (public) content::get_template_root content::get_template_root content::init->content::get_template_root publish::merge_with_template publish::merge_with_template (private) publish::merge_with_template->content::get_template_root ad_conn ad_conn (public) content::get_template_root->ad_conn apm_package_id_from_key apm_package_id_from_key (public) content::get_template_root->apm_package_id_from_key parameter::get parameter::get (public) content::get_template_root->parameter::get

Testcases:
No testcase defined.

content::get_template_url (public)

 content::get_template_url
Returns:
current value of ::content::template_url

Partial Call Graph (max 5 caller/called nodes):
%3

Testcases:
No testcase defined.

content::has_content (public)

 content::has_content

return true if the request has content associated with it

Returns:
1 if ::content::item_id is defined

Partial Call Graph (max 5 caller/called nodes):
%3

Testcases:
No testcase defined.

content::init (public)

 content::init [ -resolve_index resolve_index ] [ -revision revision ] \
    urlvar rootvar [ content_root ] [ template_root ] [ context ] \
    [ rev_id ] [ content_type ]

Initialize the namespace variables for the ::content procs and figures out which template to use and set up the template for the required content type etc.

Switches:
-resolve_index
(defaults to "f") (optional)
-revision
(defaults to "live") (optional)
Parameters:
urlvar
rootvar
content_root (optional)
template_root (optional)
context (defaults to "public")
rev_id (optional)
content_type (optional)

Partial Call Graph (max 5 caller/called nodes):
%3 content::deploy content::deploy (public, deprecated) content::init content::init content::deploy->content::init content::get_content_value content::get_content_value (public) content::init->content::get_content_value content::get_template_root content::get_template_root (public) content::init->content::get_template_root content::item::get_best_revision content::item::get_best_revision (public) content::init->content::item::get_best_revision content::item::get_content_type content::item::get_content_type (public) content::init->content::item::get_content_type content::item::get_id content::item::get_id (public) content::init->content::item::get_id

Testcases:
No testcase defined.
[ show source ]