source: Doc/Backend/PHPDoc/default/AnswerSet.html @ 301

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

Added new PHPDoc :D

File size: 15.7 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 AnswerSet</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"><img src="../media/images/Class_logo.png"
13                                                                                                                alt=" Class"
14                                                                                                                title=" Class"
15                                                                                                                style="vertical-align: middle"> AnswerSet</h2>
16
17<a name="sec-description"></a>
18<div class="info-box">
19        <div class="info-box-title">Description</div>
20        <div class="nav-bar">
21                                        <span class="disabled">Description</span> |
22                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
23                                                |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
24                                               
25                                        </div>
26        <div class="info-box-body">
27                        <!-- ========== Info from phpDoc block ========= -->
28<p class="short-description">AnswerSet is a collection of answers corresponding to a Session</p>
29                <p class="notes">
30                        Located in <a class="field" href="_models---AnswerSet.php.html">/models/AnswerSet.php</a> (line <span class="field">11</span>)
31                </p>
32               
33                               
34                <pre><a href="../default/ResearchToolObject.html">ResearchToolObject</a>
35   |
36   --AnswerSet</pre>
37       
38                        </div>
39</div>
40
41
42
43        <a name="sec-var-summary"></a>
44        <div class="info-box">
45                <div class="info-box-title">Variable Summary</span></div>
46                <div class="nav-bar">
47                        <a href="#sec-description">Description</a> |
48                                                <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
49                                                        |
50                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
51                                                       
52                                                                </div>
53                <div class="info-box-body">
54                        <div class="var-summary">
55                                                                                                                                                                                                                                <div class="var-title">
56                                        <img src="../media/images/StaticVariable.png" alt=" " />
57                                        static <span class="var-type">mixed</span>
58                                        <a href="#$filename" title="details" class="var-name">$filename</a>
59                                </div>
60                                                                                                                                                                                                                                                                                                <div class="var-title">
61                                        <img src="../media/images/Variable.png" alt=" " />
62                                        <span class="var-type">mixed</span>
63                                        <a href="#$answers" title="details" class="var-name">$answers</a>
64                                </div>
65                                                                                                                                <div class="var-title">
66                                        <img src="../media/images/Variable.png" alt=" " />
67                                        <span class="var-type">mixed</span>
68                                        <a href="#$datetime" title="details" class="var-name">$datetime</a>
69                                </div>
70                                                                                                                                                                                                <div class="var-title">
71                                        <img src="../media/images/Variable.png" alt=" " />
72                                        <span class="var-type">mixed</span>
73                                        <a href="#$respondent" title="details" class="var-name">$respondent</a>
74                                </div>
75                                                                                                                                <div class="var-title">
76                                        <img src="../media/images/Variable.png" alt=" " />
77                                        <span class="var-type">mixed</span>
78                                        <a href="#$survey" title="details" class="var-name">$survey</a>
79                                </div>
80                                                                                        </div>
81                </div>
82        </div>
83
84        <a name="sec-method-summary"></a>
85        <div class="info-box">
86                <div class="info-box-title">Method Summary</span></div>
87                <div class="nav-bar">
88                        <a href="#sec-description">Description</a> |
89                                                                                                                                                <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
90                                 
91                                |
92                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
93                </div>
94                <div class="info-box-body">                     
95                        <div class="method-summary">
96                                                                                                                                                                <div class="method-definition">
97                                        <img src="../media/images/StaticMethod.png" alt=" "/>
98                                                                                        static <span class="method-result">void</span>
99                                                                                <a href="#create" title="details" class="method-name">create</a>
100                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$obj</span>)
101                                                                        </div>
102                                                                                                                                                                                                <div class="method-definition">
103                                        <img src="../media/images/StaticMethod.png" alt=" "/>
104                                                                                        static <span class="method-result">void</span>
105                                                                                <a href="#get" title="details" class="method-name">get</a>
106                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span>)
107                                                                        </div>
108                                                                                                                                                                                                                                <div class="method-definition">
109                                        <img src="../media/images/Constructor.png" alt=" "/>
110                                                                                        <span class="method-result">AnswerSet</span>
111                                                                                <a href="#__construct" title="details" class="method-name">__construct</a>
112                                                                                        ([<span class="var-type">type</span>&nbsp;<span class="var-name">$uid</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$survey</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$respondent</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$datetime</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$answers</span> = <span class="var-default">null</span>])
113                                                                        </div>
114                                                                                                                                                                                                <div class="method-definition">
115                                        <img src="../media/images/Method.png" alt=" "/>
116                                                                                        <span class="method-result">void</span>
117                                                                                <a href="#evaluate" title="details" class="method-name">evaluate</a>
118                                                                                ()
119                                                                        </div>
120                                                                                                                                                                                                <div class="method-definition">
121                                        <img src="../media/images/Method.png" alt=" "/>
122                                                                                        <span class="method-result">void</span>
123                                                                                <a href="#save" title="details" class="method-name">save</a>
124                                                                                ()
125                                                                        </div>
126                                                                                        </div>
127                </div>
128        </div>         
129
130        <a name="sec-vars"></a>
131        <div class="info-box">
132                <div class="info-box-title">Variables</div>
133                <div class="nav-bar">
134                        <a href="#sec-description">Description</a> |
135                                                                                <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
136                                               
137                       
138                                                                                |
139                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
140                                                       
141                                        </div>
142                <div class="info-box-body">
143                        <a name="var$filename" id="$filename"><!-- --></A>
144<div class="evenrow">
145
146        <div class="var-header">
147                <img src="../media/images/Variable.png" />
148                <span class="var-title">
149                        static <span class="var-type">mixed</span>
150                        <span class="var-name">$filename</span>
151                         = <span class="var-default"> 'data/results/answersets.rdf'</span>                      (line <span class="line-number">12</span>)
152                </span>
153        </div>
154
155        <!-- ========== Info from phpDoc block ========= -->
156        <ul class="tags">
157                                <li><span class="field">access:</span> public</li>
158                        </ul>
159       
160       
161               
162               
163
164</div>
165
166<a name="var$answers" id="$answers"><!-- --></A>
167<div class="oddrow">
168
169        <div class="var-header">
170                <img src="../media/images/Variable.png" />
171                <span class="var-title">
172                        <span class="var-type">mixed</span>
173                        <span class="var-name">$answers</span>
174                                                (line <span class="line-number">17</span>)
175                </span>
176        </div>
177
178        <!-- ========== Info from phpDoc block ========= -->
179        <ul class="tags">
180                                <li><span class="field">access:</span> public</li>
181                        </ul>
182       
183       
184               
185               
186
187</div>
188<a name="var$datetime" id="$datetime"><!-- --></A>
189<div class="evenrow">
190
191        <div class="var-header">
192                <img src="../media/images/Variable.png" />
193                <span class="var-title">
194                        <span class="var-type">mixed</span>
195                        <span class="var-name">$datetime</span>
196                                                (line <span class="line-number">16</span>)
197                </span>
198        </div>
199
200        <!-- ========== Info from phpDoc block ========= -->
201        <ul class="tags">
202                                <li><span class="field">access:</span> public</li>
203                        </ul>
204       
205       
206               
207               
208
209</div>
210<a name="var$respondent" id="$respondent"><!-- --></A>
211<div class="oddrow">
212
213        <div class="var-header">
214                <img src="../media/images/Variable.png" />
215                <span class="var-title">
216                        <span class="var-type">mixed</span>
217                        <span class="var-name">$respondent</span>
218                                                (line <span class="line-number">15</span>)
219                </span>
220        </div>
221
222        <!-- ========== Info from phpDoc block ========= -->
223        <ul class="tags">
224                                <li><span class="field">access:</span> public</li>
225                        </ul>
226       
227       
228               
229               
230
231</div>
232<a name="var$survey" id="$survey"><!-- --></A>
233<div class="evenrow">
234
235        <div class="var-header">
236                <img src="../media/images/Variable.png" />
237                <span class="var-title">
238                        <span class="var-type">mixed</span>
239                        <span class="var-name">$survey</span>
240                                                (line <span class="line-number">14</span>)
241                </span>
242        </div>
243
244        <!-- ========== Info from phpDoc block ========= -->
245        <ul class="tags">
246                                <li><span class="field">access:</span> public</li>
247                        </ul>
248       
249       
250               
251               
252
253</div>
254                                                        <h4>Inherited Variables</h4>
255                                <A NAME='inherited_vars'><!-- --></A>
256                                                                        <p>Inherited from <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
257                                        <blockquote>
258                                                                                                        <img src="../media/images/Variable.png" />
259                                                        <span class="var-title">
260                                                                <span class="var-name"><a href="../default/ResearchToolObject.html#var$uid">ResearchToolObject::$uid</a></span><br>
261                                                        </span>
262                                                                                        </blockquote>
263                                                                               
264                </div>
265        </div>
266       
267        <a name="sec-methods"></a>
268        <div class="info-box">
269                <div class="info-box-title">Methods</div>
270                <div class="nav-bar">
271                        <a href="#sec-description">Description</a> |
272                                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
273                                                                                                                <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
274                                               
275                </div>
276                <div class="info-box-body">
277                        <A NAME='method_detail'></A>
278<a name="methodcreate" id="create"><!-- --></a>
279<div class="oddrow">
280       
281        <div class="method-header">
282                <img src="../media/images/StaticMethod.png" />
283                <span class="method-title">static create</span> (line <span class="line-number">192</span>)
284        </div>
285       
286        <!-- ========== Info from phpDoc block ========= -->
287        <ul class="tags">
288                                <li><span class="field">access:</span> public</li>
289                        </ul>
290       
291        <div class="method-signature">
292                <span class="method-result">void</span>
293                <span class="method-name">
294                        create
295                </span>
296                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$obj</span>)
297                        </div>
298       
299                        <ul class="parameters">
300                                        <li>
301                                <span class="var-type"></span>
302                                <span class="var-name">$obj</span>                      </li>
303                                </ul>
304               
305                       
306        </div>
307<a name="methodget" id="get"><!-- --></a>
308<div class="evenrow">
309       
310        <div class="method-header">
311                <img src="../media/images/StaticMethod.png" />
312                <span class="method-title">static get</span> (line <span class="line-number">139</span>)
313        </div>
314       
315        <!-- ========== Info from phpDoc block ========= -->
316<p class="short-description">function get()</p>
317        <ul class="tags">
318                                <li><span class="field">access:</span> public</li>
319                        </ul>
320       
321        <div class="method-signature">
322                <span class="method-result">void</span>
323                <span class="method-name">
324                        get
325                </span>
326                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span>)
327                        </div>
328       
329                        <ul class="parameters">
330                                        <li>
331                                <span class="var-type">type</span>
332                                <span class="var-name">$arguments</span><span class="var-description">: : An array having one ore more of the following elements:  'uid', 'survey', 'respondent', 'datetime', 'answers'.</span>                 </li>
333                                </ul>
334               
335                       
336        </div>
337<a name="method__construct" id="__construct"><!-- --></a>
338<div class="oddrow">
339       
340        <div class="method-header">
341                <img src="../media/images/Constructor.png" />
342                <span class="method-title">Constructor __construct</span> (line <span class="line-number">27</span>)
343        </div>
344       
345        <!-- ========== Info from phpDoc block ========= -->
346<p class="short-description">Constructor for an AnswerSet object</p>
347        <ul class="tags">
348                                <li><span class="field">access:</span> public</li>
349                        </ul>
350       
351        <div class="method-signature">
352                <span class="method-result">AnswerSet</span>
353                <span class="method-name">
354                        __construct
355                </span>
356                                        ([<span class="var-type">type</span>&nbsp;<span class="var-name">$uid</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$survey</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$respondent</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$datetime</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$answers</span> = <span class="var-default">null</span>])
357                        </div>
358       
359                        <ul class="parameters">
360                                        <li>
361                                <span class="var-type">type</span>
362                                <span class="var-name">$uid</span>                      </li>
363                                        <li>
364                                <span class="var-type">type</span>
365                                <span class="var-name">$survey</span>                   </li>
366                                        <li>
367                                <span class="var-type">type</span>
368                                <span class="var-name">$respondent</span>                       </li>
369                                        <li>
370                                <span class="var-type">type</span>
371                                <span class="var-name">$datetime</span>                 </li>
372                                        <li>
373                                <span class="var-type">type</span>
374                                <span class="var-name">$answers</span>                  </li>
375                                </ul>
376               
377                       
378        </div>
379<a name="methodevaluate" id="evaluate"><!-- --></a>
380<div class="evenrow">
381       
382        <div class="method-header">
383                <img src="../media/images/Method.png" />
384                <span class="method-title">evaluate</span> (line <span class="line-number">44</span>)
385        </div>
386       
387        <!-- ========== Info from phpDoc block ========= -->
388<p class="short-description">function evaluate()  evaluates the references of survey, respondent and answers.</p>
389        <ul class="tags">
390                                <li><span class="field">access:</span> public</li>
391                        </ul>
392       
393        <div class="method-signature">
394                <span class="method-result">void</span>
395                <span class="method-name">
396                        evaluate
397                </span>
398                                ()
399                        </div>
400       
401               
402                        <hr class="separator" />
403                <div class="notes">Redefinition of:</div>
404                <dl>
405                        <dt><a href="../default/ResearchToolObject.html#methodevaluate">ResearchToolObject::evaluate()</a></dt>
406                                        </dl>
407                       
408        </div>
409<a name="methodsave" id="save"><!-- --></a>
410<div class="oddrow">
411       
412        <div class="method-header">
413                <img src="../media/images/Method.png" />
414                <span class="method-title">save</span> (line <span class="line-number">83</span>)
415        </div>
416       
417        <!-- ========== Info from phpDoc block ========= -->
418<p class="short-description">function save()  Saves the current object into the database.</p>
419        <ul class="tags">
420                                <li><span class="field">access:</span> public</li>
421                        </ul>
422       
423        <div class="method-signature">
424                <span class="method-result">void</span>
425                <span class="method-name">
426                        save
427                </span>
428                                ()
429                        </div>
430       
431               
432                       
433        </div>
434                                                        <h4>Inherited Methods</h4>
435                                <a name='inherited_methods'><!-- --></a>       
436                                                                        <!-- =========== Summary =========== -->
437                                        <p>Inherited From <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
438                                        <blockquote>
439                                                                                                        <img src="../media/images/Method.png" alt=" "/>
440                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodcreateArguments">ResearchToolObject::createArguments()</a></span><br>
441                                                                                                        <img src="../media/images/Method.png" alt=" "/>
442                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodevaluate">ResearchToolObject::evaluate()</a></span><br>
443                                                                                                        <img src="../media/images/Method.png" alt=" "/>
444                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodgetUid">ResearchToolObject::getUid()</a></span><br>
445                                                                                                        <img src="../media/images/Method.png" alt=" "/>
446                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodload">ResearchToolObject::load()</a></span><br>
447                                                                                                        <img src="../media/images/Method.png" alt=" "/>
448                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodstripUri">ResearchToolObject::stripUri()</a></span><br>
449                                                                                        </blockquote>
450                                                                               
451                </div>
452        </div>
453
454       
455        <p class="notes" id="credit">
456                Documentation generated on Thu, 01 Mar 2012 15:13:51 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
457        </p>
458        </div></body>
459</html>
Note: See TracBrowser for help on using the repository browser.