5.7.17. Bugzilla::Config¶

5.7.17.1. NAME¶

Bugzilla::Config - Configuration parameters for Bugzilla

5.7.17.2. SYNOPSIS¶

# Administration functions
use Bugzilla::Config qw(:admin);

update_params();
SetParam($param, $value);
write_params();

5.7.17.3. DESCRIPTION¶

This package contains ways to access Bugzilla configuration parameters.

5.7.17.4. FUNCTIONS¶

Parameters¶

Parameters can be set, retrieved, and updated.

SetParam($name, $value)

Sets the param named $name to $value. Values are checked using the checker function for the given param if one exists.

update_params()

Updates the parameters, by transitioning old params to new formats, setting defaults for new params, and removing obsolete ones. Used by checksetup.plin the process of an installation or upgrade.

Prints out information about what it’s doing, if it makes any changes.

May prompt the user for input, if certain required parameters are not specified.

write_params($params)

Description: Writes the parameters to disk.

Params: $params (optional) - A hashref to write to the disk

instead of Bugzilla->params. Used only by update_params.

Returns: nothing

read_param_file()

Description: Most callers should never need this. This is used

by Bugzilla->params to directly read $datadir/params.jsonand load it into memory. Use Bugzilla->params instead.

Params: none

Returns: A hashref containing the current params in $datadir/params.json.

param_panels()

This documentation undoubtedly has bugs; if you find some, please file them here.