Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

SessionInstance.html @ 451

Last change on this file since 451 was 301, checked in by jkraaijeveld, 13 years ago
Added new PHPDoc :D
File size: 22.7 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 SessionInstance</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"> SessionInstance</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 SessionInstance</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---SessionInstance.php.html">/models/SessionInstance.php</a> (line <span class="field">13</span>)
34	</p>
35
36
37	<pre><a href="../default/ResearchToolObject.html">ResearchToolObject</a>
38	\|
39	--SessionInstance</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="#$applicationinstances" title="details" class="var-name">$applicationinstances</a>
67	</div>
68	<div class="var-title">
69	<img src="../media/images/Variable.png" alt=" " />
70	<span class="var-type">mixed</span>
71	<a href="#$endtime" title="details" class="var-name">$endtime</a>
72	</div>
73	<div class="var-title">
74	<img src="../media/images/Variable.png" alt=" " />
75	<span class="var-type">mixed</span>
76	<a href="#$facilitator" title="details" class="var-name">$facilitator</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="#$location" title="details" class="var-name">$location</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="#$notes" title="details" class="var-name">$notes</a>
87	</div>
88	<div class="var-title">
89	<img src="../media/images/Variable.png" alt=" " />
90	<span class="var-type">mixed</span>
91	<a href="#$session" title="details" class="var-name">$session</a>
92	</div>
93	<div class="var-title">
94	<img src="../media/images/Variable.png" alt=" " />
95	<span class="var-type">mixed</span>
96	<a href="#$starttime" title="details" class="var-name">$starttime</a>
97	</div>
98	<div class="var-title">
99	<img src="../media/images/Variable.png" alt=" " />
100	<span class="var-type">mixed</span>
101	<a href="#$surveyinstances" title="details" class="var-name">$surveyinstances</a>
102	</div>
103	<div class="var-title">
104	<img src="../media/images/Variable.png" alt=" " />
105	<span class="var-type">mixed</span>
106	<a href="#$title" title="details" class="var-name">$title</a>
107	</div>
108	</div>
109	</div>
110	</div>
111
112	<a name="sec-method-summary"></a>
113	<div class="info-box">
114	<div class="info-box-title">Method Summary</span></div>
115	<div class="nav-bar">
116	<a href="#sec-description">Description</a> \|
117	<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
118
119	\|
120	<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
121	</div>
122	<div class="info-box-body">
123	<div class="method-summary">
124	<div class="method-definition">
125	<img src="../media/images/StaticMethod.png" alt=" "/>
126	static <span class="method-result">void</span>
127	<a href="#create" title="details" class="method-name">create</a>
128	(<span class="var-type"></span> <span class="var-name">$obj</span>)
129	</div>
130	<div class="method-definition">
131	<img src="../media/images/StaticMethod.png" alt=" "/>
132	static <span class="method-result">void</span>
133	<a href="#get" title="details" class="method-name">get</a>
134	(<span class="var-type">type</span> <span class="var-name">$arguments</span>)
135	</div>
136	<div class="method-definition">
137	<img src="../media/images/StaticMethod.png" alt=" "/>
138	static <span class="method-result">void</span>
139	<a href="#getFields" title="details" class="method-name">getFields</a>
140	(<span class="var-type"></span> <span class="var-name">$model</span>, <span class="var-type"></span> <span class="var-name">$uid</span>)
141	</div>
142	<div class="method-definition">
143	<img src="../media/images/Constructor.png" alt=" "/>
144	<span class="method-result">SessionInstance</span>
145	<a href="#__construct" title="details" class="method-name">__construct</a>
146	([<span class="var-type">type</span> <span class="var-name">$uid</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$title</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$location</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$facilitator</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$starttime</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$endtime</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$notes</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$session</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$surveyinstances</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$applicationinstances</span> = <span class="var-default">null</span>])
147	</div>
148	<div class="method-definition">
149	<img src="../media/images/Method.png" alt=" "/>
150	<span class="method-result">void</span>
151	<a href="#evaluate" title="details" class="method-name">evaluate</a>
152	()
153	</div>
154	<div class="method-definition">
155	<img src="../media/images/Method.png" alt=" "/>
156	<span class="method-result">void</span>
157	<a href="#save" title="details" class="method-name">save</a>
158	()
159	</div>
160	</div>
161	</div>
162	</div>
163
164	<a name="sec-vars"></a>
165	<div class="info-box">
166	<div class="info-box-title">Variables</div>
167	<div class="nav-bar">
168	<a href="#sec-description">Description</a> \|
169	<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
170
171
172	\|
173	<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
174
175	</div>
176	<div class="info-box-body">
177	<a name="var$filename" id="$filename"><!-- --></A>
178	<div class="oddrow">
179
180	<div class="var-header">
181	<img src="../media/images/Variable.png" />
182	<span class="var-title">
183	static <span class="var-type">mixed</span>
184	<span class="var-name">$filename</span>
185	= <span class="var-default"> 'data/sessions/sessioninstances.rdf'</span> (line <span class="line-number">15</span>)
186	</span>
187	</div>
188
189	<!-- ========== Info from phpDoc block ========= -->
190	<ul class="tags">
191	<li><span class="field">access:</span> public</li>
192	</ul>
193
194
195
196
197
198	</div>
199
200	<a name="var$applicationinstances" id="$applicationinstances"><!-- --></A>
201	<div class="evenrow">
202
203	<div class="var-header">
204	<img src="../media/images/Variable.png" />
205	<span class="var-title">
206	<span class="var-type">mixed</span>
207	<span class="var-name">$applicationinstances</span>
208	(line <span class="line-number">25</span>)
209	</span>
210	</div>
211
212	<!-- ========== Info from phpDoc block ========= -->
213	<ul class="tags">
214	<li><span class="field">access:</span> public</li>
215	</ul>
216
217
218
219
220
221	</div>
222	<a name="var$endtime" id="$endtime"><!-- --></A>
223	<div class="oddrow">
224
225	<div class="var-header">
226	<img src="../media/images/Variable.png" />
227	<span class="var-title">
228	<span class="var-type">mixed</span>
229	<span class="var-name">$endtime</span>
230	(line <span class="line-number">21</span>)
231	</span>
232	</div>
233
234	<!-- ========== Info from phpDoc block ========= -->
235	<ul class="tags">
236	<li><span class="field">access:</span> public</li>
237	</ul>
238
239
240
241
242
243	</div>
244	<a name="var$facilitator" id="$facilitator"><!-- --></A>
245	<div class="evenrow">
246
247	<div class="var-header">
248	<img src="../media/images/Variable.png" />
249	<span class="var-title">
250	<span class="var-type">mixed</span>
251	<span class="var-name">$facilitator</span>
252	(line <span class="line-number">19</span>)
253	</span>
254	</div>
255
256	<!-- ========== Info from phpDoc block ========= -->
257	<ul class="tags">
258	<li><span class="field">access:</span> public</li>
259	</ul>
260
261
262
263
264
265	</div>
266	<a name="var$location" id="$location"><!-- --></A>
267	<div class="oddrow">
268
269	<div class="var-header">
270	<img src="../media/images/Variable.png" />
271	<span class="var-title">
272	<span class="var-type">mixed</span>
273	<span class="var-name">$location</span>
274	(line <span class="line-number">18</span>)
275	</span>
276	</div>
277
278	<!-- ========== Info from phpDoc block ========= -->
279	<ul class="tags">
280	<li><span class="field">access:</span> public</li>
281	</ul>
282
283
284
285
286
287	</div>
288	<a name="var$notes" id="$notes"><!-- --></A>
289	<div class="evenrow">
290
291	<div class="var-header">
292	<img src="../media/images/Variable.png" />
293	<span class="var-title">
294	<span class="var-type">mixed</span>
295	<span class="var-name">$notes</span>
296	(line <span class="line-number">22</span>)
297	</span>
298	</div>
299
300	<!-- ========== Info from phpDoc block ========= -->
301	<ul class="tags">
302	<li><span class="field">access:</span> public</li>
303	</ul>
304
305
306
307
308
309	</div>
310	<a name="var$session" id="$session"><!-- --></A>
311	<div class="oddrow">
312
313	<div class="var-header">
314	<img src="../media/images/Variable.png" />
315	<span class="var-title">
316	<span class="var-type">mixed</span>
317	<span class="var-name">$session</span>
318	(line <span class="line-number">23</span>)
319	</span>
320	</div>
321
322	<!-- ========== Info from phpDoc block ========= -->
323	<ul class="tags">
324	<li><span class="field">access:</span> public</li>
325	</ul>
326
327
328
329
330
331	</div>
332	<a name="var$starttime" id="$starttime"><!-- --></A>
333	<div class="evenrow">
334
335	<div class="var-header">
336	<img src="../media/images/Variable.png" />
337	<span class="var-title">
338	<span class="var-type">mixed</span>
339	<span class="var-name">$starttime</span>
340	(line <span class="line-number">20</span>)
341	</span>
342	</div>
343
344	<!-- ========== Info from phpDoc block ========= -->
345	<ul class="tags">
346	<li><span class="field">access:</span> public</li>
347	</ul>
348
349
350
351
352
353	</div>
354	<a name="var$surveyinstances" id="$surveyinstances"><!-- --></A>
355	<div class="oddrow">
356
357	<div class="var-header">
358	<img src="../media/images/Variable.png" />
359	<span class="var-title">
360	<span class="var-type">mixed</span>
361	<span class="var-name">$surveyinstances</span>
362	(line <span class="line-number">24</span>)
363	</span>
364	</div>
365
366	<!-- ========== Info from phpDoc block ========= -->
367	<ul class="tags">
368	<li><span class="field">access:</span> public</li>
369	</ul>
370
371
372
373
374
375	</div>
376	<a name="var$title" id="$title"><!-- --></A>
377	<div class="evenrow">
378
379	<div class="var-header">
380	<img src="../media/images/Variable.png" />
381	<span class="var-title">
382	<span class="var-type">mixed</span>
383	<span class="var-name">$title</span>
384	(line <span class="line-number">17</span>)
385	</span>
386	</div>
387
388	<!-- ========== Info from phpDoc block ========= -->
389	<ul class="tags">
390	<li><span class="field">access:</span> public</li>
391	</ul>
392
393
394
395
396
397	</div>
398	<h4>Inherited Variables</h4>
399	<A NAME='inherited_vars'><!-- --></A>
400	<p>Inherited from <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
401	<blockquote>
402	<img src="../media/images/Variable.png" />
403	<span class="var-title">
404	<span class="var-name"><a href="../default/ResearchToolObject.html#var$uid">ResearchToolObject::$uid</a></span><br>
405	</span>
406	</blockquote>
407
408	</div>
409	</div>
410
411	<a name="sec-methods"></a>
412	<div class="info-box">
413	<div class="info-box-title">Methods</div>
414	<div class="nav-bar">
415	<a href="#sec-description">Description</a> \|
416	<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
417	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
418
419	</div>
420	<div class="info-box-body">
421	<A NAME='method_detail'></A>
422	<a name="methodcreate" id="create"><!-- --></a>
423	<div class="oddrow">
424
425	<div class="method-header">
426	<img src="../media/images/StaticMethod.png" />
427	<span class="method-title">static create</span> (line <span class="line-number">282</span>)
428	</div>
429
430	<!-- ========== Info from phpDoc block ========= -->
431	<ul class="tags">
432	<li><span class="field">access:</span> public</li>
433	</ul>
434
435	<div class="method-signature">
436	<span class="method-result">void</span>
437	<span class="method-name">
438	create
439	</span>
440	(<span class="var-type"></span> <span class="var-name">$obj</span>)
441	</div>
442
443	<ul class="parameters">
444	<li>
445	<span class="var-type"></span>
446	<span class="var-name">$obj</span> </li>
447	</ul>
448
449
450	</div>
451	<a name="methodget" id="get"><!-- --></a>
452	<div class="evenrow">
453
454	<div class="method-header">
455	<img src="../media/images/StaticMethod.png" />
456	<span class="method-title">static get</span> (line <span class="line-number">205</span>)
457	</div>
458
459	<!-- ========== Info from phpDoc block ========= -->
460	<p class="short-description">function get()</p>
461	<ul class="tags">
462	<li><span class="field">access:</span> public</li>
463	</ul>
464
465	<div class="method-signature">
466	<span class="method-result">void</span>
467	<span class="method-name">
468	get
469	</span>
470	(<span class="var-type">type</span> <span class="var-name">$arguments</span>)
471	</div>
472
473	<ul class="parameters">
474	<li>
475	<span class="var-type">type</span>
476	<span class="var-name">$arguments</span><span class="var-description">: : An array containing one or more of the following elements: 'uid', 'title', 'location', 'facilitator', 'starttime', 'endtime' 'notes', 'session', 'applicationinstances', 'surveyinstances'</span> </li>
477	</ul>
478
479
480	</div>
481	<a name="methodgetFields" id="getFields"><!-- --></a>
482	<div class="oddrow">
483
484	<div class="method-header">
485	<img src="../media/images/StaticMethod.png" />
486	<span class="method-title">static getFields</span> (line <span class="line-number">262</span>)
487	</div>
488
489	<!-- ========== Info from phpDoc block ========= -->
490	<p class="short-description">function getFields() param type $uid : The SessionInstance uid for which the fields should be retrieved.</p>
491	<p class="description"><p>returns : An array with [0] => all notes, [1] => all SurveyInstances and [2] => all ApplicationInstances.</p></p>
492	<ul class="tags">
493	<li><span class="field">access:</span> public</li>
494	</ul>
495
496	<div class="method-signature">
497	<span class="method-result">void</span>
498	<span class="method-name">
499	getFields
500	</span>
501	(<span class="var-type"></span> <span class="var-name">$model</span>, <span class="var-type"></span> <span class="var-name">$uid</span>)
502	</div>
503
504	<ul class="parameters">
505	<li>
506	<span class="var-type"></span>
507	<span class="var-name">$model</span> </li>
508	<li>
509	<span class="var-type"></span>
510	<span class="var-name">$uid</span> </li>
511	</ul>
512
513
514	</div>
515	<a name="method__construct" id="__construct"><!-- --></a>
516	<div class="evenrow">
517
518	<div class="method-header">
519	<img src="../media/images/Constructor.png" />
520	<span class="method-title">Constructor __construct</span> (line <span class="line-number">40</span>)
521	</div>
522
523	<!-- ========== Info from phpDoc block ========= -->
524	<p class="short-description">Constructor for a SessionInstance object</p>
525	<ul class="tags">
526	<li><span class="field">access:</span> public</li>
527	</ul>
528
529	<div class="method-signature">
530	<span class="method-result">SessionInstance</span>
531	<span class="method-name">
532	__construct
533	</span>
534	([<span class="var-type">type</span> <span class="var-name">$uid</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$title</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$location</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$facilitator</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$starttime</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$endtime</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$notes</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$session</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$surveyinstances</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$applicationinstances</span> = <span class="var-default">null</span>])
535	</div>
536
537	<ul class="parameters">
538	<li>
539	<span class="var-type">type</span>
540	<span class="var-name">$uid</span> </li>
541	<li>
542	<span class="var-type">type</span>
543	<span class="var-name">$title</span> </li>
544	<li>
545	<span class="var-type">type</span>
546	<span class="var-name">$location</span> </li>
547	<li>
548	<span class="var-type">type</span>
549	<span class="var-name">$facilitator</span> </li>
550	<li>
551	<span class="var-type">type</span>
552	<span class="var-name">$starttime</span> </li>
553	<li>
554	<span class="var-type">type</span>
555	<span class="var-name">$endtime</span> </li>
556	<li>
557	<span class="var-type">type</span>
558	<span class="var-name">$notes</span> </li>
559	<li>
560	<span class="var-type">type</span>
561	<span class="var-name">$session</span> </li>
562	<li>
563	<span class="var-type">type</span>
564	<span class="var-name">$surveyinstances</span> </li>
565	<li>
566	<span class="var-type">type</span>
567	<span class="var-name">$applicationinstances</span> </li>
568	</ul>
569
570
571	</div>
572	<a name="methodevaluate" id="evaluate"><!-- --></a>
573	<div class="oddrow">
574
575	<div class="method-header">
576	<img src="../media/images/Method.png" />
577	<span class="method-title">evaluate</span> (line <span class="line-number">62</span>)
578	</div>
579
580	<!-- ========== Info from phpDoc block ========= -->
581	<ul class="tags">
582	<li><span class="field">access:</span> public</li>
583	</ul>
584
585	<div class="method-signature">
586	<span class="method-result">void</span>
587	<span class="method-name">
588	evaluate
589	</span>
590	()
591	</div>
592
593
594	<hr class="separator" />
595	<div class="notes">Redefinition of:</div>
596	<dl>
597	<dt><a href="../default/ResearchToolObject.html#methodevaluate">ResearchToolObject::evaluate()</a></dt>
598	</dl>
599
600	</div>
601	<a name="methodsave" id="save"><!-- --></a>
602	<div class="evenrow">
603
604	<div class="method-header">
605	<img src="../media/images/Method.png" />
606	<span class="method-title">save</span> (line <span class="line-number">115</span>)
607	</div>
608
609	<!-- ========== Info from phpDoc block ========= -->
610	<p class="short-description">function save() Saves the current object into the database.</p>
611	<ul class="tags">
612	<li><span class="field">access:</span> public</li>
613	</ul>
614
615	<div class="method-signature">
616	<span class="method-result">void</span>
617	<span class="method-name">
618	save
619	</span>
620	()
621	</div>
622
623
624
625	</div>
626	<h4>Inherited Methods</h4>
627	<a name='inherited_methods'><!-- --></a>
628	<!-- =========== Summary =========== -->
629	<p>Inherited From <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
630	<blockquote>
631	<img src="../media/images/Method.png" alt=" "/>
632	<span class="method-name"><a href="../default/ResearchToolObject.html#methodcreateArguments">ResearchToolObject::createArguments()</a></span><br>
633	<img src="../media/images/Method.png" alt=" "/>
634	<span class="method-name"><a href="../default/ResearchToolObject.html#methodevaluate">ResearchToolObject::evaluate()</a></span><br>
635	<img src="../media/images/Method.png" alt=" "/>
636	<span class="method-name"><a href="../default/ResearchToolObject.html#methodgetUid">ResearchToolObject::getUid()</a></span><br>
637	<img src="../media/images/Method.png" alt=" "/>
638	<span class="method-name"><a href="../default/ResearchToolObject.html#methodload">ResearchToolObject::load()</a></span><br>
639	<img src="../media/images/Method.png" alt=" "/>
640	<span class="method-name"><a href="../default/ResearchToolObject.html#methodstripUri">ResearchToolObject::stripUri()</a></span><br>
641	</blockquote>
642
643	</div>
644	</div>
645
646
647	<p class="notes" id="credit">
648	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>
649	</p>
650	</div></body>
651	</html>

Note: See TracBrowser for help on using the repository browser.

Context Navigation

source: Doc/Backend/PHPDoc/default/SessionInstance.html @ 451

Download in other formats: