Class ::acs::DocHelper |
|
Helper class to determine the sourcefile, where some "public",
"private", or plain "methods" is defined. |
acs::DocHelper instproc method |
|
Intercept "method" definitions to record the current
filename for the API browser. |
acs::DocHelper instproc protected |
|
Intercept "protected method" definitions to record the
current filename for the API browser. |
acs::DocHelper instproc public |
|
Intercept "public method" definitions to record the
current filename for the API browser. |
acs_package_root_dir |
|
Returns the path root for a particular package within the OpenACS installation. |
acs_root_dir |
|
Returns the path root for the OpenACS installation. |
ad_after_server_initialization |
|
Registers code to run after server initialization is complete. |
ad_arg_parser |
|
Parses an argument list for a database call (switches at the end). |
ad_assert_arg_value_in_list |
|
For use at the beginning of the body of a procedure to
check that an argument has one of a number of allowed values. |
ad_call_method |
|
Calls method_name for the type of object_id with object_id as the
first arg, and the remaining args are the remainder of the args to
method_name. |
ad_dispatch |
|
Calls method_name with the type as the first arg, and the remaining args are
the remainder of the args to method_name. |
ad_file |
|
Tcl supports csh-style tilde substitution. |
ad_find_all_files |
|
Returns a list of full paths to all files under $path in the
directory tree (descending the tree to a depth of up to
$max_depth). |
ad_library |
|
Provides documentation for a library (<code>-procs.tcl</code> file). |
ad_log_deprecated |
|
Provide a standardized interface for reporting deprecated ad_procs
or other artifacts. |
ad_make_relative_path |
|
Returns the relative path corresponding to absolute path $path. |
ad_method |
|
Defines a method for type based dispatch. |
ad_proc |
|
<p>
Declare a procedure with the following enhancements
over regular Tcl "<code>proc</code>":
</p>
<p>
<ul>
<li> A procedure can be declared as public, private, deprecated, and warn.</li>
<li> Procedures can be declared with regular <i>positional</i> parameters (where
you pass parameters in the order they were declared), or with <i>named</i>
parameters, where the order doesn't matter because parameter names are
specified explicitly when calling the parameter. |
ad_with_deprecated_code_p |
|
Check, if we should load deprecated code. |
apm_bootstrap_upgrade |
|
Copy the files from acs-bootstrap-installer/installer/tcl to the
Tcl files in the acs root directory. |
apm_first_time_loading_p |
|
Returns 1 if this is a -procs.tcl file's first time loading, or 0 otherwise. |
apm_get_package_files |
|
<p>
Returns all files, or files of a certain types, belonging to an
APM package. |
apm_guess_db_type |
|
Guesses and returns the database type key corresponding to a particular path
(or an empty string if none is known). |
apm_guess_file_type |
|
Guesses and returns the file type key corresponding to a particular path
(or an empty string if none is known). |
apm_ignore_file_p |
|
Return 1 if $path should, in general, be ignored for package operations. |
apm_is_catalog_file |
|
Given a file path return 1 if the path represents a message
catalog file and 0 otherwise. |
apm_package_supports_rdbms_p |
|
Returns 1 if the given package supports the rdbms of the system and 0 otherwise. |
apm_parse_catalog_path |
|
Given the path of a file attempt to extract package_key,
prefix, charset and locale
information from the path assuming the path is on valid format
for a message catalog file. |
apm_source |
|
Sources $__file in a clean environment, returning 1 if successful or 0 if not. |
callback |
|
Invoke the registered callback implementations for the given
callback. |
db_available_pools |
|
Returns a list of the available pools for the given database name. |
db_current_rdbms |
|
|
db_fullquery_get_querytext |
|
Accessor for fullquery data abstraction |
db_map |
|
fetch a query snippet. |
db_qd_fetch |
|
Fetch a query with a given name
This procedure returns the latest FullQuery data structure
given proper scoping rules for a complete/global query name. |
db_qd_get_fullname |
|
Find the fully qualified name of the query |
db_qd_load_query_file |
|
A procedure that is called from the outside world (APM)
to load a particular file |
db_qd_prepare_queryfile_content |
|
Prepare raw .xql-file content form xml-parsing via quoting. |
db_qd_replace_sql |
|
|
db_rdbms_create |
|
The function is not needed, since all it returns is a plain Tcl
dict with obvious keys (type and version) |
empty_string_p |
|
returns 1 if a string is empty; this is better than using == because it won't fail on long strings of numbers. |