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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
<?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_Yadis_Service</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_Yadis_Service</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 a <Service> element in an XRDS document.</p>
<p class="description"><p>Objects of this type are returned by Auth_Yadis_XRDS::services() and Auth_Yadis_Yadis::services(). Each object corresponds directly to a <Service> element in the XRDS and supplies a getElements($name) method which you should use to inspect the element's contents. See <a href="../OpenID/Auth_Yadis_Yadis.html">Auth_Yadis_Yadis</a> for more information on the role this class plays in Yadis discovery.</p></p>
<p class="notes">
Located in <a class="field" href="_Auth---Yadis---XRDS.php.html">/Auth/Yadis/XRDS.php</a> (line <span class="field">83</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">Auth_Yadis_Service</span>
<a href="#Auth_Yadis_Service" title="details" class="method-name">Auth_Yadis_Service</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getElements" title="details" class="method-name">getElements</a>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">mixed</span>
<a href="#getPriority" title="details" class="method-name">getPriority</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getTypes" title="details" class="method-name">getTypes</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getURIs" title="details" class="method-name">getURIs</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#matchTypes" title="details" class="method-name">matchTypes</a>
(<span class="var-type"></span> <span class="var-name">$type_uris</span>)
</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="methodAuth_Yadis_Service" id="Auth_Yadis_Service"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor Auth_Yadis_Service</span> (line <span class="line-number">88</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates an empty service object.</p>
<div class="method-signature">
<span class="method-result">Auth_Yadis_Service</span>
<span class="method-name">
Auth_Yadis_Service
</span>
()
</div>
</div>
<a name="methodgetElements" id="getElements"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getElements</span> (line <span class="line-number">201</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Used to get XML elements from this object's <Service> element.</p>
<p class="description"><p>This is what you should use to get all custom information out of this element. This is used by service filter functions to determine whether a service element contains specific tags, etc. NOTE: this only considers elements which are direct children of the <Service> element for this object.</p></p>
<ul class="tags">
<li><span class="field">return:</span> An array of elements with the specified name which are direct children of the <Service> element. The nodes returned by this function can be passed to $this->parser methods (see <a href="../OpenID/Auth_Yadis_XMLParser.html">Auth_Yadis_XMLParser</a>).</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getElements
</span>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: The name of the element to look for</span> </li>
</ul>
</div>
<a name="methodgetPriority" id="getPriority"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getPriority</span> (line <span class="line-number">175</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the "priority" attribute value of this <Service> element, if the attribute is present. Returns null if not.</p>
<ul class="tags">
<li><span class="field">return:</span> Null or integer, depending on whether this Service element has a 'priority' attribute.</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-name">
getPriority
</span>
()
</div>
</div>
<a name="methodgetTypes" id="getTypes"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getTypes</span> (line <span class="line-number">100</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the URIs in the "Type" elements, if any, of this Service element.</p>
<ul class="tags">
<li><span class="field">return:</span> An array of Type URI strings.</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getTypes
</span>
()
</div>
</div>
<a name="methodgetURIs" id="getURIs"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getURIs</span> (line <span class="line-number">131</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the URIs in the "URI" elements, if any, of this Service element. The URIs are returned sorted in priority order.</p>
<ul class="tags">
<li><span class="field">return:</span> An array of URI strings.</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getURIs
</span>
()
</div>
</div>
<a name="methodmatchTypes" id="matchTypes"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">matchTypes</span> (line <span class="line-number">112</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
matchTypes
</span>
(<span class="var-type"></span> <span class="var-name">$type_uris</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$type_uris</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 05 Dec 2007 14:02:14 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>
|
