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

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

Added new PHPDoc :D

File size: 15.9 KB
Line 
1<?xml version="1.0" encoding="iso-8859-1"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3  <html xmlns="http://www.w3.org/1999/xhtml">
4                <head>
5                        <!-- template designed by Marco Von Ballmoos -->
6                        <title>Docs For Class ResearchToolObject</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/AbstractClass_logo.png"
13                                                                                                                alt="Abstract Class"
14                                                                                                                title="Abstract Class"
15                                                                                                                style="vertical-align: middle"> ResearchToolObject</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-descendents">Descendents</a>
23                        |                                                                                       <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
24                                                |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
25                                               
26                                        </div>
27        <div class="info-box-body">
28                <p class="implements">
29            Implements interfaces:
30            <ul>
31                <li><a href="../default/ResearchToolObjectInterface.html">ResearchToolObjectInterface</a></li>            </ul>
32        </p>
33                        <!-- ========== Info from phpDoc block ========= -->
34        <ul class="tags">
35                                <li><span class="field">abstract:</span> </li>
36                        </ul>
37                <p class="notes">
38                        Located in <a class="field" href="_models---ResearchToolObject.php.html">/models/ResearchToolObject.php</a> (line <span class="field">13</span>)
39                </p>
40               
41                               
42                <pre></pre>
43       
44                        </div>
45</div>
46
47        <a name="sec-descendents"></a>
48        <div class="info-box">
49                <div class="info-box-title">Direct descendents</div>
50                <div class="nav-bar">
51                        <a href="#sec-description">Description</a> |
52                        <span class="disabled">Descendents</span>
53                        |                                                                                               <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
54                                                                |                                                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
55                                                       
56                                                                </div>
57                <div class="info-box-body">
58                        <table cellpadding="2" cellspacing="0" class="class-table">
59                                <tr>
60                                        <th class="class-table-header">Class</th>
61                                        <th class="class-table-header">Description</th>
62                                </tr>
63                                                                <tr>
64                                        <td style="padding-right: 2em; white-space: nowrap">
65                                                <img src="../media/images/Class.png"
66                                                                 alt=" class"
67                                                                 title=" class"
68                                                                 style="vertical-align: center"/>
69                                                <a href="../default/Answer.html">Answer</a>
70                                        </td>
71                                        <td>
72                                                                                        Description of Answer
73                                                                                </td>
74                                </tr>
75                                                                <tr>
76                                        <td style="padding-right: 2em; white-space: nowrap">
77                                                <img src="../media/images/Class.png"
78                                                                 alt=" class"
79                                                                 title=" class"
80                                                                 style="vertical-align: center"/>
81                                                <a href="../default/AnswerSet.html">AnswerSet</a>
82                                        </td>
83                                        <td>
84                                                                                        AnswerSet is a collection of answers corresponding to a Session
85                                                                                </td>
86                                </tr>
87                                                                <tr>
88                                        <td style="padding-right: 2em; white-space: nowrap">
89                                                <img src="../media/images/Class.png"
90                                                                 alt=" class"
91                                                                 title=" class"
92                                                                 style="vertical-align: center"/>
93                                                <a href="../default/Application.html">Application</a>
94                                        </td>
95                                        <td>
96                                                                                        Description of Application
97                                                                                </td>
98                                </tr>
99                                                                <tr>
100                                        <td style="padding-right: 2em; white-space: nowrap">
101                                                <img src="../media/images/Class.png"
102                                                                 alt=" class"
103                                                                 title=" class"
104                                                                 style="vertical-align: center"/>
105                                                <a href="../default/ApplicationInstance.html">ApplicationInstance</a>
106                                        </td>
107                                        <td>
108                                                                                        Description of ApplicationInstance
109                                                                                </td>
110                                </tr>
111                                                                <tr>
112                                        <td style="padding-right: 2em; white-space: nowrap">
113                                                <img src="../media/images/Class.png"
114                                                                 alt=" class"
115                                                                 title=" class"
116                                                                 style="vertical-align: center"/>
117                                                <a href="../default/Question.html">Question</a>
118                                        </td>
119                                        <td>
120                                                                                        Description of Question
121                                                                                </td>
122                                </tr>
123                                                                <tr>
124                                        <td style="padding-right: 2em; white-space: nowrap">
125                                                <img src="../media/images/Class.png"
126                                                                 alt=" class"
127                                                                 title=" class"
128                                                                 style="vertical-align: center"/>
129                                                <a href="../default/Respondent.html">Respondent</a>
130                                        </td>
131                                        <td>
132                                                                                        Description of Respondent
133                                                                                </td>
134                                </tr>
135                                                                <tr>
136                                        <td style="padding-right: 2em; white-space: nowrap">
137                                                <img src="../media/images/Class.png"
138                                                                 alt=" class"
139                                                                 title=" class"
140                                                                 style="vertical-align: center"/>
141                                                <a href="../default/Session.html">Session</a>
142                                        </td>
143                                        <td>
144                                                                                        Description of Session
145                                                                                </td>
146                                </tr>
147                                                                <tr>
148                                        <td style="padding-right: 2em; white-space: nowrap">
149                                                <img src="../media/images/Class.png"
150                                                                 alt=" class"
151                                                                 title=" class"
152                                                                 style="vertical-align: center"/>
153                                                <a href="../default/SessionInstance.html">SessionInstance</a>
154                                        </td>
155                                        <td>
156                                                                                        Description of SessionInstance
157                                                                                </td>
158                                </tr>
159                                                                <tr>
160                                        <td style="padding-right: 2em; white-space: nowrap">
161                                                <img src="../media/images/Class.png"
162                                                                 alt=" class"
163                                                                 title=" class"
164                                                                 style="vertical-align: center"/>
165                                                <a href="../default/Survey.html">Survey</a>
166                                        </td>
167                                        <td>
168                                                                                        Description of Survey
169                                                                                </td>
170                                </tr>
171                                                                <tr>
172                                        <td style="padding-right: 2em; white-space: nowrap">
173                                                <img src="../media/images/Class.png"
174                                                                 alt=" class"
175                                                                 title=" class"
176                                                                 style="vertical-align: center"/>
177                                                <a href="../default/SurveyInstance.html">SurveyInstance</a>
178                                        </td>
179                                        <td>
180                                                                                        Description of SurveyInstance
181                                                                                </td>
182                                </tr>
183                                                                <tr>
184                                        <td style="padding-right: 2em; white-space: nowrap">
185                                                <img src="../media/images/Class.png"
186                                                                 alt=" class"
187                                                                 title=" class"
188                                                                 style="vertical-align: center"/>
189                                                <a href="../default/User.html">User</a>
190                                        </td>
191                                        <td>
192                                                                                        Description of User
193                                                                                </td>
194                                </tr>
195                                                        </table>
196                </div>
197        </div>
198
199
200        <a name="sec-var-summary"></a>
201        <div class="info-box">
202                <div class="info-box-title">Variable Summary</span></div>
203                <div class="nav-bar">
204                        <a href="#sec-description">Description</a> |
205                                                        <a href="#sec-descendents">Descendants</a> |
206                                                <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
207                                                        |
208                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
209                                                       
210                                                                </div>
211                <div class="info-box-body">
212                        <div class="var-summary">
213                                                                                                                                                                                                <div class="var-title">
214                                        <img src="../media/images/Variable.png" alt=" " />
215                                        <span class="var-type">mixed</span>
216                                        <a href="#$uid" title="details" class="var-name">$uid</a>
217                                </div>
218                                                                                        </div>
219                </div>
220        </div>
221
222        <a name="sec-method-summary"></a>
223        <div class="info-box">
224                <div class="info-box-title">Method Summary</span></div>
225                <div class="nav-bar">
226                        <a href="#sec-description">Description</a> |
227                                                        <a href="#sec-descendents">Descendants</a> |
228                                                                                                                                                <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
229                                 
230                                |
231                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
232                </div>
233                <div class="info-box-body">                     
234                        <div class="method-summary">
235                                                                                                <div class="method-definition">
236                                        <img src="../media/images/StaticMethod.png" alt=" "/>
237                                                                                        static <span class="method-result">void</span>
238                                                                                <a href="#createArguments" title="details" class="method-name">createArguments</a>
239                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span>)
240                                                                        </div>
241                                                                                                                                                                                                                                                                <div class="method-definition">
242                                        <img src="../media/images/StaticMethod.png" alt=" "/>
243                                                                                        static <span class="method-result">void</span>
244                                                                                <a href="#load" title="details" class="method-name">load</a>
245                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$filename</span>)
246                                                                        </div>
247                                                                                                                                <div class="method-definition">
248                                        <img src="../media/images/StaticMethod.png" alt=" "/>
249                                                                                        static <span class="method-result">void</span>
250                                                                                <a href="#stripUri" title="details" class="method-name">stripUri</a>
251                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$inString</span>)
252                                                                        </div>
253                                                                                                                                                                                                                                <div class="method-definition">
254                                        <img src="../media/images/Method.png" alt=" "/>
255                                                                                        <span class="method-result">void</span>
256                                                                                <a href="#evaluate" title="details" class="method-name">evaluate</a>
257                                                                                ()
258                                                                        </div>
259                                                                                                                                <div class="method-definition">
260                                        <img src="../media/images/Method.png" alt=" "/>
261                                                                                        <span class="method-result">void</span>
262                                                                                <a href="#getUid" title="details" class="method-name">getUid</a>
263                                                                                ()
264                                                                        </div>
265                                                                                                                                                                                                                        </div>
266                </div>
267        </div>         
268
269        <a name="sec-vars"></a>
270        <div class="info-box">
271                <div class="info-box-title">Variables</div>
272                <div class="nav-bar">
273                        <a href="#sec-description">Description</a> |
274                                                        <a href="#sec-descendents">Descendents</a> |
275                                                                                <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
276                                               
277                       
278                                                                                |
279                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
280                                                       
281                                        </div>
282                <div class="info-box-body">
283                       
284<a name="var$uid" id="$uid"><!-- --></A>
285<div class="oddrow">
286
287        <div class="var-header">
288                <img src="../media/images/Variable.png" />
289                <span class="var-title">
290                        <span class="var-type">mixed</span>
291                        <span class="var-name">$uid</span>
292                         = <span class="var-default"> null</span>                       (line <span class="line-number">15</span>)
293                </span>
294        </div>
295
296        <!-- ========== Info from phpDoc block ========= -->
297        <ul class="tags">
298                                <li><span class="field">access:</span> public</li>
299                        </ul>
300       
301       
302               
303               
304
305</div>
306                                               
307                </div>
308        </div>
309       
310        <a name="sec-methods"></a>
311        <div class="info-box">
312                <div class="info-box-title">Methods</div>
313                <div class="nav-bar">
314                        <a href="#sec-description">Description</a> |
315                                                        <a href="#sec-descendents">Descendents</a> |
316                                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
317                                                                                                                <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
318                                               
319                </div>
320                <div class="info-box-body">
321                        <A NAME='method_detail'></A>
322<a name="methodcreateArguments" id="createArguments"><!-- --></a>
323<div class="evenrow">
324       
325        <div class="method-header">
326                <img src="../media/images/StaticMethod.png" />
327                <span class="method-title">static createArguments</span> (line <span class="line-number">54</span>)
328        </div>
329       
330        <!-- ========== Info from phpDoc block ========= -->
331<p class="short-description">function createArguments()</p>
332        <ul class="tags">
333                                <li><span class="field">access:</span> public</li>
334                        </ul>
335       
336        <div class="method-signature">
337                <span class="method-result">void</span>
338                <span class="method-name">
339                        createArguments
340                </span>
341                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span>)
342                        </div>
343       
344                        <ul class="parameters">
345                                        <li>
346                                <span class="var-type">type</span>
347                                <span class="var-name">$arguments</span><span class="var-description">: Creates the arguments to be used in the query based on the  arguments specified in the incoming array.</span>                   </li>
348                                </ul>
349               
350                       
351        </div>
352<a name="methodload" id="load"><!-- --></a>
353<div class="oddrow">
354       
355        <div class="method-header">
356                <img src="../media/images/StaticMethod.png" />
357                <span class="method-title">static load</span> (line <span class="line-number">26</span>)
358        </div>
359       
360        <!-- ========== Info from phpDoc block ========= -->
361        <ul class="tags">
362                                <li><span class="field">access:</span> public</li>
363                        </ul>
364       
365        <div class="method-signature">
366                <span class="method-result">void</span>
367                <span class="method-name">
368                        load
369                </span>
370                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$filename</span>)
371                        </div>
372       
373                        <ul class="parameters">
374                                        <li>
375                                <span class="var-type"></span>
376                                <span class="var-name">$filename</span>                 </li>
377                                </ul>
378               
379                       
380        </div>
381<a name="methodstripUri" id="stripUri"><!-- --></a>
382<div class="evenrow">
383       
384        <div class="method-header">
385                <img src="../media/images/StaticMethod.png" />
386                <span class="method-title">static stripUri</span> (line <span class="line-number">39</span>)
387        </div>
388       
389        <!-- ========== Info from phpDoc block ========= -->
390<p class="short-description">function stripUri($inString)</p>
391        <ul class="tags">
392                                <li><span class="field">access:</span> public</li>
393                        </ul>
394       
395        <div class="method-signature">
396                <span class="method-result">void</span>
397                <span class="method-name">
398                        stripUri
399                </span>
400                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$inString</span>)
401                        </div>
402       
403                        <ul class="parameters">
404                                        <li>
405                                <span class="var-type">type</span>
406                                <span class="var-name">$inString</span><span class="var-description">: Takes a URI and creates a new array which contains the type and the uid of the object</span>                     </li>
407                                </ul>
408               
409                       
410        </div>
411<a name="methodevaluate" id="evaluate"><!-- --></a>
412<div class="oddrow">
413       
414        <div class="method-header">
415                <img src="../media/images/Method.png" />
416                <span class="method-title">evaluate</span> (line <span class="line-number">21</span>)
417        </div>
418       
419        <!-- ========== Info from phpDoc block ========= -->
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                        evaluate
428                </span>
429                                ()
430                        </div>
431       
432               
433                                <hr class="separator" />
434                <div class="notes">Implementation of:</div>
435                        <dl>
436                        <dt><a href="../default/ResearchToolObjectInterface.html#methodevaluate">ResearchToolObjectInterface::evaluate()</a></dt>
437                                        </dl>
438                       
439                        <hr class="separator" />
440                <div class="notes">Redefined in descendants as:</div>
441                <ul class="redefinitions">
442                                        <li>
443                                <a href="../default/Answer.html#methodevaluate">Answer::evaluate()</a>
444                                                                : function evaluate()  Evaluates the references and fills in the objects for them instead.
445                                                        </li>
446                                        <li>
447                                <a href="../default/AnswerSet.html#methodevaluate">AnswerSet::evaluate()</a>
448                                                                : function evaluate()  evaluates the references of survey, respondent and answers.
449                                                        </li>
450                                        <li>
451                                <a href="../default/ApplicationInstance.html#methodevaluate">ApplicationInstance::evaluate()</a>
452                                                                : function evaluate()
453                                                        </li>
454                                        <li>
455                                <a href="../default/Session.html#methodevaluate">Session::evaluate()</a>
456                                                        </li>
457                                        <li>
458                                <a href="../default/SessionInstance.html#methodevaluate">SessionInstance::evaluate()</a>
459                                                        </li>
460                                        <li>
461                                <a href="../default/Survey.html#methodevaluate">Survey::evaluate()</a>
462                                                                : function evaluate()
463                                                        </li>
464                                        <li>
465                                <a href="../default/SurveyInstance.html#methodevaluate">SurveyInstance::evaluate()</a>
466                                                                : function evaluate()
467                                                        </li>
468                                </ul>
469        </div>
470<a name="methodgetUid" id="getUid"><!-- --></a>
471<div class="evenrow">
472       
473        <div class="method-header">
474                <img src="../media/images/Method.png" />
475                <span class="method-title">getUid</span> (line <span class="line-number">17</span>)
476        </div>
477       
478        <!-- ========== Info from phpDoc block ========= -->
479        <ul class="tags">
480                                <li><span class="field">access:</span> public</li>
481                        </ul>
482       
483        <div class="method-signature">
484                <span class="method-result">void</span>
485                <span class="method-name">
486                        getUid
487                </span>
488                                ()
489                        </div>
490       
491               
492                                <hr class="separator" />
493                <div class="notes">Implementation of:</div>
494                        <dl>
495                        <dt><a href="../default/ResearchToolObjectInterface.html#methodgetUid">ResearchToolObjectInterface::getUid()</a></dt>
496                                        </dl>
497                       
498        </div>
499                                               
500                </div>
501        </div>
502
503       
504        <p class="notes" id="credit">
505                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>
506        </p>
507        </div></body>
508</html>
Note: See TracBrowser for help on using the repository browser.