• Publicity: Public Only All

parameter-procs.tcl

parameter procs

Location:
packages/acs-tcl/tcl/parameter-procs.tcl
Created:
May 12, 2002
Author:
yon <yon@openforce.net>
CVS Identification:
$Id: parameter-procs.tcl,v 1.26.2.12 2022/09/29 16:10:37 gustafn Exp $

Procedures in this file

Detailed information

parameter::get (public)

 parameter::get [ -localize ] [ -boolean ] [ -package_id package_id ] \
    -parameter parameter [ -default default ]

Get the value of a package instance parameter.

Switches:
-localize
(boolean) (optional)
should we attempt to localize the parameter
-boolean
(boolean) (optional)
ensure boolean parameters are normalized to 0 or 1
-package_id
(optional)
what package to get the parameter from. Defaults to [ad_conn package_id]
-parameter
(required)
which parameter's value to get
-default
(optional)
what to return if we don't find a value. Defaults to returning the empty string.
Returns:
The string trimmed (leading and trailing spaces removed) parameter value
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_subsite_test_email_confirmation acs_subsite_test_email_confirmation (test acs-subsite) parameter::get parameter::get test_acs_subsite_test_email_confirmation->parameter::get test_auth_password_change auth_password_change (test acs-authentication) test_auth_password_change->parameter::get test_cookie_consent__setup cookie_consent__setup (test cookie-consent) test_cookie_consent__setup->parameter::get test_locale__test_system_package_setting locale__test_system_package_setting (test acs-lang) test_locale__test_system_package_setting->parameter::get test_logout_from_everywhere logout_from_everywhere (test acs-tcl) test_logout_from_everywhere->parameter::get ad_parameter_cache ad_parameter_cache (public) parameter::get->ad_parameter_cache ad_parameter_from_file ad_parameter_from_file (public) parameter::get->ad_parameter_from_file ad_requested_object_id ad_requested_object_id (private) parameter::get->ad_requested_object_id apm_package_key_from_id apm_package_key_from_id (public) parameter::get->apm_package_key_from_id lang::util::localize lang::util::localize (public) parameter::get->lang::util::localize aa_test::xml_report_dir aa_test::xml_report_dir (public) aa_test::xml_report_dir->parameter::get acs::test::url acs::test::url (public) acs::test::url->parameter::get acs_admin::check_expired_certificates acs_admin::check_expired_certificates (private) acs_admin::check_expired_certificates->parameter::get acs_community_member_admin_url acs_community_member_admin_url (public) acs_community_member_admin_url->parameter::get acs_community_member_page acs_community_member_page (public) acs_community_member_page->parameter::get

Testcases:
auth_password_change, locale__test_system_package_setting, acs_subsite_test_email_confirmation, password_recovery_page, parameter_register_test, parameter__check_procs, logout_from_everywhere, cookie_consent__setup

parameter::get_from_package_key (public)

 parameter::get_from_package_key [ -localize ] [ -boolean ] \
    -package_key package_key -parameter parameter [ -default default ]

Gets an instance parameter for the package corresponding to package_key. Note that this makes the assumption that the package is a singleton. New packages should use global parameters instead.

Switches:
-localize
(boolean) (optional)
-boolean
(boolean) (optional)
-package_key
(required)
what package to get the parameter from. We will try to get the package_id from the package_key. This may cause an error if there are more than one instance of this package
-parameter
(required)
which parameter's value to get
-default
(optional)
what to return if we don't find a value

Partial Call Graph (max 5 caller/called nodes):
%3 test_parameter__check_procs parameter__check_procs (test acs-tcl) parameter::get_from_package_key parameter::get_from_package_key test_parameter__check_procs->parameter::get_from_package_key test_spellcheck__get_element_formtext spellcheck__get_element_formtext (test acs-templating) test_spellcheck__get_element_formtext->parameter::get_from_package_key test_spellcheck__spellcheck_properties spellcheck__spellcheck_properties (test acs-templating) test_spellcheck__spellcheck_properties->parameter::get_from_package_key ad_parameter_from_file ad_parameter_from_file (public) parameter::get_from_package_key->ad_parameter_from_file apm_package_id_from_key apm_package_id_from_key (public) parameter::get_from_package_key->apm_package_id_from_key apm_package_singleton_p apm_package_singleton_p (private) parameter::get_from_package_key->apm_package_singleton_p parameter::get parameter::get (public) parameter::get_from_package_key->parameter::get parameter::get_global_value parameter::get_global_value (public) parameter::get_from_package_key->parameter::get_global_value Object ::throttle Object ::throttle (public) Object ::throttle->parameter::get_from_package_key aa_selenium_init aa_selenium_init (private) aa_selenium_init->parameter::get_from_package_key acs::disk_cache_eval acs::disk_cache_eval (public) acs::disk_cache_eval->parameter::get_from_package_key acs_admin::check_expired_certificates acs_admin::check_expired_certificates (private) acs_admin::check_expired_certificates->parameter::get_from_package_key acs_mail_lite::address_domain acs_mail_lite::address_domain (private) acs_mail_lite::address_domain->parameter::get_from_package_key

Testcases:
parameter__check_procs, spellcheck__get_element_formtext, spellcheck__spellcheck_properties

parameter::get_global_value (public)

 parameter::get_global_value [ -localize ] [ -boolean ] \
    -package_key package_key -parameter parameter [ -default default ]

Get the value of a global package parameter.

Switches:
-localize
(boolean) (optional)
should we attempt to localize the parameter
-boolean
(boolean) (optional)
ensure boolean parameters are normalized to 0 or 1
-package_key
(required)
identifies the package to which the global param belongs
-parameter
(required)
which parameter's value to get
-default
(optional)
what to return if we don't find a value. Defaults to returning the empty string.
Returns:
The string trimmed (leading and trailing spaces removed) parameter value
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_parameter__check_procs parameter__check_procs (test acs-tcl) parameter::get_global_value parameter::get_global_value test_parameter__check_procs->parameter::get_global_value test_parameter_register_test parameter_register_test (test acs-tcl) test_parameter_register_test->parameter::get_global_value ad_parameter_cache ad_parameter_cache (public) parameter::get_global_value->ad_parameter_cache ad_parameter_from_file ad_parameter_from_file (public) parameter::get_global_value->ad_parameter_from_file lang::util::localize lang::util::localize (public) parameter::get_global_value->lang::util::localize packages/file-storage/www/folder-chunk.tcl packages/file-storage/ www/folder-chunk.tcl packages/file-storage/www/folder-chunk.tcl->parameter::get_global_value packages/news/www/admin/index.tcl packages/news/ www/admin/index.tcl packages/news/www/admin/index.tcl->parameter::get_global_value packages/news/www/index.tcl packages/news/ www/index.tcl packages/news/www/index.tcl->parameter::get_global_value parameter::get_from_package_key parameter::get_from_package_key (public) parameter::get_from_package_key->parameter::get_global_value rss_gen_service rss_gen_service (private) rss_gen_service->parameter::get_global_value

Testcases:
parameter_register_test, parameter__check_procs

parameter::set_default (public)

 parameter::set_default -package_key package_key -parameter parameter \
    -value value

Set the default for the package parameter to the provided value. The new default will be used for new installs of the package but does not change existing package instances values.

Switches:
-package_key
(required)
what package to set the parameter for
-parameter
(required)
which parameter's value to set
-value
(required)
what value to set said parameter to

Partial Call Graph (max 5 caller/called nodes):
%3 test_parameter__check_procs parameter__check_procs (test acs-tcl) parameter::set_default parameter::set_default test_parameter__check_procs->parameter::set_default db_dml db_dml (public) parameter::set_default->db_dml install::xml::action::set-parameter-default install::xml::action::set-parameter-default (public) install::xml::action::set-parameter-default->parameter::set_default openacs_default_theme::install::after_install openacs_default_theme::install::after_install (private) openacs_default_theme::install::after_install->parameter::set_default

Testcases:
parameter__check_procs

parameter::set_from_package_key (public)

 parameter::set_from_package_key -package_key package_key \
    -parameter parameter -value value

sets an instance parameter for the package corresponding to package_key. Note that this makes the assumption that the package is a singleton and does not set the value for all packages corresponding to package_key. New packages should use global parameters instead.

Switches:
-package_key
(required)
-parameter
(required)
-value
(required)

Partial Call Graph (max 5 caller/called nodes):
%3 test_parameter__check_procs parameter__check_procs (test acs-tcl) parameter::set_from_package_key parameter::set_from_package_key test_parameter__check_procs->parameter::set_from_package_key apm_package_id_from_key apm_package_id_from_key (public) parameter::set_from_package_key->apm_package_id_from_key parameter::set_value parameter::set_value (public) parameter::set_from_package_key->parameter::set_value packages/xml-rpc/www/admin/toggle.tcl packages/xml-rpc/ www/admin/toggle.tcl packages/xml-rpc/www/admin/toggle.tcl->parameter::set_from_package_key

Testcases:
parameter__check_procs

parameter::set_global_value (public)

 parameter::set_global_value -package_key package_key \
    -parameter parameter -value value

Set a global package parameter. Do not confuse this with the proc "set_from_package_key", which was previously used to emulate global parameters declared for singleton packages.

Switches:
-package_key
(required)
identifies the package to which the global param belongs
-parameter
(required)
which parameter's value to set
-value
(required)
what value to set said parameter to

Partial Call Graph (max 5 caller/called nodes):
%3 test_parameter__check_procs parameter__check_procs (test acs-tcl) parameter::set_global_value parameter::set_global_value test_parameter__check_procs->parameter::set_global_value acs::clusterwide acs::clusterwide parameter::set_global_value->acs::clusterwide ad_parameter_cache ad_parameter_cache (public) parameter::set_global_value->ad_parameter_cache db_exec_plsql db_exec_plsql (public) parameter::set_global_value->db_exec_plsql packages/acs-subsite/www/shared/parameters.tcl packages/acs-subsite/ www/shared/parameters.tcl packages/acs-subsite/www/shared/parameters.tcl->parameter::set_global_value

Testcases:
parameter__check_procs

parameter::set_value (public)

 parameter::set_value [ -package_id package_id ] -parameter parameter \
    -value value

Set the value of a package instance parameter.

Switches:
-package_id
(optional)
what package to set the parameter in. Defaults to [ad_conn package_id]
-parameter
(required)
which parameter's value to set
-value
(required)
what value to set said parameter to

Partial Call Graph (max 5 caller/called nodes):
%3 test_auth_email_on_password_change auth_email_on_password_change (test acs-authentication) parameter::set_value parameter::set_value test_auth_email_on_password_change->parameter::set_value test_auth_password_change auth_password_change (test acs-authentication) test_auth_password_change->parameter::set_value test_auth_use_email_for_login_p auth_use_email_for_login_p (test acs-authentication) test_auth_use_email_for_login_p->parameter::set_value test_locale__test_system_package_setting locale__test_system_package_setting (test acs-lang) test_locale__test_system_package_setting->parameter::set_value test_parameter__check_procs parameter__check_procs (test acs-tcl) test_parameter__check_procs->parameter::set_value acs::clusterwide acs::clusterwide parameter::set_value->acs::clusterwide ad_parameter_cache ad_parameter_cache (public) parameter::set_value->ad_parameter_cache ad_requested_object_id ad_requested_object_id (private) parameter::set_value->ad_requested_object_id db_exec_plsql db_exec_plsql (public) parameter::set_value->db_exec_plsql acs_admin::check_expired_certificates acs_admin::check_expired_certificates (private) acs_admin::check_expired_certificates->parameter::set_value acs_admin::require_site_wide_package acs_admin::require_site_wide_package (public) acs_admin::require_site_wide_package->parameter::set_value acs_privacy::privacy_control_set acs_privacy::privacy_control_set (public) acs_privacy::privacy_control_set->parameter::set_value bug_tracker::install_parameters_setup bug_tracker::install_parameters_setup (public) bug_tracker::install_parameters_setup->parameter::set_value fs::install::upgrade fs::install::upgrade (private) fs::install::upgrade->parameter::set_value

Testcases:
auth_password_change, auth_use_email_for_login_p, auth_email_on_password_change, locale__test_system_package_setting, password_recovery_page, parameter__check_procs
[ show source ]