← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/html/api/Bugzilla/Auth/Login.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/Auth/Login.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::Auth::Login</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::Auth::Login</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='#DESCRIPTION'>DESCRIPTION</a>
17
 
  <li class='indexItem indexItem1'><a href='#LOGIN_METHODS'>LOGIN METHODS</a>
18
 
  <li class='indexItem indexItem1'><a href='#INFO_METHODS'>INFO METHODS</a>
19
 
</ul>
20
 
</div>
21
 
 
22
 
<h1><a class='u' href='#___top' title='click to go to top of document'
23
 
name="NAME"
24
 
>NAME</a></h1>
25
 
 
26
 
<p>Bugzilla::Auth::Login - Gets username/password data from the user.</p>
27
 
 
28
 
<h1><a class='u' href='#___top' title='click to go to top of document'
29
 
name="DESCRIPTION"
30
 
>DESCRIPTION</a></h1>
31
 
 
32
 
<p>Bugzilla::Auth::Login is used to get information that uniquely identifies a user and allows us to authorize their Bugzilla access.</p>
33
 
 
34
 
<p>It is mostly an abstract class,
35
 
requiring subclasses to implement most methods.</p>
36
 
 
37
 
<p>Note that callers outside of the <code  class="code">Bugzilla::Auth</code> package should never create this object directly.
38
 
Just create a <code  class="code">Bugzilla::Auth</code> object and call <code  class="code">login</code> on it.</p>
39
 
 
40
 
<h1><a class='u' href='#___top' title='click to go to top of document'
41
 
name="LOGIN_METHODS"
42
 
>LOGIN METHODS</a></h1>
43
 
 
44
 
<p>These are methods that have to do with getting the actual login data from the user or handling a login somehow.</p>
45
 
 
46
 
<p>These methods are abstract -- they MUST be implemented by a subclass.</p>
47
 
 
48
 
<dl>
49
 
<dt><a name="get_login_info()"
50
 
><code  class="code">get_login_info()</code></a></dt>
51
 
 
52
 
<dd>
53
 
<p>Description: Gets a username/password from the user,
54
 
or some other information that uniquely identifies them.
55
 
Params: None Returns: A <code  class="code">$login_data</code> hashref.
56
 
(See <a href="../../Bugzilla/Auth.html" class="podlinkpod"
57
 
>Bugzilla::Auth</a> for details.) The hashref MUST contain: <code  class="code">user_id</code> *or* <code  class="code">username</code> If this is a login method that requires verification,
58
 
the hashref MUST contain <code  class="code">password</code>.
59
 
The hashref MAY contain <code  class="code">realname</code> and <code  class="code">extern_id</code>.</p>
60
 
 
61
 
<dt><a name="fail_nodata()"
62
 
><code  class="code">fail_nodata()</code></a></dt>
63
 
 
64
 
<dd>
65
 
<p>Description: This function is called when Bugzilla doesn&#39;t get a username/password and the login type is <code  class="code">LOGIN_REQUIRED</code> (See <a href="../../Bugzilla/Auth.html" class="podlinkpod"
66
 
>Bugzilla::Auth</a> for a description of <code  class="code">LOGIN_REQUIRED</code>).
67
 
That is,
68
 
this handles <code  class="code">AUTH_NODATA</code> in that situation.</p>
69
 
 
70
 
<pre  class="code">             This function MUST stop CGI execution when it is complete.
71
 
             That is, it must call C&#60;exit&#62; or C&#60;ThrowUserError&#62; or some
72
 
             such thing.
73
 
Params:      None
74
 
Returns:     Never Returns.</pre>
75
 
</dd>
76
 
</dl>
77
 
 
78
 
<h1><a class='u' href='#___top' title='click to go to top of document'
79
 
name="INFO_METHODS"
80
 
>INFO METHODS</a></h1>
81
 
 
82
 
<p>These are methods that describe the capabilities of this <code  class="code">Bugzilla::Auth::Login</code> object. These are all no-parameter methods that return either <code  class="code">true</code> or <code  class="code">false</code>.</p>
83
 
 
84
 
<dl>
85
 
<dt><a name="can_logout"
86
 
><code  class="code">can_logout</code></a></dt>
87
 
 
88
 
<dd>
89
 
<p>Whether or not users can log out if they logged in using this object. Defaults to <code  class="code">true</code>.</p>
90
 
 
91
 
<dt><a name="can_login"
92
 
><code  class="code">can_login</code></a></dt>
93
 
 
94
 
<dd>
95
 
<p>Whether or not users can log in through the web interface using this object. Defaults to <code  class="code">true</code>.</p>
96
 
 
97
 
<dt><a name="requires_persistence"
98
 
><code  class="code">requires_persistence</code></a></dt>
99
 
 
100
 
<dd>
101
 
<p>Whether or not we should send the user a cookie if they logged in with this method. Defaults to <code  class="code">true</code>.</p>
102
 
 
103
 
<dt><a name="requires_verification"
104
 
><code  class="code">requires_verification</code></a></dt>
105
 
 
106
 
<dd>
107
 
<p>Whether or not we should check the username/password that we got from this login method. Defaults to <code  class="code">true</code>.</p>
108
 
 
109
 
<dt><a name="user_can_create_account"
110
 
><code  class="code">user_can_create_account</code></a></dt>
111
 
 
112
 
<dd>
113
 
<p>Whether or not users can create accounts, if this login method is currently being used by the system. Defaults to <code  class="code">false</code>.</p>
114
 
</dd>
115
 
</dl>
116
 
<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents">&lt;&lt;</a></b></p>
117
 
 
118
 
<!-- end doc -->
119
 
 
120
 
</body></html>