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

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

Added new PHPDoc :D
File size: 20.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 SurveyInstance</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"> SurveyInstance</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">Description of SurveyInstance</p>
29        <ul class="tags">
30                                <li><span class="field">author:</span> jkraaijeveld</li>
31                        </ul>
32                <p class="notes">
33                        Located in <a class="field" href="_models---SurveyInstance.php.html">/models/SurveyInstance.php</a> (line <span class="field">9</span>)
34                </p>
35               
36                               
37                <pre><a href="../default/ResearchToolObject.html">ResearchToolObject</a>
38   |
39   --SurveyInstance</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                                        <img src="../media/images/StaticVariable.png" alt=" " />
60                                        static <span class="var-type">mixed</span>
61                                        <a href="#$filename" title="details" class="var-name">$filename</a>
62                                </div>
63                                                                                                                                                                                                                                                                                                                                                                                                                                <div class="var-title">
64                                        <img src="../media/images/Variable.png" alt=" " />
65                                        <span class="var-type">mixed</span>
66                                        <a href="#$answersets" title="details" class="var-name">$answersets</a>
67                                </div>
68                                                                                                                                <div class="var-title">
69                                        <img src="../media/images/Variable.png" alt=" " />
70                                        <span class="var-type">mixed</span>
71                                        <a href="#$endtime" title="details" class="var-name">$endtime</a>
72                                </div>
73                                                                                                                                                                                                <div class="var-title">
74                                        <img src="../media/images/Variable.png" alt=" " />
75                                        <span class="var-type">mixed</span>
76                                        <a href="#$open" title="details" class="var-name">$open</a>
77                                </div>
78                                                                                                                                <div class="var-title">
79                                        <img src="../media/images/Variable.png" alt=" " />
80                                        <span class="var-type">mixed</span>
81                                        <a href="#$presetanswers" title="details" class="var-name">$presetanswers</a>
82                                </div>
83                                                                                                                                <div class="var-title">
84                                        <img src="../media/images/Variable.png" alt=" " />
85                                        <span class="var-type">mixed</span>
86                                        <a href="#$starttime" title="details" class="var-name">$starttime</a>
87                                </div>
88                                                                                                                                <div class="var-title">
89                                        <img src="../media/images/Variable.png" alt=" " />
90                                        <span class="var-type">mixed</span>
91                                        <a href="#$survey" title="details" class="var-name">$survey</a>
92                                </div>
93                                                                                        </div>
94                </div>
95        </div>
96
97        <a name="sec-method-summary"></a>
98        <div class="info-box">
99                <div class="info-box-title">Method Summary</span></div>
100                <div class="nav-bar">
101                        <a href="#sec-description">Description</a> |
102                                                                                                                                                <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
103                                 
104                                |
105                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
106                </div>
107                <div class="info-box-body">                     
108                        <div class="method-summary">
109                                                                                                                                                                <div class="method-definition">
110                                        <img src="../media/images/StaticMethod.png" alt=" "/>
111                                                                                        static <span class="method-result">void</span>
112                                                                                <a href="#create" title="details" class="method-name">create</a>
113                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$obj</span>)
114                                                                        </div>
115                                                                                                                                                                                                <div class="method-definition">
116                                        <img src="../media/images/StaticMethod.png" alt=" "/>
117                                                                                        static <span class="method-result">void</span>
118                                                                                <a href="#get" title="details" class="method-name">get</a>
119                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$arguments</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$arguments:</span>)
120                                                                        </div>
121                                                                                                                                                                                                                                <div class="method-definition">
122                                        <img src="../media/images/Constructor.png" alt=" "/>
123                                                                                        <span class="method-result">SurveyInstance</span>
124                                                                                <a href="#__construct" title="details" class="method-name">__construct</a>
125                                                                                        ([<span class="var-type"></span>&nbsp;<span class="var-name">$uid</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$survey</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$starttime</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$endtime</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$open</span> = <span class="var-default">0</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$presetanswers</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$answersets</span> = <span class="var-default">null</span>], <span class="var-type">type</span>&nbsp;<span class="var-name">$uid:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$starttime:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$endtime:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$open:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$presetanswers:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$answersets:</span>)
126                                                                        </div>
127                                                                                                                                                                                                <div class="method-definition">
128                                        <img src="../media/images/Method.png" alt=" "/>
129                                                                                        <span class="method-result">void</span>
130                                                                                <a href="#evaluate" title="details" class="method-name">evaluate</a>
131                                                                                ()
132                                                                        </div>
133                                                                                                                                                                                                <div class="method-definition">
134                                        <img src="../media/images/Method.png" alt=" "/>
135                                                                                        <span class="method-result">void</span>
136                                                                                <a href="#save" title="details" class="method-name">save</a>
137                                                                                ()
138                                                                        </div>
139                                                                                        </div>
140                </div>
141        </div>         
142
143        <a name="sec-vars"></a>
144        <div class="info-box">
145                <div class="info-box-title">Variables</div>
146                <div class="nav-bar">
147                        <a href="#sec-description">Description</a> |
148                                                                                <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
149                                               
150                       
151                                                                                |
152                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
153                                                       
154                                        </div>
155                <div class="info-box-body">
156                        <a name="var$filename" id="$filename"><!-- --></A>
157<div class="evenrow">
158
159        <div class="var-header">
160                <img src="../media/images/Variable.png" />
161                <span class="var-title">
162                        static <span class="var-type">mixed</span>
163                        <span class="var-name">$filename</span>
164                         = <span class="var-default"> 'data/surveys/surveyinstances.rdf'</span>                 (line <span class="line-number">10</span>)
165                </span>
166        </div>
167
168        <!-- ========== Info from phpDoc block ========= -->
169        <ul class="tags">
170                                <li><span class="field">access:</span> public</li>
171                        </ul>
172       
173       
174               
175               
176
177</div>
178
179<a name="var$answersets" id="$answersets"><!-- --></A>
180<div class="oddrow">
181
182        <div class="var-header">
183                <img src="../media/images/Variable.png" />
184                <span class="var-title">
185                        <span class="var-type">mixed</span>
186                        <span class="var-name">$answersets</span>
187                                                (line <span class="line-number">17</span>)
188                </span>
189        </div>
190
191        <!-- ========== Info from phpDoc block ========= -->
192        <ul class="tags">
193                                <li><span class="field">access:</span> public</li>
194                        </ul>
195       
196       
197               
198               
199
200</div>
201<a name="var$endtime" id="$endtime"><!-- --></A>
202<div class="evenrow">
203
204        <div class="var-header">
205                <img src="../media/images/Variable.png" />
206                <span class="var-title">
207                        <span class="var-type">mixed</span>
208                        <span class="var-name">$endtime</span>
209                                                (line <span class="line-number">14</span>)
210                </span>
211        </div>
212
213        <!-- ========== Info from phpDoc block ========= -->
214        <ul class="tags">
215                                <li><span class="field">access:</span> public</li>
216                        </ul>
217       
218       
219               
220               
221
222</div>
223<a name="var$open" id="$open"><!-- --></A>
224<div class="oddrow">
225
226        <div class="var-header">
227                <img src="../media/images/Variable.png" />
228                <span class="var-title">
229                        <span class="var-type">mixed</span>
230                        <span class="var-name">$open</span>
231                                                (line <span class="line-number">15</span>)
232                </span>
233        </div>
234
235        <!-- ========== Info from phpDoc block ========= -->
236        <ul class="tags">
237                                <li><span class="field">access:</span> public</li>
238                        </ul>
239       
240       
241               
242               
243
244</div>
245<a name="var$presetanswers" id="$presetanswers"><!-- --></A>
246<div class="evenrow">
247
248        <div class="var-header">
249                <img src="../media/images/Variable.png" />
250                <span class="var-title">
251                        <span class="var-type">mixed</span>
252                        <span class="var-name">$presetanswers</span>
253                                                (line <span class="line-number">16</span>)
254                </span>
255        </div>
256
257        <!-- ========== Info from phpDoc block ========= -->
258        <ul class="tags">
259                                <li><span class="field">access:</span> public</li>
260                        </ul>
261       
262       
263               
264               
265
266</div>
267<a name="var$starttime" id="$starttime"><!-- --></A>
268<div class="oddrow">
269
270        <div class="var-header">
271                <img src="../media/images/Variable.png" />
272                <span class="var-title">
273                        <span class="var-type">mixed</span>
274                        <span class="var-name">$starttime</span>
275                                                (line <span class="line-number">13</span>)
276                </span>
277        </div>
278
279        <!-- ========== Info from phpDoc block ========= -->
280        <ul class="tags">
281                                <li><span class="field">access:</span> public</li>
282                        </ul>
283       
284       
285               
286               
287
288</div>
289<a name="var$survey" id="$survey"><!-- --></A>
290<div class="evenrow">
291
292        <div class="var-header">
293                <img src="../media/images/Variable.png" />
294                <span class="var-title">
295                        <span class="var-type">mixed</span>
296                        <span class="var-name">$survey</span>
297                                                (line <span class="line-number">12</span>)
298                </span>
299        </div>
300
301        <!-- ========== Info from phpDoc block ========= -->
302        <ul class="tags">
303                                <li><span class="field">access:</span> public</li>
304                        </ul>
305       
306       
307               
308               
309
310</div>
311                                                        <h4>Inherited Variables</h4>
312                                <A NAME='inherited_vars'><!-- --></A>
313                                                                        <p>Inherited from <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
314                                        <blockquote>
315                                                                                                        <img src="../media/images/Variable.png" />
316                                                        <span class="var-title">
317                                                                <span class="var-name"><a href="../default/ResearchToolObject.html#var$uid">ResearchToolObject::$uid</a></span><br>
318                                                        </span>
319                                                                                        </blockquote>
320                                                                               
321                </div>
322        </div>
323       
324        <a name="sec-methods"></a>
325        <div class="info-box">
326                <div class="info-box-title">Methods</div>
327                <div class="nav-bar">
328                        <a href="#sec-description">Description</a> |
329                                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
330                                                                                                                <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
331                                               
332                </div>
333                <div class="info-box-body">
334                        <A NAME='method_detail'></A>
335<a name="methodcreate" id="create"><!-- --></a>
336<div class="oddrow">
337       
338        <div class="method-header">
339                <img src="../media/images/StaticMethod.png" />
340                <span class="method-title">static create</span> (line <span class="line-number">233</span>)
341        </div>
342       
343        <!-- ========== Info from phpDoc block ========= -->
344<p class="short-description">Creates a new SurveyInstance object out of the given object.</p>
345        <ul class="tags">
346                                <li><span class="field">access:</span> public</li>
347                        </ul>
348       
349        <div class="method-signature">
350                <span class="method-result">void</span>
351                <span class="method-name">
352                        create
353                </span>
354                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$obj</span>)
355                        </div>
356       
357                        <ul class="parameters">
358                                        <li>
359                                <span class="var-type"></span>
360                                <span class="var-name">$obj</span>                      </li>
361                                </ul>
362               
363                       
364        </div>
365<a name="methodget" id="get"><!-- --></a>
366<div class="evenrow">
367       
368        <div class="method-header">
369                <img src="../media/images/StaticMethod.png" />
370                <span class="method-title">static get</span> (line <span class="line-number">169</span>)
371        </div>
372       
373        <!-- ========== Info from phpDoc block ========= -->
374<p class="short-description">function get($arguments)  Gets the array of SurveyInstance objects belonging tothe arguments supplied.</p>
375        <ul class="tags">
376                                <li><span class="field">access:</span> public</li>
377                        </ul>
378       
379        <div class="method-signature">
380                <span class="method-result">void</span>
381                <span class="method-name">
382                        get
383                </span>
384                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$arguments</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$arguments:</span>)
385                        </div>
386       
387                        <ul class="parameters">
388                                        <li>
389                                <span class="var-type">type</span>
390                                <span class="var-name">$arguments:</span><span class="var-description">: An array containing zero or more of the following keys:                            'uid', 'of_survey', 'starttime', 'endtime', 'open', 'preset_answers', 'answersets'</span>                   </li>
391                                        <li>
392                                <span class="var-type"></span>
393                                <span class="var-name">$arguments</span>                        </li>
394                                </ul>
395               
396                       
397        </div>
398<a name="method__construct" id="__construct"><!-- --></a>
399<div class="oddrow">
400       
401        <div class="method-header">
402                <img src="../media/images/Constructor.png" />
403                <span class="method-title">Constructor __construct</span> (line <span class="line-number">28</span>)
404        </div>
405       
406        <!-- ========== Info from phpDoc block ========= -->
407<p class="short-description">Constructor for a SurveyInstance object</p>
408        <ul class="tags">
409                                <li><span class="field">access:</span> public</li>
410                        </ul>
411       
412        <div class="method-signature">
413                <span class="method-result">SurveyInstance</span>
414                <span class="method-name">
415                        __construct
416                </span>
417                                        ([<span class="var-type"></span>&nbsp;<span class="var-name">$uid</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$survey</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$starttime</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$endtime</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$open</span> = <span class="var-default">0</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$presetanswers</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$answersets</span> = <span class="var-default">null</span>], <span class="var-type">type</span>&nbsp;<span class="var-name">$uid:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$starttime:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$endtime:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$open:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$presetanswers:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$answersets:</span>)
418                        </div>
419       
420                        <ul class="parameters">
421                                        <li>
422                                <span class="var-type">type</span>
423                                <span class="var-name">$uid:</span><span class="var-description">: The UID of the survey instance object.</span>                        </li>
424                                        <li>
425                                <span class="var-type">type</span>
426                                <span class="var-name">$starttime:</span><span class="var-description">: The starttime of the survey round.</span>                      </li>
427                                        <li>
428                                <span class="var-type">type</span>
429                                <span class="var-name">$endtime:</span><span class="var-description">: The endtime of the survey round.</span>                  </li>
430                                        <li>
431                                <span class="var-type">type</span>
432                                <span class="var-name">$open:</span><span class="var-description">: A boolean to specify whether the survey is open.</span>                     </li>
433                                        <li>
434                                <span class="var-type">type</span>
435                                <span class="var-name">$presetanswers:</span><span class="var-description">: A list of answers which are preset for everyone doing the survey.</span>                   </li>
436                                        <li>
437                                <span class="var-type">type</span>
438                                <span class="var-name">$answersets:</span><span class="var-description">: A list of answersets.</span>                  </li>
439                                        <li>
440                                <span class="var-type"></span>
441                                <span class="var-name">$uid</span>                      </li>
442                                        <li>
443                                <span class="var-type"></span>
444                                <span class="var-name">$survey</span>                   </li>
445                                        <li>
446                                <span class="var-type"></span>
447                                <span class="var-name">$starttime</span>                        </li>
448                                        <li>
449                                <span class="var-type"></span>
450                                <span class="var-name">$endtime</span>                  </li>
451                                        <li>
452                                <span class="var-type"></span>
453                                <span class="var-name">$open</span>                     </li>
454                                        <li>
455                                <span class="var-type"></span>
456                                <span class="var-name">$presetanswers</span>                    </li>
457                                        <li>
458                                <span class="var-type"></span>
459                                <span class="var-name">$answersets</span>                       </li>
460                                </ul>
461               
462                       
463        </div>
464<a name="methodevaluate" id="evaluate"><!-- --></a>
465<div class="evenrow">
466       
467        <div class="method-header">
468                <img src="../media/images/Method.png" />
469                <span class="method-title">evaluate</span> (line <span class="line-number">49</span>)
470        </div>
471       
472        <!-- ========== Info from phpDoc block ========= -->
473<p class="short-description">function evaluate()</p>
474<p class="description"><p>Evaluates the references in this object</p></p>
475        <ul class="tags">
476                                <li><span class="field">access:</span> public</li>
477                        </ul>
478       
479        <div class="method-signature">
480                <span class="method-result">void</span>
481                <span class="method-name">
482                        evaluate
483                </span>
484                                ()
485                        </div>
486       
487               
488                        <hr class="separator" />
489                <div class="notes">Redefinition of:</div>
490                <dl>
491                        <dt><a href="../default/ResearchToolObject.html#methodevaluate">ResearchToolObject::evaluate()</a></dt>
492                                        </dl>
493                       
494        </div>
495<a name="methodsave" id="save"><!-- --></a>
496<div class="oddrow">
497       
498        <div class="method-header">
499                <img src="../media/images/Method.png" />
500                <span class="method-title">save</span> (line <span class="line-number">100</span>)
501        </div>
502       
503        <!-- ========== Info from phpDoc block ========= -->
504<p class="short-description">function save()  Saves the current object into the database.</p>
505        <ul class="tags">
506                                <li><span class="field">access:</span> public</li>
507                        </ul>
508       
509        <div class="method-signature">
510                <span class="method-result">void</span>
511                <span class="method-name">
512                        save
513                </span>
514                                ()
515                        </div>
516       
517               
518                       
519        </div>
520                                                        <h4>Inherited Methods</h4>
521                                <a name='inherited_methods'><!-- --></a>       
522                                                                        <!-- =========== Summary =========== -->
523                                        <p>Inherited From <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
524                                        <blockquote>
525                                                                                                        <img src="../media/images/Method.png" alt=" "/>
526                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodcreateArguments">ResearchToolObject::createArguments()</a></span><br>
527                                                                                                        <img src="../media/images/Method.png" alt=" "/>
528                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodevaluate">ResearchToolObject::evaluate()</a></span><br>
529                                                                                                        <img src="../media/images/Method.png" alt=" "/>
530                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodgetUid">ResearchToolObject::getUid()</a></span><br>
531                                                                                                        <img src="../media/images/Method.png" alt=" "/>
532                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodload">ResearchToolObject::load()</a></span><br>
533                                                                                                        <img src="../media/images/Method.png" alt=" "/>
534                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodstripUri">ResearchToolObject::stripUri()</a></span><br>
535                                                                                        </blockquote>
536                                                                               
537                </div>
538        </div>
539
540       
541        <p class="notes" id="credit">
542                Documentation generated on Thu, 01 Mar 2012 15:13:52 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
543        </p>
544        </div></body>
545</html>
Note: See TracBrowser for help on using the repository browser.