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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
<?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 Class Auth_OpenID_Association</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="class-name">Class Auth_OpenID_Association</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This class represents an association between a server and a consumer. In general, users of this library will never see instances of this object. The only exception is if you implement a custom <a href="../OpenID/Auth_OpenID_OpenIDStore.html">Auth_OpenID_OpenIDStore</a>.</p>
<p class="description"><p>If you do implement such a store, it will need to store the values of the handle, secret, issued, lifetime, and assoc_type instance variables.</p></p>
<p class="notes">
Located in <a class="field" href="_Auth---OpenID---Association.php.html">/Auth/OpenID/Association.php</a> (line <span class="field">44</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result"><a href="../OpenID/Auth_OpenID_Association.html">Auth_OpenID_Association</a></span>
<a href="#deserialize" title="details" class="method-name">deserialize</a>
(<span class="var-type"></span> <span class="var-name">$class_name</span>, <span class="var-type">string</span> <span class="var-name">$assoc_s</span>)
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#equal" title="details" class="method-name">equal</a>
(<span class="var-type"></span> <span class="var-name">$other</span>)
</div>
<div class="method-definition">
<span class="method-result">integer</span>
<a href="#getExpiresIn" title="details" class="method-name">getExpiresIn</a>
([<span class="var-type"></span> <span class="var-name">$now</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#serialize" title="details" class="method-name">serialize</a>
()
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methoddeserialize" id="deserialize"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">deserialize</span> (line <span class="line-number">204</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parse an association as stored by serialize(). This is the inverse of serialize.</p>
<ul class="tags">
<li><span class="field">return:</span> instance of this class</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../OpenID/Auth_OpenID_Association.html">Auth_OpenID_Association</a></span>
<span class="method-name">
deserialize
</span>
(<span class="var-type"></span> <span class="var-name">$class_name</span>, <span class="var-type">string</span> <span class="var-name">$assoc_s</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$assoc_s</span><span class="var-description">: Association as serialized by serialize()</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$class_name</span> </li>
</ul>
</div>
<a name="methodequal" id="equal"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">equal</span> (line <span class="line-number">165</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This checks to see if two <a href="../OpenID/Auth_OpenID_Association.html">Auth_OpenID_Association</a> instances represent the same association.</p>
<ul class="tags">
<li><span class="field">return:</span> true if the two instances represent the same association, false otherwise.</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
equal
</span>
(<span class="var-type"></span> <span class="var-name">$other</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$other</span> </li>
</ul>
</div>
<a name="methodgetExpiresIn" id="getExpiresIn"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getExpiresIn</span> (line <span class="line-number">149</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This returns the number of seconds this association is still valid for, or 0 if the association is no longer valid.</p>
<ul class="tags">
<li><span class="field">return:</span> The number of seconds this association is still valid for, or 0 if the association is no longer valid.</li>
</ul>
<div class="method-signature">
<span class="method-result">integer</span>
<span class="method-name">
getExpiresIn
</span>
([<span class="var-type"></span> <span class="var-name">$now</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$now</span> </li>
</ul>
</div>
<a name="methodserialize" id="serialize"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">serialize</span> (line <span class="line-number">181</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Convert an association to KV form.</p>
<ul class="tags">
<li><span class="field">return:</span> String in KV form suitable for deserialization by deserialize.</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
serialize
</span>
()
</div>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 05 Dec 2007 14:02:09 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>
|
