- Publicity: Public Only All
acs-developer-support-procs.tcl
Provides routines used to aggregate request/response information for debugging.
- Location:
- packages/acs-developer-support/tcl/acs-developer-support-procs.tcl
- Created:
- 22 Apr 2000
- Author:
- Jon Salz
Procedures in this file
- ds_add (public)
- ds_adp_box_class (public)
- ds_adp_end_box (public)
- ds_adp_file_class (public)
- ds_adp_output_class (public)
- ds_adp_start_box (public)
- ds_collect_connection_info (public)
- ds_collect_db_call (public)
- ds_collection_enabled_p (public)
- ds_comment (public)
- ds_database_enabled_p (public)
- ds_enabled_p (public)
- ds_init (public)
- ds_link (public)
- ds_page_fragment_cache_enabled_p (public)
- ds_profile (public)
- ds_profiling_enabled_p (public)
- ds_show_p (public)
Detailed information
ds_add (public)
ds_add name [ args... ]
Sets a developer-support property for the current request.
- Parameters:
- name (required)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_add_test
ds_adp_box_class (public)
ds_adp_box_class
Return developer support adp box class on/off
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_adp_reveal_test
ds_adp_end_box (public)
ds_adp_end_box [ -stub stub ]
Appends adp end box if the show toggle is true
- Switches:
- -stub (optional, defaults to
"$__adp_stub"
)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- callgraph__bad_page_calls, web_forum_new, web_forum_edit, web_forums_message_and_reply
ds_adp_file_class (public)
ds_adp_file_class
Return developer support adp file on/off
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_adp_reveal_test
ds_adp_output_class (public)
ds_adp_output_class
Return developer support adp output on/off
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_adp_reveal_test
ds_adp_start_box (public)
ds_adp_start_box [ -stub stub ]
Appends adp start box if the show toggle is true
- Switches:
- -stub (optional, defaults to
"$__adp_stub"
)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- callgraph__bad_page_calls, web_forum_new, web_forum_edit, web_forums_message_and_reply
ds_collect_connection_info (public)
ds_collect_connection_info
Collect information about the current connection. Should be called only at the very beginning of the request processor handler.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
ds_collect_db_call (public)
ds_collect_db_call db command statement_name sql start_time errno \ error
Collects stats for a single database call
- Parameters:
- db (required)
- command (required)
- statement_name (required)
- sql (required)
- start_time (required)
- errno (required)
- error (required)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_add_test
ds_collection_enabled_p (public)
ds_collection_enabled_p
Returns whether we're collecting information about this request
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_features_enabled_test
ds_comment (public)
ds_comment value
Adds a comment to the developer-support information for the current request.
- Parameters:
- value (required)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_add_test
ds_database_enabled_p (public)
ds_database_enabled_p
Returns true if developer-support database facilities are enabled.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_features_enabled_test
ds_enabled_p (public)
ds_enabled_p
- Returns:
- true if developer-support facilities are enabled.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_features_enabled_test
ds_init (public)
ds_init
Perform setup for the developer support for a single request. We save the state in global variables to avoid highly redundant computations (up to 50 times per page on openacs.org)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_features_enabled_test
ds_link (public)
ds_link
Returns the "Developer Information" link in a right-aligned table, if enabled.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_link_test
ds_page_fragment_cache_enabled_p (public)
ds_page_fragment_cache_enabled_p
Are we populating the page fragment cache?
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_features_enabled_test
ds_profile (public)
ds_profile command [ tag ]
Helper proc for performance profiling of templates. This will record the total time spent within an invocation of a template (computed as time between the 'ds_profile start' and 'ds_profile stop' invocations inserted by the template engine).
- Parameters:
- command (required)
- Must be "start" or "stop".
- tag (optional)
- In practice, the path to the template being profiled.
- start marks the beginning of a block.
- stop marks the end of a block. Start and stops must match.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_add_test
ds_profiling_enabled_p (public)
ds_profiling_enabled_p
Returns true if developer-support template profiling facilities are enabled.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_features_enabled_test
ds_show_p (public)
ds_show_p
Should we show developer-support on the current connection.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- ds_features_enabled_test