Context Navigation

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

Last change on this file since 179 was 179, checked in by jkraaijeveld, 13 years ago
Updated documentation and PHPDoc
File size: 7.3 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-vars">Vars</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	<!-- ========== Info from phpDoc block ========= -->
25	<p class="short-description">Description of UserConnector</p>
26	<ul class="tags">
27	<li><span class="field">author:</span> jkraaijeveld</li>
28	</ul>
29	<p class="notes">
30	Located in <a class="field" href="_UserConnector.php.html">/UserConnector.php</a> (line <span class="field">12</span>)
31	</p>
32
33
34	<pre><a href="../default/Connector.html">Connector</a>
35	\|
36	--UserConnector</pre>
37
38	</div>
39	</div>
40
41
42
43
44	<a name="sec-method-summary"></a>
45	<div class="info-box">
46	<div class="info-box-title">Method Summary</span></div>
47	<div class="nav-bar">
48	<a href="#sec-description">Description</a> \|
49	<a href="#sec-vars">Vars</a>
50
51	\|
52	<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
53	</div>
54	<div class="info-box-body">
55	<div class="method-summary">
56
57	<div class="method-definition">
58	<span class="method-result">UserConnector</span>
59	<a href="#__construct" title="details" class="method-name">__construct</a>
60	()
61	</div>
62	<div class="method-definition">
63	<span class="method-result">void</span>
64	<a href="#get" title="details" class="method-name">get</a>
65	(<span class="var-type">type</span> <span class="var-name">$arguments</span>)
66	</div>
67	<div class="method-definition">
68	<span class="method-result">void</span>
69	<a href="#set" title="details" class="method-name">set</a>
70	(<span class="var-type">type</span> <span class="var-name">$rToolObject</span>)
71	</div>
72	</div>
73	</div>
74	</div>
75
76	<a name="sec-vars"></a>
77	<div class="info-box">
78	<div class="info-box-title">Variables</div>
79	<div class="nav-bar">
80	<a href="#sec-description">Description</a> \|
81	<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
82
83
84	\|
85	<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
86
87	</div>
88	<div class="info-box-body">
89	<h4>Inherited Variables</h4>
90	<A NAME='inherited_vars'><!-- --></A>
91	<p>Inherited from <span class="classname"><a href="../default/Connector.html">Connector</a></span></p>
92	<blockquote>
93	<span class="var-title">
94	<span class="var-name"><a href="../default/Connector.html#var$fileName">Connector::$fileName</a></span><br>
95	</span>
96	<span class="var-title">
97	<span class="var-name"><a href="../default/Connector.html#var$model">Connector::$model</a></span><br>
98	</span>
99	<span class="var-title">
100	<span class="var-name"><a href="../default/Connector.html#var$type">Connector::$type</a></span><br>
101	</span>
102	</blockquote>
103
104	</div>
105	</div>
106
107	<a name="sec-methods"></a>
108	<div class="info-box">
109	<div class="info-box-title">Methods</div>
110	<div class="nav-bar">
111	<a href="#sec-description">Description</a> \|
112	<a href="#sec-vars">Vars</a>
113	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
114
115	</div>
116	<div class="info-box-body">
117	<A NAME='method_detail'></A>
118
119	<a name="method__construct" id="__construct"><!-- --></a>
120	<div class="evenrow">
121
122	<div class="method-header">
123	<span class="method-title">Constructor __construct</span> (line <span class="line-number">17</span>)
124	</div>
125
126	<!-- ========== Info from phpDoc block ========= -->
127	<p class="short-description">Constructor for UserConnector.</p>
128	<ul class="tags">
129	<li><span class="field">access:</span> public</li>
130	</ul>
131
132	<div class="method-signature">
133	<span class="method-result">UserConnector</span>
134	<span class="method-name">
135	__construct
136	</span>
137	()
138	</div>
139
140
141
142	</div>
143	<a name="methodget" id="get"><!-- --></a>
144	<div class="oddrow">
145
146	<div class="method-header">
147	<span class="method-title">get</span> (line <span class="line-number">31</span>)
148	</div>
149
150	<!-- ========== Info from phpDoc block ========= -->
151	<p class="short-description">function get($arguments) Gets the array of User objects belonging to arguments supplied.</p>
152	<ul class="tags">
153	<li><span class="field">access:</span> public</li>
154	</ul>
155
156	<div class="method-signature">
157	<span class="method-result">void</span>
158	<span class="method-name">
159	get
160	</span>
161	(<span class="var-type">type</span> <span class="var-name">$arguments</span>)
162	</div>
163
164	<ul class="parameters">
165	<li>
166	<span class="var-type">type</span>
167	<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>
168	</ul>
169
170
171	</div>
172	<a name="methodset" id="set"><!-- --></a>
173	<div class="evenrow">
174
175	<div class="method-header">
176	<span class="method-title">set</span> (line <span class="line-number">64</span>)
177	</div>
178
179	<!-- ========== Info from phpDoc block ========= -->
180	<p class="short-description">Save the given User object in the file.</p>
181	<ul class="tags">
182	<li><span class="field">access:</span> public</li>
183	</ul>
184
185	<div class="method-signature">
186	<span class="method-result">void</span>
187	<span class="method-name">
188	set
189	</span>
190	(<span class="var-type">type</span> <span class="var-name">$rToolObject</span>)
191	</div>
192
193	<ul class="parameters">
194	<li>
195	<span class="var-type">type</span>
196	<span class="var-name">$rToolObject</span> </li>
197	</ul>
198
199
200	</div>
201	<h4>Inherited Methods</h4>
202	<a name='inherited_methods'><!-- --></a>
203	<!-- =========== Summary =========== -->
204	<p>Inherited From <span class="classname"><a href="../default/Connector.html">Connector</a></span></p>
205	<blockquote>
206	<span class="method-name"><a href="../default/Connector.html#methodcreateArguments">Connector::createArguments()</a></span><br>
207	<span class="method-name"><a href="../default/Connector.html#methodload">Connector::load()</a></span><br>
208	<span class="method-name"><a href="../default/Connector.html#methodsave">Connector::save()</a></span><br>
209	</blockquote>
210
211	</div>
212	</div>
213
214
215	<p class="notes" id="credit">
216	Documentation generated on Fri, 09 Dec 2011 09:33:27 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
217	</p>
218	</div></body>
219	</html>

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

Download in other formats: