Context Navigation

source: Doc/Backend/PHPDoc/default/Session.html @ 299

Last change on this file since 299 was 179, checked in by jkraaijeveld, 13 years ago
Updated documentation and PHPDoc
File size: 11.0 KB

Rev	Line
[160]	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">Class Session</h2>
	13
	14	<a name="sec-description"></a>
	15	<div class="info-box">
	16	<div class="info-box-title">Description</div>
	17	<div class="nav-bar">
	18	<span class="disabled">Description</span> \|
	19	<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
	20	\| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
	21
	22	</div>
	23	<div class="info-box-body">
	24	<!-- ========== Info from phpDoc block ========= -->
	25	<p class="short-description">Description of Session</p>
	26	<ul class="tags">
	27	<li><span class="field">author:</span> jkraaijeveld</li>
	28	</ul>
	29	<p class="notes">
	30	Located in <a class="field" href="_Session.php.html">/Session.php</a> (line <span class="field">8</span>)
	31	</p>
	32
	33
	34	<pre><a href="../default/ResearchToolObject.html">ResearchToolObject</a>
	35	\|
	36	--Session</pre>
	37
	38	</div>
	39	</div>
	40
	41
	42
	43	<a name="sec-var-summary"></a>
	44	<div class="info-box">
	45	<div class="info-box-title">Variable Summary</span></div>
	46	<div class="nav-bar">
	47	<a href="#sec-description">Description</a> \|
	48	<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
	49	\|
	50	<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
	51
	52	</div>
	53	<div class="info-box-body">
	54	<div class="var-summary">
	55	<div class="var-title">
	56	<span class="var-type">mixed</span>
	57	<a href="#$answersets" title="details" class="var-name">$answersets</a>
	58	</div>
	59	<div class="var-title">
	60	<span class="var-type">mixed</span>
	61	<a href="#$creator" title="details" class="var-name">$creator</a>
	62	</div>
	63	<div class="var-title">
	64	<span class="var-type">mixed</span>
	65	<a href="#$datetime" title="details" class="var-name">$datetime</a>
	66	</div>
	67	<div class="var-title">
	68	<span class="var-type">mixed</span>
	69	<a href="#$pipeline" title="details" class="var-name">$pipeline</a>
	70	</div>
	71	<div class="var-title">
	72	<span class="var-type">mixed</span>
	73	<a href="#$title" title="details" class="var-name">$title</a>
	74	</div>
	75	</div>
	76	</div>
	77	</div>
	78
	79	<a name="sec-method-summary"></a>
	80	<div class="info-box">
	81	<div class="info-box-title">Method Summary</span></div>
	82	<div class="nav-bar">
	83	<a href="#sec-description">Description</a> \|
	84	<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
	85
	86	\|
	87	<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
	88	</div>
	89	<div class="info-box-body">
	90	<div class="method-summary">
[179]	91
[160]	92	<div class="method-definition">
	93	<span class="method-result">Session</span>
	94	<a href="#__construct" title="details" class="method-name">__construct</a>
	95	([<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">$creator</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$datetime</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$pipeline</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$answersets</span> = <span class="var-default">null</span>])
	96	</div>
[179]	97	<div class="method-definition">
	98	<span class="method-result">void</span>
	99	<a href="#toSPSS" title="details" class="method-name">toSPSS</a>
	100	(<span class="var-type">type</span> <span class="var-name">$location</span>)
	101	</div>
[160]	102	</div>
	103	</div>
	104	</div>
	105
	106	<a name="sec-vars"></a>
	107	<div class="info-box">
	108	<div class="info-box-title">Variables</div>
	109	<div class="nav-bar">
	110	<a href="#sec-description">Description</a> \|
	111	<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
	112
	113
	114	\|
	115	<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
	116
	117	</div>
	118	<div class="info-box-body">
	119	<a name="var$answersets" id="$answersets"><!-- --></A>
[179]	120	<div class="oddrow">
[160]	121
	122	<div class="var-header">
	123	<span class="var-title">
	124	<span class="var-type">mixed</span>
	125	<span class="var-name">$answersets</span>
	126	(line <span class="line-number">14</span>)
	127	</span>
	128	</div>
	129
	130	<!-- ========== Info from phpDoc block ========= -->
	131	<ul class="tags">
	132	<li><span class="field">access:</span> public</li>
	133	</ul>
	134
	135
	136
	137
	138
	139	</div>
	140	<a name="var$creator" id="$creator"><!-- --></A>
[179]	141	<div class="evenrow">
[160]	142
	143	<div class="var-header">
	144	<span class="var-title">
	145	<span class="var-type">mixed</span>
	146	<span class="var-name">$creator</span>
	147	(line <span class="line-number">11</span>)
	148	</span>
	149	</div>
	150
	151	<!-- ========== Info from phpDoc block ========= -->
	152	<ul class="tags">
	153	<li><span class="field">access:</span> public</li>
	154	</ul>
	155
	156
	157
	158
	159
	160	</div>
	161	<a name="var$datetime" id="$datetime"><!-- --></A>
[179]	162	<div class="oddrow">
[160]	163
	164	<div class="var-header">
	165	<span class="var-title">
	166	<span class="var-type">mixed</span>
	167	<span class="var-name">$datetime</span>
	168	(line <span class="line-number">12</span>)
	169	</span>
	170	</div>
	171
	172	<!-- ========== Info from phpDoc block ========= -->
	173	<ul class="tags">
	174	<li><span class="field">access:</span> public</li>
	175	</ul>
	176
	177
	178
	179
	180
	181	</div>
	182	<a name="var$pipeline" id="$pipeline"><!-- --></A>
[179]	183	<div class="evenrow">
[160]	184
	185	<div class="var-header">
	186	<span class="var-title">
	187	<span class="var-type">mixed</span>
	188	<span class="var-name">$pipeline</span>
	189	(line <span class="line-number">13</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	<a name="var$title" id="$title"><!-- --></A>
[179]	204	<div class="oddrow">
[160]	205
	206	<div class="var-header">
	207	<span class="var-title">
	208	<span class="var-type">mixed</span>
	209	<span class="var-name">$title</span>
	210	(line <span class="line-number">10</span>)
	211	</span>
	212	</div>
	213
	214	<!-- ========== Info from phpDoc block ========= -->
	215	<ul class="tags">
	216	<li><span class="field">access:</span> public</li>
	217	</ul>
	218
	219
	220
	221
	222
	223	</div>
	224	<h4>Inherited Variables</h4>
	225	<A NAME='inherited_vars'><!-- --></A>
	226	<p>Inherited from <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
	227	<blockquote>
	228	<span class="var-title">
	229	<span class="var-name"><a href="../default/ResearchToolObject.html#var$uid">ResearchToolObject::$uid</a></span><br>
	230	</span>
	231	</blockquote>
	232
	233	</div>
	234	</div>
	235
	236	<a name="sec-methods"></a>
	237	<div class="info-box">
	238	<div class="info-box-title">Methods</div>
	239	<div class="nav-bar">
	240	<a href="#sec-description">Description</a> \|
	241	<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
	242	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
	243
	244	</div>
	245	<div class="info-box-body">
	246	<A NAME='method_detail'></A>
	247
	248	<a name="method__construct" id="__construct"><!-- --></a>
[179]	249	<div class="evenrow">
[160]	250
	251	<div class="method-header">
	252	<span class="method-title">Constructor __construct</span> (line <span class="line-number">25</span>)
	253	</div>
	254
	255	<!-- ========== Info from phpDoc block ========= -->
	256	<p class="short-description">Constructor for a Session object</p>
	257	<ul class="tags">
	258	<li><span class="field">access:</span> public</li>
	259	</ul>
	260
	261	<div class="method-signature">
	262	<span class="method-result">Session</span>
	263	<span class="method-name">
	264	__construct
	265	</span>
	266	([<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">$creator</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$datetime</span> = <span class="var-default">null</span>], [<span class="var-type">type</span> <span class="var-name">$pipeline</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$answersets</span> = <span class="var-default">null</span>])
	267	</div>
	268
	269	<ul class="parameters">
	270	<li>
	271	<span class="var-type">type</span>
	272	<span class="var-name">$uid</span> </li>
	273	<li>
	274	<span class="var-type">type</span>
	275	<span class="var-name">$title</span> </li>
	276	<li>
	277	<span class="var-type">type</span>
	278	<span class="var-name">$creator</span> </li>
	279	<li>
	280	<span class="var-type">type</span>
	281	<span class="var-name">$datetime</span> </li>
	282	<li>
	283	<span class="var-type">type</span>
	284	<span class="var-name">$pipeline</span> </li>
	285	<li>
	286	<span class="var-type"></span>
	287	<span class="var-name">$answersets</span> </li>
	288	</ul>
	289
	290
	291	</div>
[179]	292	<a name="methodtoSPSS" id="toSPSS"><!-- --></a>
	293	<div class="oddrow">
	294
	295	<div class="method-header">
	296	<span class="method-title">toSPSS</span> (line <span class="line-number">47</span>)
	297	</div>
	298
	299	<!-- ========== Info from phpDoc block ========= -->
	300	<p class="short-description">function toSPSS</p>
	301	<ul class="tags">
	302	<li><span class="field">access:</span> public</li>
	303	</ul>
	304
	305	<div class="method-signature">
	306	<span class="method-result">void</span>
	307	<span class="method-name">
	308	toSPSS
	309	</span>
	310	(<span class="var-type">type</span> <span class="var-name">$location</span>)
	311	</div>
	312
	313	<ul class="parameters">
	314	<li>
	315	<span class="var-type">type</span>
	316	<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>
	317	</ul>
	318
	319
	320	</div>
[160]	321
	322	</div>
	323	</div>
	324
	325
	326	<p class="notes" id="credit">
[179]	327	Documentation generated on Fri, 09 Dec 2011 09:33:27 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
[160]	328	</p>
	329	</div></body>
	330	</html>

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

Download in other formats: