← Back to branch summary

~ubuntu-branches/debian/sid/bugzilla/sid

« back to all changes in this revision

Viewing changes to docs/html/api/Bugzilla/CGI.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/CGI.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::CGI</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::CGI</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='#CHANGES_FROM_CGI.PM'>CHANGES FROM CGI.PM</a>
19
 
  <li class='indexItem indexItem1'><a href='#ADDITIONAL_FUNCTIONS'>ADDITIONAL FUNCTIONS</a>
20
 
  <li class='indexItem indexItem1'><a href='#SEE_ALSO'>SEE ALSO</a>
21
 
</ul>
22
 
</div>
23
 
 
24
 
<h1><a class='u' href='#___top' title='click to go to top of document'
25
 
name="NAME"
26
 
>NAME</a></h1>
27
 
 
28
 
<p>Bugzilla::CGI - CGI handling for Bugzilla</p>
29
 
 
30
 
<h1><a class='u' href='#___top' title='click to go to top of document'
31
 
name="SYNOPSIS"
32
 
>SYNOPSIS</a></h1>
33
 
 
34
 
<pre  class="code">  use Bugzilla::CGI;
35
 
 
36
 
  my $cgi = new Bugzilla::CGI();</pre>
37
 
 
38
 
<h1><a class='u' href='#___top' title='click to go to top of document'
39
 
name="DESCRIPTION"
40
 
>DESCRIPTION</a></h1>
41
 
 
42
 
<p>This package inherits from the standard CGI module, to provide additional Bugzilla-specific functionality. In general, see <a href="../CGI.html" class="podlinkpod"
43
 
>the CGI.pm docs</a> for documention.</p>
44
 
 
45
 
<h1><a class='u' href='#___top' title='click to go to top of document'
46
 
name="CHANGES_FROM_CGI.PM"
47
 
>CHANGES FROM <a href="../CGI.html" class="podlinkpod"
48
 
>CGI.PM</a></a></h1>
49
 
 
50
 
<p>Bugzilla::CGI has some differences from <a href="../CGI.html" class="podlinkpod"
51
 
>CGI.pm</a>.</p>
52
 
 
53
 
<dl>
54
 
<dt><a name="cgi_error_is_automatically_checked"
55
 
><code  class="code">cgi_error</code> is automatically checked</a></dt>
56
 
 
57
 
<dd>
58
 
<p>After creating the CGI object, <code  class="code">Bugzilla::CGI</code> automatically checks <i>cgi_error</i>, and throws a CodeError if a problem is detected.</p>
59
 
</dd>
60
 
</dl>
61
 
 
62
 
<h1><a class='u' href='#___top' title='click to go to top of document'
63
 
name="ADDITIONAL_FUNCTIONS"
64
 
>ADDITIONAL FUNCTIONS</a></h1>
65
 
 
66
 
<p><i>Bugzilla::CGI</i> also includes additional functions.</p>
67
 
 
68
 
<dl>
69
 
<dt><a name="canonicalise_query(@exclude)"
70
 
><code  class="code">canonicalise_query(@exclude)</code></a></dt>
71
 
 
72
 
<dd>
73
 
<p>This returns a sorted string of the parameters, suitable for use in a url. Values in <code  class="code">@exclude</code> are not included in the result.</p>
74
 
 
75
 
<dt><a name="send_cookie"
76
 
><code  class="code">send_cookie</code></a></dt>
77
 
 
78
 
<dd>
79
 
<p>This routine is identical to the cookie generation part of CGI.pm&#39;s <code  class="code">cookie</code> routine, except that it knows about Bugzilla&#39;s cookie_path and cookie_domain parameters and takes them into account if necessary. This should be used by all Bugzilla code (instead of <code  class="code">cookie</code> or the <code  class="code">-cookie</code> argument to <code  class="code">header</code>), so that under mod_perl the headers can be sent correctly, using <code  class="code">print</code> or the mod_perl APIs as appropriate.</p>
80
 
 
81
 
<p>To remove (expire) a cookie, use <code  class="code">remove_cookie</code>.</p>
82
 
 
83
 
<dt><a name="remove_cookie"
84
 
><code  class="code">remove_cookie</code></a></dt>
85
 
 
86
 
<dd>
87
 
<p>This is a wrapper around send_cookie, setting an expiry date in the past, effectively removing the cookie.</p>
88
 
 
89
 
<p>As its only argument, it takes the name of the cookie to expire.</p>
90
 
 
91
 
<dt><a name="require_https($baseurl)"
92
 
><code  class="code">require_https($baseurl)</code></a></dt>
93
 
 
94
 
<dd>
95
 
<p>This routine checks if the current page is being served over https, and redirects to the https protocol if required, retaining QUERY_STRING.</p>
96
 
 
97
 
<p>It takes an option argument which will be used as the base URL. If $baseurl is not provided, the current URL is used.</p>
98
 
</dd>
99
 
</dl>
100
 
 
101
 
<h1><a class='u' href='#___top' title='click to go to top of document'
102
 
name="SEE_ALSO"
103
 
>SEE ALSO</a></h1>
104
 
 
105
 
<p><a href="../CGI.html" class="podlinkpod"
106
 
>CGI</a>, <a href="../CGI/Cookie.html" class="podlinkpod"
107
 
>CGI::Cookie</a></p>
108
 
<p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents">&lt;&lt;</a></b></p>
109
 
 
110
 
<!-- end doc -->
111
 
 
112
 
</body></html>