• Publicity: Public Only All

acs-integration-procs.tcl

Interface to the ACS for the ArsDigita Templating System Procedures in this file only make sense if you use the template system together with the ArsDigita Community System

Location:
packages/acs-templating/tcl/acs-integration-procs.tcl
Author:
Christian Brechbuehler
CVS Identification:
$Id: acs-integration-procs.tcl,v 1.27.2.5 2021/02/01 10:54:23 gustafn Exp $

Procedures in this file

Detailed information

ad_parse_template (public)

 ad_parse_template [ -params params ] template

Return a string containing the parsed and evaluated template to the caller.

Switches:
-params (optional)
The parameters to pass to the template. Note that pass-by-reference params must be in the page namespace, they cannot be in a local procedure, or any other namespace.
Parameters:
template - Name of template file

Partial Call Graph (max 5 caller/called nodes):
%3 test_create_form_with_form_instance create_form_with_form_instance (test xowiki) ad_parse_template ad_parse_template test_create_form_with_form_instance->ad_parse_template _ _ (public) ad_parse_template->_ ad_conn ad_conn (public) ad_parse_template->ad_conn template::util::url_to_file template::util::url_to_file (public) ad_parse_template->template::util::url_to_file Class ::xowf::test_item::Answer_manager Class ::xowf::test_item::Answer_manager (public) Class ::xowf::test_item::Answer_manager->ad_parse_template ad_page_contract ad_page_contract (public) ad_page_contract->ad_parse_template ad_page_contract_handle_datasource_error ad_page_contract_handle_datasource_error (public) ad_page_contract_handle_datasource_error->ad_parse_template ad_progress_bar_begin ad_progress_bar_begin (public) ad_progress_bar_begin->ad_parse_template ad_return_complaint ad_return_complaint (public) ad_return_complaint->ad_parse_template

Testcases:
create_form_with_form_instance

ad_return_exception_template (public)

 ad_return_exception_template [ -status status ] [ -params params ] \
    template

Return an exception template and abort the current script.

Switches:
-status (defaults to "500") (optional)
The HTTP status to return, by default HTTP 500 (Error)
-params (optional)
The parameters to pass to the template.
Parameters:
template - The template filename. Example: ad_return_exception_template -params {errmsg {custom_message "My Message"}} some-template

Partial Call Graph (max 5 caller/called nodes):
%3 ad_form ad_form (public) ad_return_exception_template ad_return_exception_template ad_form->ad_return_exception_template ad_parse_template ad_parse_template (public) ad_return_exception_template->ad_parse_template ad_script_abort ad_script_abort (public) ad_return_exception_template->ad_script_abort

Testcases:
No testcase defined.

ad_return_template (public)

 ad_return_template [ -string ] [ template ]

This function is a wrapper for sundry template:: procs. Will set the template for the current page to the file named in 'template'.

Switches:
-string (boolean) (optional)
If specified, will return the resulting page to the caller string instead sending it to the connection.
Parameters:
template (optional) - Name of template file

Partial Call Graph (max 5 caller/called nodes):
%3 bm_handle_bookmark_double_click bm_handle_bookmark_double_click (public) ad_return_template ad_return_template bm_handle_bookmark_double_click->ad_return_template bm_require_delete_permission bm_require_delete_permission (public) bm_require_delete_permission->ad_return_template packages/acs-admin/www/apm/package-add.tcl packages/acs-admin/ www/apm/package-add.tcl packages/acs-admin/www/apm/package-add.tcl->ad_return_template packages/acs-admin/www/apm/package-deinstall.tcl packages/acs-admin/ www/apm/package-deinstall.tcl packages/acs-admin/www/apm/package-deinstall.tcl->ad_return_template packages/acs-admin/www/apm/package-delete-2.tcl packages/acs-admin/ www/apm/package-delete-2.tcl packages/acs-admin/www/apm/package-delete-2.tcl->ad_return_template ad_conn ad_conn (public) ad_return_template->ad_conn template::adp_parse template::adp_parse (public) ad_return_template->template::adp_parse template::set_file template::set_file (public) ad_return_template->template::set_file template::util::url_to_file template::util::url_to_file (public) ad_return_template->template::util::url_to_file

Testcases:
No testcase defined.

adp_parse_ad_conn_file (public)

 adp_parse_ad_conn_file

Handle a request for an adp and/or Tcl file in the template system based on the current setting of [ad_conn file]. This file is registered via rp_register_extension_handler


See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 ad_conn ad_conn (public) ad_return_url ad_return_url (public) apm_package_url_from_key apm_package_url_from_key (public) db_release_unused_handles db_release_unused_handles (public) doc_return doc_return (public) adp_parse_ad_conn_file adp_parse_ad_conn_file adp_parse_ad_conn_file->ad_conn adp_parse_ad_conn_file->ad_return_url adp_parse_ad_conn_file->apm_package_url_from_key adp_parse_ad_conn_file->db_release_unused_handles adp_parse_ad_conn_file->doc_return

Testcases:
No testcase defined.

get_server_root (public, deprecated)

 get_server_root
Deprecated. Invoking this procedure generates a warning.

Get the server root directory (supposing we run under ACS)
THIS PROC IS SUPERSEDED BY acs_root_dir


See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 ad_get_tcl_call_stack ad_get_tcl_call_stack (public) get_server_root get_server_root get_server_root->ad_get_tcl_call_stack

Testcases:
No testcase defined.
[ show source ]