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

Last change on this file since 179 was 179, checked in by jkraaijeveld, 13 years ago

Updated documentation and PHPDoc

File size: 10.9 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 Connector</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 Connector</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-descendents">Descendents</a>
20                        |                                                                                       <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
21                                                |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
22                                               
23                                        </div>
24        <div class="info-box-body">
25                <p class="implements">
26            Implements interfaces:
27            <ul>
28                <li><a href="../default/IConnector.html">IConnector</a></li>            </ul>
29        </p>
30                        <!-- ========== Info from phpDoc block ========= -->
31<p class="short-description">Connector</p>
32        <ul class="tags">
33                                <li><span class="field">author:</span> jkraaijeveld</li>
34                                <li><span class="field">abstract:</span> </li>
35                        </ul>
36                <p class="notes">
37                        Located in <a class="field" href="_Connector.php.html">/Connector.php</a> (line <span class="field">13</span>)
38                </p>
39               
40                               
41                <pre></pre>
42       
43                        </div>
44</div>
45
46        <a name="sec-descendents"></a>
47        <div class="info-box">
48                <div class="info-box-title">Direct descendents</div>
49                <div class="nav-bar">
50                        <a href="#sec-description">Description</a> |
51                        <span class="disabled">Descendents</span>
52                        |                                                                                               <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
53                                                                |                                                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
54                                                       
55                                                                </div>
56                <div class="info-box-body">
57                        <table cellpadding="2" cellspacing="0" class="class-table">
58                                <tr>
59                                        <th class="class-table-header">Class</th>
60                                        <th class="class-table-header">Description</th>
61                                </tr>
62                                                                <tr>
63                                        <td style="padding-right: 2em"><a href="../default/AnswerConnector.html">AnswerConnector</a></td>
64                                        <td>
65                                                                                        Description of AnswerConnector
66                                                                                </td>
67                                </tr>
68                                                                <tr>
69                                        <td style="padding-right: 2em"><a href="../default/AnswerSetConnector.html">AnswerSetConnector</a></td>
70                                        <td>
71                                                                                        Description of AnswerSetConnector
72                                                                                </td>
73                                </tr>
74                                                                <tr>
75                                        <td style="padding-right: 2em"><a href="../default/ApplicationConnector.html">ApplicationConnector</a></td>
76                                        <td>
77                                                                                        Description of ApplicationConnector
78                                                                                </td>
79                                </tr>
80                                                                <tr>
81                                        <td style="padding-right: 2em"><a href="../default/QuestionConnector.html">QuestionConnector</a></td>
82                                        <td>
83                                                                                        Description of QuestionConnector
84                                                                                </td>
85                                </tr>
86                                                                <tr>
87                                        <td style="padding-right: 2em"><a href="../default/RespondentConnector.html">RespondentConnector</a></td>
88                                        <td>
89                                                                                        Description of RespondentConnector
90                                                                                </td>
91                                </tr>
92                                                                <tr>
93                                        <td style="padding-right: 2em"><a href="../default/SessionConnector.html">SessionConnector</a></td>
94                                        <td>
95                                                                                        Description of SessionConnector
96                                                                                </td>
97                                </tr>
98                                                                <tr>
99                                        <td style="padding-right: 2em"><a href="../default/SurveyConnector.html">SurveyConnector</a></td>
100                                        <td>
101                                                                                        Description of SurveyConnector
102                                                                                </td>
103                                </tr>
104                                                                <tr>
105                                        <td style="padding-right: 2em"><a href="../default/UserConnector.html">UserConnector</a></td>
106                                        <td>
107                                                                                        Description of UserConnector
108                                                                                </td>
109                                </tr>
110                                                        </table>
111                </div>
112        </div>
113
114
115        <a name="sec-var-summary"></a>
116        <div class="info-box">
117                <div class="info-box-title">Variable Summary</span></div>
118                <div class="nav-bar">
119                        <a href="#sec-description">Description</a> |
120                                                        <a href="#sec-descendents">Descendents</a> |
121                                                <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
122                                                        |
123                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
124                                                       
125                                                                </div>
126                <div class="info-box-body">
127                        <div class="var-summary">
128                                                                                                                                                                                                                                                                                                                                <div class="var-title">
129                                        <span class="var-type">mixed</span>
130                                        <a href="#$fileName" title="details" class="var-name">$fileName</a>
131                                </div>
132                                                                                                                                <div class="var-title">
133                                        <span class="var-type">mixed</span>
134                                        <a href="#$model" title="details" class="var-name">$model</a>
135                                </div>
136                                                                                                                                <div class="var-title">
137                                        <span class="var-type">mixed</span>
138                                        <a href="#$type" title="details" class="var-name">$type</a>
139                                </div>
140                                                                                        </div>
141                </div>
142        </div>
143
144        <a name="sec-method-summary"></a>
145        <div class="info-box">
146                <div class="info-box-title">Method Summary</span></div>
147                <div class="nav-bar">
148                        <a href="#sec-description">Description</a> |
149                                                        <a href="#sec-descendents">Descendents</a> |
150                                                                                                                                                <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
151                                 
152                                |
153                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
154                </div>
155                <div class="info-box-body">                     
156                        <div class="method-summary">
157                                                                                                                                                                                                                               
158                                                                                                <div class="method-definition">
159                                                                                        <span class="method-result">void</span>
160                                                                                <a href="#createArguments" title="details" class="method-name">createArguments</a>
161                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span>)
162                                                                        </div>
163                                                                                                                                <div class="method-definition">
164                                                                                        <span class="method-result">void</span>
165                                                                                <a href="#load" title="details" class="method-name">load</a>
166                                                                                ()
167                                                                        </div>
168                                                                                                                                <div class="method-definition">
169                                                                                        <span class="method-result">void</span>
170                                                                                <a href="#save" title="details" class="method-name">save</a>
171                                                                                ()
172                                                                        </div>
173                                                                </div>
174                </div>
175        </div>         
176
177        <a name="sec-vars"></a>
178        <div class="info-box">
179                <div class="info-box-title">Variables</div>
180                <div class="nav-bar">
181                        <a href="#sec-description">Description</a> |
182                                                        <a href="#sec-descendents">Descendents</a> |
183                                                                                <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
184                                               
185                       
186                                                                                |
187                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
188                                                       
189                                        </div>
190                <div class="info-box-body">
191                        <a name="var$fileName" id="$fileName"><!-- --></A>
192<div class="evenrow">
193
194        <div class="var-header">
195                <span class="var-title">
196                        <span class="var-type">mixed</span>
197                        <span class="var-name">$fileName</span>
198                                                (line <span class="line-number">17</span>)
199                </span>
200        </div>
201
202        <!-- ========== Info from phpDoc block ========= -->
203        <ul class="tags">
204                                <li><span class="field">access:</span> protected</li>
205                        </ul>
206       
207       
208               
209               
210
211</div>
212<a name="var$model" id="$model"><!-- --></A>
213<div class="oddrow">
214
215        <div class="var-header">
216                <span class="var-title">
217                        <span class="var-type">mixed</span>
218                        <span class="var-name">$model</span>
219                                                (line <span class="line-number">16</span>)
220                </span>
221        </div>
222
223        <!-- ========== Info from phpDoc block ========= -->
224        <ul class="tags">
225                                <li><span class="field">access:</span> protected</li>
226                        </ul>
227       
228       
229               
230               
231
232</div>
233<a name="var$type" id="$type"><!-- --></A>
234<div class="evenrow">
235
236        <div class="var-header">
237                <span class="var-title">
238                        <span class="var-type">mixed</span>
239                        <span class="var-name">$type</span>
240                                                (line <span class="line-number">15</span>)
241                </span>
242        </div>
243
244        <!-- ========== Info from phpDoc block ========= -->
245        <ul class="tags">
246                                <li><span class="field">access:</span> protected</li>
247                        </ul>
248       
249       
250               
251               
252
253</div>
254                                               
255                </div>
256        </div>
257       
258        <a name="sec-methods"></a>
259        <div class="info-box">
260                <div class="info-box-title">Methods</div>
261                <div class="nav-bar">
262                        <a href="#sec-description">Description</a> |
263                                                        <a href="#sec-descendents">Descendents</a> |
264                                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
265                                                                                                                                        <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
266                                               
267                </div>
268                <div class="info-box-body">
269                        <A NAME='method_detail'></A>
270
271<a name="methodcreateArguments" id="createArguments"><!-- --></a>
272<div class="oddrow">
273       
274        <div class="method-header">
275                <span class="method-title">createArguments</span> (line <span class="line-number">45</span>)
276        </div>
277       
278        <!-- ========== Info from phpDoc block ========= -->
279<p class="short-description">function createArguments()</p>
280        <ul class="tags">
281                                <li><span class="field">access:</span> public</li>
282                        </ul>
283       
284        <div class="method-signature">
285                <span class="method-result">void</span>
286                <span class="method-name">
287                        createArguments
288                </span>
289                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span>)
290                        </div>
291       
292                        <ul class="parameters">
293                                        <li>
294                                <span class="var-type">type</span>
295                                <span class="var-name">$arguments</span><span class="var-description">: Creates the arguments to be used in the query based on the  arguments specified in the incoming array.</span>                   </li>
296                                </ul>
297               
298                       
299        </div>
300<a name="methodload" id="load"><!-- --></a>
301<div class="evenrow">
302       
303        <div class="method-header">
304                <span class="method-title">load</span> (line <span class="line-number">23</span>)
305        </div>
306       
307        <!-- ========== Info from phpDoc block ========= -->
308<p class="short-description">function load()</p>
309<p class="description"><p>Loads the file into the standard MemModel</p></p>
310        <ul class="tags">
311                                <li><span class="field">access:</span> public</li>
312                        </ul>
313       
314        <div class="method-signature">
315                <span class="method-result">void</span>
316                <span class="method-name">
317                        load
318                </span>
319                                ()
320                        </div>
321       
322               
323                                <hr class="separator" />
324                <div class="notes">Implementation of:</div>
325                        <dl>
326                        <dt><a href="../default/IConnector.html#methodload">IConnector::load()</a></dt>
327                                        </dl>
328                       
329        </div>
330<a name="methodsave" id="save"><!-- --></a>
331<div class="oddrow">
332       
333        <div class="method-header">
334                <span class="method-title">save</span> (line <span class="line-number">34</span>)
335        </div>
336       
337        <!-- ========== Info from phpDoc block ========= -->
338<p class="short-description">function save()  Saves the MemModel into the given file.</p>
339        <ul class="tags">
340                                <li><span class="field">access:</span> public</li>
341                        </ul>
342       
343        <div class="method-signature">
344                <span class="method-result">void</span>
345                <span class="method-name">
346                        save
347                </span>
348                                ()
349                        </div>
350       
351               
352                                <hr class="separator" />
353                <div class="notes">Implementation of:</div>
354                        <dl>
355                        <dt><a href="../default/IConnector.html#methodsave">IConnector::save()</a></dt>
356                                        </dl>
357                       
358        </div>
359                                               
360                </div>
361        </div>
362
363
364        <p class="notes" id="credit">
365                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>
366        </p>
367        </div></body>
368</html>
Note: See TracBrowser for help on using the repository browser.