← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/bugzilla/intrepid

« back to all changes in this revision

Viewing changes to docs/html/api/Bugzilla/Config.html

  • Committer: Bazaar Package Importer
  • Author(s): Raphael Bossek
  • Date: 2008-06-27 22:34:34 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20080627223434-0ib57vstn43bb4a3
Tags: 3.0.4.1-1
http://bugs.debian.org/488251
* Update of French, Russian and German translations. (closes: #488251)
* Added Bulgarian and Belarusian translations.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/api/Bugzilla/Config.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
 
<html>
3
 
  <head>
4
 
    <title>
5
 
Bugzilla::Config</title>
6
 
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7
 
  <link rel="stylesheet" title="style" type="text/css" href="../style.css" media="all" >
8
 
 
9
 
</head>
10
 
  <body id="pod">
11
 
<p class="backlinktop"><b><a name="___top" href="../index.html" accesskey="1" title="All Documents">&lt;&lt;</a></b></p>
12
 
<h1>Bugzilla::Config</h1>
13
 
<div class='indexgroup'>
14
 
<ul   class='indexList indexList1'>
15
 
  <li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
16
 
  <li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</a>
17
 
  <li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
18
 
  <li class='indexItem indexItem1'><a href='#FUNCTIONS'>FUNCTIONS</a>
19
 
  <ul   class='indexList indexList2'>
20
 
    <li class='indexItem indexItem2'><a href='#Parameters'>Parameters</a>
21
 
  </ul>
22
 
</ul>
23
 
</div>
24
 
 
25
 
<h1><a class='u' href='#___top' title='click to go to top of document'
26
 
name="NAME"
27
 
>NAME</a></h1>
28
 
 
29
 
<p>Bugzilla::Config - Configuration parameters for Bugzilla</p>
30
 
 
31
 
<h1><a class='u' href='#___top' title='click to go to top of document'
32
 
name="SYNOPSIS"
33
 
>SYNOPSIS</a></h1>
34
 
 
35
 
<pre  class="code">  # Administration functions
36
 
  use Bugzilla::Config qw(:admin);
37
 
 
38
 
  update_params();
39
 
  SetParam($param, $value);
40
 
  write_params();</pre>
41
 
 
42
 
<h1><a class='u' href='#___top' title='click to go to top of document'
43
 
name="DESCRIPTION"
44
 
>DESCRIPTION</a></h1>
45
 
 
46
 
<p>This package contains ways to access Bugzilla configuration parameters.</p>
47
 
 
48
 
<h1><a class='u' href='#___top' title='click to go to top of document'
49
 
name="FUNCTIONS"
50
 
>FUNCTIONS</a></h1>
51
 
 
52
 
<h2><a class='u' href='#___top' title='click to go to top of document'
53
 
name="Parameters"
54
 
>Parameters</a></h2>
55
 
 
56
 
<p>Parameters can be set, retrieved, and updated.</p>
57
 
 
58
 
<dl>
59
 
<dt><a name="SetParam($name,_$value)"
60
 
><code  class="code">SetParam($name, $value)</code></a></dt>
61
 
 
62
 
<dd>
63
 
<p>Sets the param named $name to $value. Values are checked using the checker function for the given param if one exists.</p>
64
 
 
65
 
<dt><a name="update_params()"
66
 
><code  class="code">update_params()</code></a></dt>
67
 
 
68
 
<dd>
69
 
<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>
70
 
 
71
 
<p>Prints out information about what it&#39;s doing, if it makes any changes.</p>
72
 
 
73
 
<p>May prompt the user for input, if certain required parameters are not specified.</p>
74
 
 
75
 
<dt><a name="write_params($params)"
76
 
><code  class="code">write_params($params)</code></a></dt>
77
 
 
78
 
<dd>
79
 
<p>Description: Writes the parameters to disk.</p>
80
 
 
81
 
<p>Params: <code  class="code">$params</code> (optional) - A hashref to write to the disk instead of <code  class="code">Bugzilla-</code>params&#62;. Used only by <code  class="code">update_params</code>.</p>
82
 
 
83
 
<p>Returns: nothing</p>
84
 
 
85
 
<dt><a name="read_param_file()"
86
 
><code  class="code">read_param_file()</code></a></dt>
87
 
 
88
 
<dd>
89
 
<p>Description: Most callers should never need this. This is used by <code  class="code">Bugzilla-</code>params&#62; to directly read <code  class="code">$datadir/params</code> and load it into memory. Use <code  class="code">Bugzilla-</code>params&#62; instead.</p>
90
 
 
91
 
<p>Params: none</p>
92
 
 
93
 
<p>Returns: A hashref containing the current params in <code  class="code">$datadir/params</code>.</p>
94
 
</dd>
95
 
</dl>
96
 
<p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents">&lt;&lt;</a></b></p>
97
 
 
98
 
<!-- end doc -->
99
 
 
100
 
</body></html>