Context Navigation

source: Doc/Backend/PHPDoc/default/UserConnector.html @ 160

Last change on this file since 160 was 160, checked in by jkraaijeveld, 13 years ago
Updated documentation Added PHPDoc
File size: 10.1 KB

Line
1	<?xml version="1.0" encoding="iso-8859-1"?>
2	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3	<html xmlns="http://www.w3.org/1999/xhtml">
4	<head>
5	<!-- template designed by Marco Von Ballmoos -->
6	<title>Docs For Class UserConnector</title>
7	<link rel="stylesheet" href="../media/stylesheet.css" />
8	<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9	</head>
10	<body>
11	<div class="page-body">
12	<h2 class="class-name">Class UserConnector</h2>
13
14	<a name="sec-description"></a>
15	<div class="info-box">
16	<div class="info-box-title">Description</div>
17	<div class="nav-bar">
18	<span class="disabled">Description</span> \|
19	<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
20	\| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
21
22	</div>
23	<div class="info-box-body">
24	<p class="implements">
25	Implements interfaces:
26	<ul>
27	<li><a href="../default/IConnector.html">IConnector</a></li> </ul>
28	</p>
29	<!-- ========== Info from phpDoc block ========= -->
30	<p class="short-description">Description of UserConnector</p>
31	<ul class="tags">
32	<li><span class="field">author:</span> jkraaijeveld</li>
33	</ul>
34	<p class="notes">
35	Located in <a class="field" href="_UserConnector.php.html">/UserConnector.php</a> (line <span class="field">12</span>)
36	</p>
37
38
39	<pre></pre>
40
41	</div>
42	</div>
43
44
45
46	<a name="sec-var-summary"></a>
47	<div class="info-box">
48	<div class="info-box-title">Variable Summary</span></div>
49	<div class="nav-bar">
50	<a href="#sec-description">Description</a> \|
51	<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
52	\|
53	<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
54
55	</div>
56	<div class="info-box-body">
57	<div class="var-summary">
58	<div class="var-title">
59	<span class="var-type">mixed</span>
60	<a href="#$fileName" title="details" class="var-name">$fileName</a>
61	</div>
62	<div class="var-title">
63	<span class="var-type">mixed</span>
64	<a href="#$model" title="details" class="var-name">$model</a>
65	</div>
66	</div>
67	</div>
68	</div>
69
70	<a name="sec-method-summary"></a>
71	<div class="info-box">
72	<div class="info-box-title">Method Summary</span></div>
73	<div class="nav-bar">
74	<a href="#sec-description">Description</a> \|
75	<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
76
77	\|
78	<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
79	</div>
80	<div class="info-box-body">
81	<div class="method-summary">
82
83	<div class="method-definition">
84	<span class="method-result">UserConnector</span>
85	<a href="#__construct" title="details" class="method-name">__construct</a>
86	()
87	</div>
88	<div class="method-definition">
89	<span class="method-result">void</span>
90	<a href="#get" title="details" class="method-name">get</a>
91	(<span class="var-type">type</span> <span class="var-name">$arguments</span>)
92	</div>
93	<div class="method-definition">
94	<span class="method-result">void</span>
95	<a href="#load" title="details" class="method-name">load</a>
96	()
97	</div>
98	<div class="method-definition">
99	<span class="method-result">void</span>
100	<a href="#save" title="details" class="method-name">save</a>
101	()
102	</div>
103	<div class="method-definition">
104	<span class="method-result">void</span>
105	<a href="#set" title="details" class="method-name">set</a>
106	(<span class="var-type">type</span> <span class="var-name">$rToolObject</span>)
107	</div>
108	</div>
109	</div>
110	</div>
111
112	<a name="sec-vars"></a>
113	<div class="info-box">
114	<div class="info-box-title">Variables</div>
115	<div class="nav-bar">
116	<a href="#sec-description">Description</a> \|
117	<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
118
119
120	\|
121	<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
122
123	</div>
124	<div class="info-box-body">
125	<a name="var$fileName" id="$fileName"><!-- --></A>
126	<div class="evenrow">
127
128	<div class="var-header">
129	<span class="var-title">
130	<span class="var-type">mixed</span>
131	<span class="var-name">$fileName</span>
132	= <span class="var-default"> 'data/users/users.rdf'</span> (line <span class="line-number">15</span>)
133	</span>
134	</div>
135
136	<!-- ========== Info from phpDoc block ========= -->
137	<ul class="tags">
138	<li><span class="field">access:</span> protected</li>
139	</ul>
140
141
142
143
144
145	</div>
146	<a name="var$model" id="$model"><!-- --></A>
147	<div class="oddrow">
148
149	<div class="var-header">
150	<span class="var-title">
151	<span class="var-type">mixed</span>
152	<span class="var-name">$model</span>
153	(line <span class="line-number">14</span>)
154	</span>
155	</div>
156
157	<!-- ========== Info from phpDoc block ========= -->
158	<ul class="tags">
159	<li><span class="field">access:</span> protected</li>
160	</ul>
161
162
163
164
165
166	</div>
167
168	</div>
169	</div>
170
171	<a name="sec-methods"></a>
172	<div class="info-box">
173	<div class="info-box-title">Methods</div>
174	<div class="nav-bar">
175	<a href="#sec-description">Description</a> \|
176	<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
177	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
178
179	</div>
180	<div class="info-box-body">
181	<A NAME='method_detail'></A>
182
183	<a name="method__construct" id="__construct"><!-- --></a>
184	<div class="evenrow">
185
186	<div class="method-header">
187	<span class="method-title">Constructor __construct</span> (line <span class="line-number">20</span>)
188	</div>
189
190	<!-- ========== Info from phpDoc block ========= -->
191	<p class="short-description">Constructor for RespondentConnector.</p>
192	<ul class="tags">
193	<li><span class="field">access:</span> public</li>
194	</ul>
195
196	<div class="method-signature">
197	<span class="method-result">UserConnector</span>
198	<span class="method-name">
199	__construct
200	</span>
201	()
202	</div>
203
204
205
206	</div>
207	<a name="methodget" id="get"><!-- --></a>
208	<div class="oddrow">
209
210	<div class="method-header">
211	<span class="method-title">get</span> (line <span class="line-number">53</span>)
212	</div>
213
214	<!-- ========== Info from phpDoc block ========= -->
215	<p class="short-description">function get($arguments) Gets the array of User objects belonging to arguments supplied.</p>
216	<ul class="tags">
217	<li><span class="field">access:</span> public</li>
218	</ul>
219
220	<div class="method-signature">
221	<span class="method-result">void</span>
222	<span class="method-name">
223	get
224	</span>
225	(<span class="var-type">type</span> <span class="var-name">$arguments</span>)
226	</div>
227
228	<ul class="parameters">
229	<li>
230	<span class="var-type">type</span>
231	<span class="var-name">$arguments</span><span class="var-description">: : An array containing zero or more of the following keys: 'uid', 'name', 'password'</span> </li>
232	</ul>
233
234	<hr class="separator" />
235	<div class="notes">Implementation of:</div>
236	<dl>
237	<dt><a href="../default/IConnector.html#methodget">IConnector::get()</a></dt>
238	</dl>
239
240	</div>
241	<a name="methodload" id="load"><!-- --></a>
242	<div class="evenrow">
243
244	<div class="method-header">
245	<span class="method-title">load</span> (line <span class="line-number">31</span>)
246	</div>
247
248	<!-- ========== Info from phpDoc block ========= -->
249	<p class="short-description">function load() Loads the file into the standard MemModel.</p>
250	<ul class="tags">
251	<li><span class="field">access:</span> public</li>
252	</ul>
253
254	<div class="method-signature">
255	<span class="method-result">void</span>
256	<span class="method-name">
257	load
258	</span>
259	()
260	</div>
261
262
263	<hr class="separator" />
264	<div class="notes">Implementation of:</div>
265	<dl>
266	<dt><a href="../default/IConnector.html#methodload">IConnector::load()</a></dt>
267	</dl>
268
269	</div>
270	<a name="methodsave" id="save"><!-- --></a>
271	<div class="oddrow">
272
273	<div class="method-header">
274	<span class="method-title">save</span> (line <span class="line-number">43</span>)
275	</div>
276
277	<!-- ========== Info from phpDoc block ========= -->
278	<p class="short-description">function save() Saves the MemModel into the given file.</p>
279	<ul class="tags">
280	<li><span class="field">access:</span> public</li>
281	</ul>
282
283	<div class="method-signature">
284	<span class="method-result">void</span>
285	<span class="method-name">
286	save
287	</span>
288	()
289	</div>
290
291
292	<hr class="separator" />
293	<div class="notes">Implementation of:</div>
294	<dl>
295	<dt><a href="../default/IConnector.html#methodsave">IConnector::save()</a></dt>
296	</dl>
297
298	</div>
299	<a name="methodset" id="set"><!-- --></a>
300	<div class="evenrow">
301
302	<div class="method-header">
303	<span class="method-title">set</span> (line <span class="line-number">98</span>)
304	</div>
305
306	<!-- ========== Info from phpDoc block ========= -->
307	<p class="short-description">Save the given User object in the file.</p>
308	<ul class="tags">
309	<li><span class="field">access:</span> public</li>
310	</ul>
311
312	<div class="method-signature">
313	<span class="method-result">void</span>
314	<span class="method-name">
315	set
316	</span>
317	(<span class="var-type">type</span> <span class="var-name">$rToolObject</span>)
318	</div>
319
320	<ul class="parameters">
321	<li>
322	<span class="var-type">type</span>
323	<span class="var-name">$rToolObject</span> </li>
324	</ul>
325
326	<hr class="separator" />
327	<div class="notes">Implementation of:</div>
328	<dl>
329	<dt><a href="../default/IConnector.html#methodset">IConnector::set()</a></dt>
330	</dl>
331
332	</div>
333
334	</div>
335	</div>
336
337
338	<p class="notes" id="credit">
339	Documentation generated on Fri, 18 Nov 2011 12:57:06 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
340	</p>
341	</div></body>
342	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: