blob: b40ce29eb88567728c949ed19aec233d7f9b9420 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs for page auth.php</title>
<link rel="stylesheet" href="../../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="file-name">/php/lib/auth.php</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-functions">Functions</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Home-cooked auth libraries - because PEAR is fat.</p>
<ul class="tags">
<li><span class="field">todo:</span> re-enforce one-per-user session limit</li>
</ul>
</div>
</div>
<a name="sec-functions"></a>
<div class="info-box">
<div class="info-box-title">Functions</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Functions</span>
</div>
<div class="info-box-body">
<a name="functionauth_create_session" id="functionauth_create_session"><!-- --></a>
<div class="oddrow">
<div>
<span class="method-title">auth_create_session</span> (line <span class="line-number">56</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Start a valid session.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
auth_create_session
</span>
(<span class="var-type">array</span> <span class="var-name">$user</span>, [<span class="var-type">mixed</span> <span class="var-name">$secure</span> = <span class="var-default">0</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$user</span><span class="var-description">: array containing user information.</span> </li>
</ul>
</div>
<a name="functionauth_is_valid_session" id="functionauth_is_valid_session"><!-- --></a>
<div class="evenrow">
<div>
<span class="method-title">auth_is_valid_session</span> (line <span class="line-number">13</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check admin session against sessions table in database.</p>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
auth_is_valid_session
</span>
()
</div>
</div>
<a name="functionauth_logout" id="functionauth_logout"><!-- --></a>
<div class="oddrow">
<div>
<span class="method-title">auth_logout</span> (line <span class="line-number">68</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Logout.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
auth_logout
</span>
()
</div>
</div>
<a name="functionauth_mysql" id="functionauth_mysql"><!-- --></a>
<div class="evenrow">
<div>
<span class="method-title">auth_mysql</span> (line <span class="line-number">37</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Authentication a user.</p>
<ul class="tags">
<li><span class="field">return:</span> array containing user data or false on failure</li>
</ul>
<div class="method-signature">
<span class="method-result">array|bool</span>
<span class="method-name">
auth_mysql
</span>
(<span class="var-type">string</span> <span class="var-name">$username</span>, <span class="var-type">string</span> <span class="var-name">$password</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$username</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$password</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Mon, 8 Nov 2004 13:43:03 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
</p>
</div></body>
</html>
|