parameter::get (public)

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

Defined in packages/acs-tcl/tcl/parameter-procs.tcl

Get the value of a package instance parameter.

Switches:

-localize (optional, boolean)

should we attempt to localize the parameter

-boolean (optional, boolean)

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:

• parameter::get_global_value

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

Testcases:

auth_password_change, locale__test_system_package_setting, acs_subsite_test_email_confirmation, password_recovery_page, subsite_api, parameter_register_test, parameter__check_procs, logout_from_everywhere, cookie_consent__setup

Source code:

    if {$package_id eq ""} {
        set package_id [ad_requested_object_id]
    }
    set value ""

    # 1. check whether there is a parameter by this name specified for
    # the package in the parameter file.  The name
    # ad_parameter_from_configuration_file is a misnomer, since it checks
    # ns_config values
    #
    if {$package_id ne ""} {
        set package_key [apm_package_key_from_id $package_id]
        set value [ad_parameter_from_configuration_file $parameter $package_key]
    }

    # 2. check the parameter cache
    if {$value eq ""} {
        set value [ad_parameter_cache $package_id $parameter]
    }

    # 3. use the default value
    if {$value eq ""} {
        set value $default
    }

    if { $localize_p } {
        # Replace message keys in hash marks with localized texts
        set value [lang::util::localize $value]
    }
    #
    # Normalize boolean results if required, since "true" and "false"
    # can be written in many different ways.
    #
    if { $boolean_p } {
        set value [string is true -strict $value]
    }

    return $value

Generic XQL file:

packages/acs-tcl/tcl/parameter-procs.xql

PostgreSQL XQL file:

packages/acs-tcl/tcl/parameter-procs-postgresql.xql

Oracle XQL file:

packages/acs-tcl/tcl/parameter-procs-oracle.xql