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

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

Added new PHPDoc :D

File size: 16.1 KB
Line 
1<?xml version="1.0" encoding="iso-8859-1"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3  <html xmlns="http://www.w3.org/1999/xhtml">
4                <head>
5                        <!-- template designed by Marco Von Ballmoos -->
6                        <title>Docs For Class Question</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"> Question</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 Question</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---Question.php.html">/models/Question.php</a> (line <span class="field">11</span>)
34                </p>
35               
36                               
37                <pre><a href="../default/ResearchToolObject.html">ResearchToolObject</a>
38   |
39   --Question</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/Variable.png" alt=" " />
60                                        <span class="var-type">mixed</span>
61                                        <a href="#$answers" title="details" class="var-name">$answers</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="#$category" title="details" class="var-name">$category</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="#$code" title="details" class="var-name">$code</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="#$description" title="details" class="var-name">$description</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="#$title" title="details" class="var-name">$title</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="#$type" title="details" class="var-name">$type</a>
87                                </div>
88                                                                                        </div>
89                </div>
90        </div>
91
92        <a name="sec-method-summary"></a>
93        <div class="info-box">
94                <div class="info-box-title">Method Summary</span></div>
95                <div class="nav-bar">
96                        <a href="#sec-description">Description</a> |
97                                                                                                                                                <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
98                                 
99                                |
100                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
101                </div>
102                <div class="info-box-body">                     
103                        <div class="method-summary">
104                                                                                                                                                                <div class="method-definition">
105                                        <img src="../media/images/StaticMethod.png" alt=" "/>
106                                                                                        static <span class="method-result">void</span>
107                                                                                <a href="#create" title="details" class="method-name">create</a>
108                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$obj</span>)
109                                                                        </div>
110                                                                                                                                <div class="method-definition">
111                                        <img src="../media/images/StaticMethod.png" alt=" "/>
112                                                                                        static <span class="method-result">void</span>
113                                                                                <a href="#get" title="details" class="method-name">get</a>
114                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span>)
115                                                                        </div>
116                                                                                                                                                                                                                                <div class="method-definition">
117                                        <img src="../media/images/Constructor.png" alt=" "/>
118                                                                                        <span class="method-result">Question</span>
119                                                                                <a href="#__construct" title="details" class="method-name">__construct</a>
120                                                                                        ([<span class="var-type">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">$code</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$description</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$category</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>])
121                                                                        </div>
122                                                                                                                                                                                                                                                                <div class="method-definition">
123                                        <img src="../media/images/Method.png" alt=" "/>
124                                                                                        <span class="method-result">void</span>
125                                                                                <a href="#save" title="details" class="method-name">save</a>
126                                                                                ()
127                                                                        </div>
128                                                                                        </div>
129                </div>
130        </div>         
131
132        <a name="sec-vars"></a>
133        <div class="info-box">
134                <div class="info-box-title">Variables</div>
135                <div class="nav-bar">
136                        <a href="#sec-description">Description</a> |
137                                                                                <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
138                                               
139                       
140                                                                                |
141                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
142                                                       
143                                        </div>
144                <div class="info-box-body">
145                       
146<a name="var$answers" id="$answers"><!-- --></A>
147<div class="oddrow">
148
149        <div class="var-header">
150                <img src="../media/images/Variable.png" />
151                <span class="var-title">
152                        <span class="var-type">mixed</span>
153                        <span class="var-name">$answers</span>
154                                                (line <span class="line-number">30</span>)
155                </span>
156        </div>
157
158        <!-- ========== Info from phpDoc block ========= -->
159        <ul class="tags">
160                                <li><span class="field">access:</span> public</li>
161                        </ul>
162       
163       
164               
165               
166
167</div>
168<a name="var$category" id="$category"><!-- --></A>
169<div class="evenrow">
170
171        <div class="var-header">
172                <img src="../media/images/Variable.png" />
173                <span class="var-title">
174                        <span class="var-type">mixed</span>
175                        <span class="var-name">$category</span>
176                                                (line <span class="line-number">29</span>)
177                </span>
178        </div>
179
180        <!-- ========== Info from phpDoc block ========= -->
181        <ul class="tags">
182                                <li><span class="field">access:</span> public</li>
183                        </ul>
184       
185       
186               
187               
188
189</div>
190<a name="var$code" id="$code"><!-- --></A>
191<div class="oddrow">
192
193        <div class="var-header">
194                <img src="../media/images/Variable.png" />
195                <span class="var-title">
196                        <span class="var-type">mixed</span>
197                        <span class="var-name">$code</span>
198                                                (line <span class="line-number">25</span>)
199                </span>
200        </div>
201
202        <!-- ========== Info from phpDoc block ========= -->
203        <ul class="tags">
204                                <li><span class="field">access:</span> public</li>
205                        </ul>
206       
207       
208               
209               
210
211</div>
212<a name="var$description" id="$description"><!-- --></A>
213<div class="evenrow">
214
215        <div class="var-header">
216                <img src="../media/images/Variable.png" />
217                <span class="var-title">
218                        <span class="var-type">mixed</span>
219                        <span class="var-name">$description</span>
220                                                (line <span class="line-number">28</span>)
221                </span>
222        </div>
223
224        <!-- ========== Info from phpDoc block ========= -->
225        <ul class="tags">
226                                <li><span class="field">access:</span> public</li>
227                        </ul>
228       
229       
230               
231               
232
233</div>
234<a name="var$title" id="$title"><!-- --></A>
235<div class="oddrow">
236
237        <div class="var-header">
238                <img src="../media/images/Variable.png" />
239                <span class="var-title">
240                        <span class="var-type">mixed</span>
241                        <span class="var-name">$title</span>
242                                                (line <span class="line-number">26</span>)
243                </span>
244        </div>
245
246        <!-- ========== Info from phpDoc block ========= -->
247        <ul class="tags">
248                                <li><span class="field">access:</span> public</li>
249                        </ul>
250       
251       
252               
253               
254
255</div>
256<a name="var$type" id="$type"><!-- --></A>
257<div class="evenrow">
258
259        <div class="var-header">
260                <img src="../media/images/Variable.png" />
261                <span class="var-title">
262                        <span class="var-type">mixed</span>
263                        <span class="var-name">$type</span>
264                                                (line <span class="line-number">27</span>)
265                </span>
266        </div>
267
268        <!-- ========== Info from phpDoc block ========= -->
269        <ul class="tags">
270                                <li><span class="field">access:</span> public</li>
271                        </ul>
272       
273       
274               
275               
276
277</div>
278                                                        <h4>Inherited Variables</h4>
279                                <A NAME='inherited_vars'><!-- --></A>
280                                                                        <p>Inherited from <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
281                                        <blockquote>
282                                                                                                        <img src="../media/images/Variable.png" />
283                                                        <span class="var-title">
284                                                                <span class="var-name"><a href="../default/ResearchToolObject.html#var$uid">ResearchToolObject::$uid</a></span><br>
285                                                        </span>
286                                                                                        </blockquote>
287                                                                               
288                </div>
289        </div>
290       
291        <a name="sec-methods"></a>
292        <div class="info-box">
293                <div class="info-box-title">Methods</div>
294                <div class="nav-bar">
295                        <a href="#sec-description">Description</a> |
296                                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
297                                                                                                                <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
298                                               
299                </div>
300                <div class="info-box-body">
301                        <A NAME='method_detail'></A>
302<a name="methodcreate" id="create"><!-- --></a>
303<div class="oddrow">
304       
305        <div class="method-header">
306                <img src="../media/images/StaticMethod.png" />
307                <span class="method-title">static create</span> (line <span class="line-number">17</span>)
308        </div>
309       
310        <!-- ========== Info from phpDoc block ========= -->
311<p class="short-description">static function create()</p>
312        <ul class="tags">
313                                <li><span class="field">access:</span> public</li>
314                        </ul>
315       
316        <div class="method-signature">
317                <span class="method-result">void</span>
318                <span class="method-name">
319                        create
320                </span>
321                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$obj</span>)
322                        </div>
323       
324                        <ul class="parameters">
325                                        <li>
326                                <span class="var-type">type</span>
327                                <span class="var-name">$obj</span><span class="var-description">: : The object which should be converted to a Question</span>                   </li>
328                                </ul>
329               
330                       
331        </div>
332<a name="methodget" id="get"><!-- --></a>
333<div class="evenrow">
334       
335        <div class="method-header">
336                <img src="../media/images/StaticMethod.png" />
337                <span class="method-title">static get</span> (line <span class="line-number">120</span>)
338        </div>
339       
340        <!-- ========== Info from phpDoc block ========= -->
341<p class="short-description">Get the questions corresponding to the arguments.</p>
342        <ul class="tags">
343                                <li><span class="field">access:</span> public</li>
344                        </ul>
345       
346        <div class="method-signature">
347                <span class="method-result">void</span>
348                <span class="method-name">
349                        get
350                </span>
351                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span>)
352                        </div>
353       
354                        <ul class="parameters">
355                                        <li>
356                                <span class="var-type">type</span>
357                                <span class="var-name">$arguments</span><span class="var-description">: : An array having one ore more of the following elements:  'uid', 'code', 'title', 'type', 'description', 'category', 'definedanswers'.</span>                  </li>
358                                </ul>
359               
360                       
361        </div>
362<a name="method__construct" id="__construct"><!-- --></a>
363<div class="oddrow">
364       
365        <div class="method-header">
366                <img src="../media/images/Constructor.png" />
367                <span class="method-title">Constructor __construct</span> (line <span class="line-number">42</span>)
368        </div>
369       
370        <!-- ========== Info from phpDoc block ========= -->
371<p class="short-description">Constructor for a Question. $uid equals the corresponding code.</p>
372        <ul class="tags">
373                                <li><span class="field">access:</span> public</li>
374                        </ul>
375       
376        <div class="method-signature">
377                <span class="method-result">Question</span>
378                <span class="method-name">
379                        __construct
380                </span>
381                                        ([<span class="var-type">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">$code</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$description</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$category</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>])
382                        </div>
383       
384                        <ul class="parameters">
385                                        <li>
386                                <span class="var-type">type</span>
387                                <span class="var-name">$uid</span>                      </li>
388                                        <li>
389                                <span class="var-type">type</span>
390                                <span class="var-name">$title</span>                    </li>
391                                        <li>
392                                <span class="var-type">type</span>
393                                <span class="var-name">$type</span>                     </li>
394                                        <li>
395                                <span class="var-type">type</span>
396                                <span class="var-name">$description</span>                      </li>
397                                        <li>
398                                <span class="var-type">type</span>
399                                <span class="var-name">$category</span>                 </li>
400                                        <li>
401                                <span class="var-type">type</span>
402                                <span class="var-name">$answers</span>                  </li>
403                                        <li>
404                                <span class="var-type"></span>
405                                <span class="var-name">$code</span>                     </li>
406                                </ul>
407               
408                       
409        </div>
410<a name="methodsave" id="save"><!-- --></a>
411<div class="evenrow">
412       
413        <div class="method-header">
414                <img src="../media/images/Method.png" />
415                <span class="method-title">save</span> (line <span class="line-number">61</span>)
416        </div>
417       
418        <!-- ========== Info from phpDoc block ========= -->
419<p class="short-description">function save()  Saves the current object into the database.</p>
420        <ul class="tags">
421                                <li><span class="field">access:</span> public</li>
422                        </ul>
423       
424        <div class="method-signature">
425                <span class="method-result">void</span>
426                <span class="method-name">
427                        save
428                </span>
429                                ()
430                        </div>
431       
432               
433                       
434        </div>
435                                                        <h4>Inherited Methods</h4>
436                                <a name='inherited_methods'><!-- --></a>       
437                                                                        <!-- =========== Summary =========== -->
438                                        <p>Inherited From <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
439                                        <blockquote>
440                                                                                                        <img src="../media/images/Method.png" alt=" "/>
441                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodcreateArguments">ResearchToolObject::createArguments()</a></span><br>
442                                                                                                        <img src="../media/images/Method.png" alt=" "/>
443                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodevaluate">ResearchToolObject::evaluate()</a></span><br>
444                                                                                                        <img src="../media/images/Method.png" alt=" "/>
445                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodgetUid">ResearchToolObject::getUid()</a></span><br>
446                                                                                                        <img src="../media/images/Method.png" alt=" "/>
447                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodload">ResearchToolObject::load()</a></span><br>
448                                                                                                        <img src="../media/images/Method.png" alt=" "/>
449                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodstripUri">ResearchToolObject::stripUri()</a></span><br>
450                                                                                        </blockquote>
451                                                                               
452                </div>
453        </div>
454
455       
456        <p class="notes" id="credit">
457                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>
458        </p>
459        </div></body>
460</html>
Note: See TracBrowser for help on using the repository browser.