source: Doc/Backend/PHPDoc/default/Answer.html @ 532

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

Added new PHPDoc :D

File size: 14.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 Answer</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"> Answer</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 Answer</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---Answer.php.html">/models/Answer.php</a> (line <span class="field">12</span>)
34                </p>
35               
36                               
37                <pre><a href="../default/ResearchToolObject.html">ResearchToolObject</a>
38   |
39   --Answer</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="#$question" title="details" class="var-name">$question</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="#$values" title="details" class="var-name">$values</a>
72                                </div>
73                                                                                        </div>
74                </div>
75        </div>
76
77        <a name="sec-method-summary"></a>
78        <div class="info-box">
79                <div class="info-box-title">Method Summary</span></div>
80                <div class="nav-bar">
81                        <a href="#sec-description">Description</a> |
82                                                                                                                                                <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
83                                 
84                                |
85                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
86                </div>
87                <div class="info-box-body">                     
88                        <div class="method-summary">
89                                                                                                                                                                <div class="method-definition">
90                                        <img src="../media/images/StaticMethod.png" alt=" "/>
91                                                                                        static <span class="method-result">void</span>
92                                                                                <a href="#create" title="details" class="method-name">create</a>
93                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$obj</span>)
94                                                                        </div>
95                                                                                                                                                                                                <div class="method-definition">
96                                        <img src="../media/images/StaticMethod.png" alt=" "/>
97                                                                                        static <span class="method-result">void</span>
98                                                                                <a href="#get" title="details" class="method-name">get</a>
99                                                                                        (<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>)
100                                                                        </div>
101                                                                                                                                                                                                                                <div class="method-definition">
102                                        <img src="../media/images/Constructor.png" alt=" "/>
103                                                                                        <span class="method-result">Answer</span>
104                                                                                <a href="#__construct" title="details" class="method-name">__construct</a>
105                                                                                        ([<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">$question</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$values</span> = <span class="var-default">null</span>])
106                                                                        </div>
107                                                                                                                                                                                                <div class="method-definition">
108                                        <img src="../media/images/Method.png" alt=" "/>
109                                                                                        <span class="method-result">void</span>
110                                                                                <a href="#evaluate" title="details" class="method-name">evaluate</a>
111                                                                                ()
112                                                                        </div>
113                                                                                                                                                                                                <div class="method-definition">
114                                        <img src="../media/images/Method.png" alt=" "/>
115                                                                                        <span class="method-result">void</span>
116                                                                                <a href="#save" title="details" class="method-name">save</a>
117                                                                                ()
118                                                                        </div>
119                                                                                        </div>
120                </div>
121        </div>         
122
123        <a name="sec-vars"></a>
124        <div class="info-box">
125                <div class="info-box-title">Variables</div>
126                <div class="nav-bar">
127                        <a href="#sec-description">Description</a> |
128                                                                                <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
129                                               
130                       
131                                                                                |
132                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
133                                                       
134                                        </div>
135                <div class="info-box-body">
136                        <a name="var$filename" id="$filename"><!-- --></A>
137<div class="evenrow">
138
139        <div class="var-header">
140                <img src="../media/images/Variable.png" />
141                <span class="var-title">
142                        static <span class="var-type">mixed</span>
143                        <span class="var-name">$filename</span>
144                         = <span class="var-default"> 'data/results/answers.rdf'</span>                 (line <span class="line-number">23</span>)
145                </span>
146        </div>
147
148        <!-- ========== Info from phpDoc block ========= -->
149        <ul class="tags">
150                                <li><span class="field">access:</span> public</li>
151                        </ul>
152       
153       
154               
155               
156
157</div>
158
159<a name="var$question" id="$question"><!-- --></A>
160<div class="oddrow">
161
162        <div class="var-header">
163                <img src="../media/images/Variable.png" />
164                <span class="var-title">
165                        <span class="var-type">mixed</span>
166                        <span class="var-name">$question</span>
167                                                (line <span class="line-number">25</span>)
168                </span>
169        </div>
170
171        <!-- ========== Info from phpDoc block ========= -->
172        <ul class="tags">
173                                <li><span class="field">access:</span> public</li>
174                        </ul>
175       
176       
177               
178               
179
180</div>
181<a name="var$values" id="$values"><!-- --></A>
182<div class="evenrow">
183
184        <div class="var-header">
185                <img src="../media/images/Variable.png" />
186                <span class="var-title">
187                        <span class="var-type">mixed</span>
188                        <span class="var-name">$values</span>
189                                                (line <span class="line-number">26</span>)
190                </span>
191        </div>
192
193        <!-- ========== Info from phpDoc block ========= -->
194        <ul class="tags">
195                                <li><span class="field">access:</span> public</li>
196                        </ul>
197       
198       
199               
200               
201
202</div>
203                                                        <h4>Inherited Variables</h4>
204                                <A NAME='inherited_vars'><!-- --></A>
205                                                                        <p>Inherited from <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
206                                        <blockquote>
207                                                                                                        <img src="../media/images/Variable.png" />
208                                                        <span class="var-title">
209                                                                <span class="var-name"><a href="../default/ResearchToolObject.html#var$uid">ResearchToolObject::$uid</a></span><br>
210                                                        </span>
211                                                                                        </blockquote>
212                                                                               
213                </div>
214        </div>
215       
216        <a name="sec-methods"></a>
217        <div class="info-box">
218                <div class="info-box-title">Methods</div>
219                <div class="nav-bar">
220                        <a href="#sec-description">Description</a> |
221                                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
222                                                                                                                <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
223                                               
224                </div>
225                <div class="info-box-body">
226                        <A NAME='method_detail'></A>
227<a name="methodcreate" id="create"><!-- --></a>
228<div class="oddrow">
229       
230        <div class="method-header">
231                <img src="../media/images/StaticMethod.png" />
232                <span class="method-title">static create</span> (line <span class="line-number">18</span>)
233        </div>
234       
235        <!-- ========== Info from phpDoc block ========= -->
236<p class="short-description">static function create()</p>
237        <ul class="tags">
238                                <li><span class="field">access:</span> public</li>
239                        </ul>
240       
241        <div class="method-signature">
242                <span class="method-result">void</span>
243                <span class="method-name">
244                        create
245                </span>
246                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$obj</span>)
247                        </div>
248       
249                        <ul class="parameters">
250                                        <li>
251                                <span class="var-type">type</span>
252                                <span class="var-name">$obj</span><span class="var-description">: : The object which should be converted to an Answer</span>                    </li>
253                                </ul>
254               
255                       
256        </div>
257<a name="methodget" id="get"><!-- --></a>
258<div class="evenrow">
259       
260        <div class="method-header">
261                <img src="../media/images/StaticMethod.png" />
262                <span class="method-title">static get</span> (line <span class="line-number">67</span>)
263        </div>
264       
265        <!-- ========== Info from phpDoc block ========= -->
266<p class="short-description">function get()</p>
267        <ul class="tags">
268                                <li><span class="field">access:</span> public</li>
269                        </ul>
270       
271        <div class="method-signature">
272                <span class="method-result">void</span>
273                <span class="method-name">
274                        get
275                </span>
276                                        (<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>)
277                        </div>
278       
279                        <ul class="parameters">
280                                        <li>
281                                <span class="var-type">type</span>
282                                <span class="var-name">$arguments:</span><span class="var-description">: An array having one or more of the following elements:  'uid', 'question', 'values'.</span>                    </li>
283                                        <li>
284                                <span class="var-type"></span>
285                                <span class="var-name">$arguments</span>                        </li>
286                                </ul>
287               
288                       
289        </div>
290<a name="method__construct" id="__construct"><!-- --></a>
291<div class="oddrow">
292       
293        <div class="method-header">
294                <img src="../media/images/Constructor.png" />
295                <span class="method-title">Constructor __construct</span> (line <span class="line-number">34</span>)
296        </div>
297       
298        <!-- ========== Info from phpDoc block ========= -->
299<p class="short-description">Constructor for an Answer object</p>
300        <ul class="tags">
301                                <li><span class="field">access:</span> public</li>
302                        </ul>
303       
304        <div class="method-signature">
305                <span class="method-result">Answer</span>
306                <span class="method-name">
307                        __construct
308                </span>
309                                        ([<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">$question</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$values</span> = <span class="var-default">null</span>])
310                        </div>
311       
312                        <ul class="parameters">
313                                        <li>
314                                <span class="var-type">type</span>
315                                <span class="var-name">$uid</span><span class="var-description">: : The uid of the Answer object.</span>                        </li>
316                                        <li>
317                                <span class="var-type">type</span>
318                                <span class="var-name">$question</span><span class="var-description">: : The Question object this Answer answers.</span>                        </li>
319                                        <li>
320                                <span class="var-type">type</span>
321                                <span class="var-name">$values</span><span class="var-description">: : An array of strings, containing the answers.</span>                      </li>
322                                </ul>
323               
324                       
325        </div>
326<a name="methodevaluate" id="evaluate"><!-- --></a>
327<div class="evenrow">
328       
329        <div class="method-header">
330                <img src="../media/images/Method.png" />
331                <span class="method-title">evaluate</span> (line <span class="line-number">48</span>)
332        </div>
333       
334        <!-- ========== Info from phpDoc block ========= -->
335<p class="short-description">function evaluate()  Evaluates the references and fills in the objects for them instead.</p>
336        <ul class="tags">
337                                <li><span class="field">access:</span> public</li>
338                        </ul>
339       
340        <div class="method-signature">
341                <span class="method-result">void</span>
342                <span class="method-name">
343                        evaluate
344                </span>
345                                ()
346                        </div>
347       
348               
349                        <hr class="separator" />
350                <div class="notes">Redefinition of:</div>
351                <dl>
352                        <dt><a href="../default/ResearchToolObject.html#methodevaluate">ResearchToolObject::evaluate()</a></dt>
353                                        </dl>
354                       
355        </div>
356<a name="methodsave" id="save"><!-- --></a>
357<div class="oddrow">
358       
359        <div class="method-header">
360                <img src="../media/images/Method.png" />
361                <span class="method-title">save</span> (line <span class="line-number">119</span>)
362        </div>
363       
364        <!-- ========== Info from phpDoc block ========= -->
365<p class="short-description">function save()  Saves the current object into the database.</p>
366        <ul class="tags">
367                                <li><span class="field">access:</span> public</li>
368                        </ul>
369       
370        <div class="method-signature">
371                <span class="method-result">void</span>
372                <span class="method-name">
373                        save
374                </span>
375                                ()
376                        </div>
377       
378               
379                       
380        </div>
381                                                        <h4>Inherited Methods</h4>
382                                <a name='inherited_methods'><!-- --></a>       
383                                                                        <!-- =========== Summary =========== -->
384                                        <p>Inherited From <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
385                                        <blockquote>
386                                                                                                        <img src="../media/images/Method.png" alt=" "/>
387                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodcreateArguments">ResearchToolObject::createArguments()</a></span><br>
388                                                                                                        <img src="../media/images/Method.png" alt=" "/>
389                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodevaluate">ResearchToolObject::evaluate()</a></span><br>
390                                                                                                        <img src="../media/images/Method.png" alt=" "/>
391                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodgetUid">ResearchToolObject::getUid()</a></span><br>
392                                                                                                        <img src="../media/images/Method.png" alt=" "/>
393                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodload">ResearchToolObject::load()</a></span><br>
394                                                                                                        <img src="../media/images/Method.png" alt=" "/>
395                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodstripUri">ResearchToolObject::stripUri()</a></span><br>
396                                                                                        </blockquote>
397                                                                               
398                </div>
399        </div>
400
401       
402        <p class="notes" id="credit">
403                Documentation generated on Thu, 01 Mar 2012 15:13:50 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
404        </p>
405        </div></body>
406</html>
Note: See TracBrowser for help on using the repository browser.