<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title> Bugzilla::Config</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" title="style" type="text/css" href=".././../../../style.css" media="all" > </head> <body id="pod"> <p class="backlinktop"><b><a name="___top" href="../index.html" accesskey="1" title="All Documents"><<</a></b></p> <h1>Bugzilla::Config</h1> <div class='indexgroup'> <ul class='indexList indexList1'> <li class='indexItem indexItem1'><a href='#NAME'>NAME</a> <li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</a> <li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a> <li class='indexItem indexItem1'><a href='#FUNCTIONS'>FUNCTIONS</a> <ul class='indexList indexList2'> <li class='indexItem indexItem2'><a href='#Parameters'>Parameters</a> </ul> </ul> </div> <h1><a class='u' href='#___top' title='click to go to top of document' name="NAME" >NAME</a></h1> <p>Bugzilla::Config - Configuration parameters for Bugzilla</p> <h1><a class='u' href='#___top' title='click to go to top of document' name="SYNOPSIS" >SYNOPSIS</a></h1> <pre class="code"> # Administration functions use Bugzilla::Config qw(:admin); update_params(); SetParam($param, $value); write_params();</pre> <h1><a class='u' href='#___top' title='click to go to top of document' name="DESCRIPTION" >DESCRIPTION</a></h1> <p>This package contains ways to access Bugzilla configuration parameters.</p> <h1><a class='u' href='#___top' title='click to go to top of document' name="FUNCTIONS" >FUNCTIONS</a></h1> <h2><a class='u' href='#___top' title='click to go to top of document' name="Parameters" >Parameters</a></h2> <p>Parameters can be set, retrieved, and updated.</p> <dl> <dt><a name="SetParam($name,_$value)" ><code class="code">SetParam($name, $value)</code></a></dt> <dd> <p>Sets the param named $name to $value. Values are checked using the checker function for the given param if one exists.</p> <dt><a name="update_params()" ><code class="code">update_params()</code></a></dt> <dd> <p>Updates the parameters, by transitioning old params to new formats, setting defaults for new params, and removing obsolete ones. Used by <em class="code">checksetup.pl</em> in the process of an installation or upgrade.</p> <p>Prints out information about what it's doing, if it makes any changes.</p> <p>May prompt the user for input, if certain required parameters are not specified.</p> <dt><a name="write_params($params)" ><code class="code">write_params($params)</code></a></dt> <dd> <p>Description: Writes the parameters to disk.</p> <p>Params: <code class="code">$params</code> (optional) - A hashref to write to the disk instead of <code class="code">Bugzilla-</code>params>. Used only by <code class="code">update_params</code>.</p> <p>Returns: nothing</p> <dt><a name="read_param_file()" ><code class="code">read_param_file()</code></a></dt> <dd> <p>Description: Most callers should never need this. This is used by <code class="code">Bugzilla-</code>params> to directly read <code class="code">$datadir/params</code> and load it into memory. Use <code class="code">Bugzilla-</code>params> instead.</p> <p>Params: none</p> <p>Returns: A hashref containing the current params in <code class="code">$datadir/params</code>.</p> </dd> </dl> <p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents"><<</a></b></p> <!-- end doc --> </body></html>