source: Doc/Backend/PHPDoc/default/Session.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.3 KB
RevLine 
[301]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 Session</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"> Session</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 Session</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---Session.php.html">/models/Session.php</a> (line <span class="field">11</span>)
34                </p>
35               
36                               
37                <pre><a href="../default/ResearchToolObject.html">ResearchToolObject</a>
38   |
39   --Session</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="#$creationdate" title="details" class="var-name">$creationdate</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="#$creator" title="details" class="var-name">$creator</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="#$pipeline" title="details" class="var-name">$pipeline</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="#$title" title="details" class="var-name">$title</a>
77                                </div>
78                                                                                        </div>
79                </div>
80        </div>
81
82        <a name="sec-method-summary"></a>
83        <div class="info-box">
84                <div class="info-box-title">Method Summary</span></div>
85                <div class="nav-bar">
86                        <a href="#sec-description">Description</a> |
87                                                                                                                                                <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
88                                 
89                                |
90                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
91                </div>
92                <div class="info-box-body">                     
93                        <div class="method-summary">
94                                                                                                                                                                <div class="method-definition">
95                                        <img src="../media/images/StaticMethod.png" alt=" "/>
96                                                                                        static <span class="method-result">void</span>
97                                                                                <a href="#create" title="details" class="method-name">create</a>
98                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$obj</span>)
99                                                                        </div>
100                                                                                                                                                                                                <div class="method-definition">
101                                        <img src="../media/images/StaticMethod.png" alt=" "/>
102                                                                                        static <span class="method-result">void</span>
103                                                                                <a href="#get" title="details" class="method-name">get</a>
104                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span>)
105                                                                        </div>
106                                                                                                                                                                                                                                                                                                <div class="method-definition">
107                                        <img src="../media/images/Constructor.png" alt=" "/>
108                                                                                        <span class="method-result">Session</span>
109                                                                                <a href="#__construct" title="details" class="method-name">__construct</a>
110                                                                                        ([<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">$title</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$creator</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$creationdate</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$pipeline</span> = <span class="var-default">null</span>])
111                                                                        </div>
112                                                                                                                                                                                                <div class="method-definition">
113                                        <img src="../media/images/Method.png" alt=" "/>
114                                                                                        <span class="method-result">void</span>
115                                                                                <a href="#evaluate" title="details" class="method-name">evaluate</a>
116                                                                                ()
117                                                                        </div>
118                                                                                                                                                                                                <div class="method-definition">
119                                        <img src="../media/images/Method.png" alt=" "/>
120                                                                                        <span class="method-result">void</span>
121                                                                                <a href="#save" title="details" class="method-name">save</a>
122                                                                                ()
123                                                                        </div>
124                                                                                                                                <div class="method-definition">
125                                        <img src="../media/images/Method.png" alt=" "/>
126                                                                                        <span class="method-result">void</span>
127                                                                                <a href="#toSPSS" title="details" class="method-name">toSPSS</a>
128                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$location</span>)
129                                                                        </div>
130                                                                                        </div>
131                </div>
132        </div>         
133
134        <a name="sec-vars"></a>
135        <div class="info-box">
136                <div class="info-box-title">Variables</div>
137                <div class="nav-bar">
138                        <a href="#sec-description">Description</a> |
139                                                                                <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
140                                               
141                       
142                                                                                |
143                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
144                                                       
145                                        </div>
146                <div class="info-box-body">
147                       
148<a name="var$creationdate" id="$creationdate"><!-- --></A>
149<div class="oddrow">
150
151        <div class="var-header">
152                <img src="../media/images/Variable.png" />
153                <span class="var-title">
154                        <span class="var-type">mixed</span>
155                        <span class="var-name">$creationdate</span>
156                                                (line <span class="line-number">17</span>)
157                </span>
158        </div>
159
160        <!-- ========== Info from phpDoc block ========= -->
161        <ul class="tags">
162                                <li><span class="field">access:</span> public</li>
163                        </ul>
164       
165       
166               
167               
168
169</div>
170<a name="var$creator" id="$creator"><!-- --></A>
171<div class="evenrow">
172
173        <div class="var-header">
174                <img src="../media/images/Variable.png" />
175                <span class="var-title">
176                        <span class="var-type">mixed</span>
177                        <span class="var-name">$creator</span>
178                                                (line <span class="line-number">16</span>)
179                </span>
180        </div>
181
182        <!-- ========== Info from phpDoc block ========= -->
183        <ul class="tags">
184                                <li><span class="field">access:</span> public</li>
185                        </ul>
186       
187       
188               
189               
190
191</div>
192<a name="var$pipeline" id="$pipeline"><!-- --></A>
193<div class="oddrow">
194
195        <div class="var-header">
196                <img src="../media/images/Variable.png" />
197                <span class="var-title">
198                        <span class="var-type">mixed</span>
199                        <span class="var-name">$pipeline</span>
200                                                (line <span class="line-number">18</span>)
201                </span>
202        </div>
203
204        <!-- ========== Info from phpDoc block ========= -->
205        <ul class="tags">
206                                <li><span class="field">access:</span> public</li>
207                        </ul>
208       
209       
210               
211               
212
213</div>
214<a name="var$title" id="$title"><!-- --></A>
215<div class="evenrow">
216
217        <div class="var-header">
218                <img src="../media/images/Variable.png" />
219                <span class="var-title">
220                        <span class="var-type">mixed</span>
221                        <span class="var-name">$title</span>
222                                                (line <span class="line-number">15</span>)
223                </span>
224        </div>
225
226        <!-- ========== Info from phpDoc block ========= -->
227        <ul class="tags">
228                                <li><span class="field">access:</span> public</li>
229                        </ul>
230       
231       
232               
233               
234
235</div>
236                                                        <h4>Inherited Variables</h4>
237                                <A NAME='inherited_vars'><!-- --></A>
238                                                                        <p>Inherited from <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
239                                        <blockquote>
240                                                                                                        <img src="../media/images/Variable.png" />
241                                                        <span class="var-title">
242                                                                <span class="var-name"><a href="../default/ResearchToolObject.html#var$uid">ResearchToolObject::$uid</a></span><br>
243                                                        </span>
244                                                                                        </blockquote>
245                                                                               
246                </div>
247        </div>
248       
249        <a name="sec-methods"></a>
250        <div class="info-box">
251                <div class="info-box-title">Methods</div>
252                <div class="nav-bar">
253                        <a href="#sec-description">Description</a> |
254                                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
255                                                                                                                <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
256                                               
257                </div>
258                <div class="info-box-body">
259                        <A NAME='method_detail'></A>
260<a name="methodcreate" id="create"><!-- --></a>
261<div class="oddrow">
262       
263        <div class="method-header">
264                <img src="../media/images/StaticMethod.png" />
265                <span class="method-title">static create</span> (line <span class="line-number">323</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        <div class="method-signature">
274                <span class="method-result">void</span>
275                <span class="method-name">
276                        create
277                </span>
278                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$obj</span>)
279                        </div>
280       
281                        <ul class="parameters">
282                                        <li>
283                                <span class="var-type"></span>
284                                <span class="var-name">$obj</span>                      </li>
285                                </ul>
286               
287                       
288        </div>
289<a name="methodget" id="get"><!-- --></a>
290<div class="evenrow">
291       
292        <div class="method-header">
293                <img src="../media/images/StaticMethod.png" />
294                <span class="method-title">static get</span> (line <span class="line-number">155</span>)
295        </div>
296       
297        <!-- ========== Info from phpDoc block ========= -->
298<p class="short-description">function get()</p>
299        <ul class="tags">
300                                <li><span class="field">access:</span> public</li>
301                        </ul>
302       
303        <div class="method-signature">
304                <span class="method-result">void</span>
305                <span class="method-name">
306                        get
307                </span>
308                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span>)
309                        </div>
310       
311                        <ul class="parameters">
312                                        <li>
313                                <span class="var-type">type</span>
314                                <span class="var-name">$arguments</span><span class="var-description">: : An array containing one or more of the following elements:  'uid', 'title', 'creationdate', 'applications', 'surveys'</span>                  </li>
315                                </ul>
316               
317                       
318        </div>
319<a name="method__construct" id="__construct"><!-- --></a>
320<div class="oddrow">
321       
322        <div class="method-header">
323                <img src="../media/images/Constructor.png" />
324                <span class="method-title">Constructor __construct</span> (line <span class="line-number">29</span>)
325        </div>
326       
327        <!-- ========== Info from phpDoc block ========= -->
328<p class="short-description">Constructor for a Session object</p>
329        <ul class="tags">
330                                <li><span class="field">access:</span> public</li>
331                        </ul>
332       
333        <div class="method-signature">
334                <span class="method-result">Session</span>
335                <span class="method-name">
336                        __construct
337                </span>
338                                        ([<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">$title</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$creator</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$creationdate</span> = <span class="var-default">null</span>], [<span class="var-type">type</span>&nbsp;<span class="var-name">$pipeline</span> = <span class="var-default">null</span>])
339                        </div>
340       
341                        <ul class="parameters">
342                                        <li>
343                                <span class="var-type">type</span>
344                                <span class="var-name">$uid</span>                      </li>
345                                        <li>
346                                <span class="var-type">type</span>
347                                <span class="var-name">$title</span>                    </li>
348                                        <li>
349                                <span class="var-type">type</span>
350                                <span class="var-name">$creator</span>                  </li>
351                                        <li>
352                                <span class="var-type">type</span>
353                                <span class="var-name">$creationdate</span>                     </li>
354                                        <li>
355                                <span class="var-type">type</span>
356                                <span class="var-name">$pipeline</span>                 </li>
357                                </ul>
358               
359                       
360        </div>
361<a name="methodevaluate" id="evaluate"><!-- --></a>
362<div class="evenrow">
363       
364        <div class="method-header">
365                <img src="../media/images/Method.png" />
366                <span class="method-title">evaluate</span> (line <span class="line-number">46</span>)
367        </div>
368       
369        <!-- ========== Info from phpDoc block ========= -->
370        <ul class="tags">
371                                <li><span class="field">access:</span> public</li>
372                        </ul>
373       
374        <div class="method-signature">
375                <span class="method-result">void</span>
376                <span class="method-name">
377                        evaluate
378                </span>
379                                ()
380                        </div>
381       
382               
383                        <hr class="separator" />
384                <div class="notes">Redefinition of:</div>
385                <dl>
386                        <dt><a href="../default/ResearchToolObject.html#methodevaluate">ResearchToolObject::evaluate()</a></dt>
387                                        </dl>
388                       
389        </div>
390<a name="methodsave" id="save"><!-- --></a>
391<div class="oddrow">
392       
393        <div class="method-header">
394                <img src="../media/images/Method.png" />
395                <span class="method-title">save</span> (line <span class="line-number">84</span>)
396        </div>
397       
398        <!-- ========== Info from phpDoc block ========= -->
399<p class="short-description">function save()  Saves the current object into the database.</p>
400        <ul class="tags">
401                                <li><span class="field">access:</span> public</li>
402                        </ul>
403       
404        <div class="method-signature">
405                <span class="method-result">void</span>
406                <span class="method-name">
407                        save
408                </span>
409                                ()
410                        </div>
411       
412               
413                       
414        </div>
415<a name="methodtoSPSS" id="toSPSS"><!-- --></a>
416<div class="evenrow">
417       
418        <div class="method-header">
419                <img src="../media/images/Method.png" />
420                <span class="method-title">toSPSS</span> (line <span class="line-number">216</span>)
421        </div>
422       
423        <!-- ========== Info from phpDoc block ========= -->
424<p class="short-description">function toSPSS</p>
425        <ul class="tags">
426                                <li><span class="field">access:</span> public</li>
427                        </ul>
428       
429        <div class="method-signature">
430                <span class="method-result">void</span>
431                <span class="method-name">
432                        toSPSS
433                </span>
434                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$location</span>)
435                        </div>
436       
437                        <ul class="parameters">
438                                        <li>
439                                <span class="var-type">type</span>
440                                <span class="var-name">$location</span><span class="var-description">: Writes an SPSS parseable file at the given location, named '$datetime_$title.txt'  One big note about toSPSS: If this session contains multiple instances of THE SAME Survey,  the world burns, people die, etcetera. (or, in a more fortunate case, the latest values  are written to the file whilst the others get lost.</span>                       </li>
441                                </ul>
442               
443                       
444        </div>
445                                                        <h4>Inherited Methods</h4>
446                                <a name='inherited_methods'><!-- --></a>       
447                                                                        <!-- =========== Summary =========== -->
448                                        <p>Inherited From <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
449                                        <blockquote>
450                                                                                                        <img src="../media/images/Method.png" alt=" "/>
451                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodcreateArguments">ResearchToolObject::createArguments()</a></span><br>
452                                                                                                        <img src="../media/images/Method.png" alt=" "/>
453                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodevaluate">ResearchToolObject::evaluate()</a></span><br>
454                                                                                                        <img src="../media/images/Method.png" alt=" "/>
455                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodgetUid">ResearchToolObject::getUid()</a></span><br>
456                                                                                                        <img src="../media/images/Method.png" alt=" "/>
457                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodload">ResearchToolObject::load()</a></span><br>
458                                                                                                        <img src="../media/images/Method.png" alt=" "/>
459                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodstripUri">ResearchToolObject::stripUri()</a></span><br>
460                                                                                        </blockquote>
461                                                                               
462                </div>
463        </div>
464
465       
466        <p class="notes" id="credit">
467                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>
468        </p>
469        </div></body>
470</html>
Note: See TracBrowser for help on using the repository browser.