Context Navigation

source: Doc/Backend/PHPDoc/default/RespondentConnector.html @ 160

Last change on this file since 160 was 160, checked in by jkraaijeveld, 13 years ago
Updated documentation Added PHPDoc
File size: 9.6 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 RespondentConnector</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 RespondentConnector</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	<p class="implements">
	25	Implements interfaces:
	26	<ul>
	27	<li><a href="../default/IConnector.html">IConnector</a></li> </ul>
	28	</p>
	29	<!-- ========== Info from phpDoc block ========= -->
	30	<p class="short-description">Description of RespondentConnector</p>
	31	<ul class="tags">
	32	<li><span class="field">author:</span> jkraaijeveld</li>
	33	</ul>
	34	<p class="notes">
	35	Located in <a class="field" href="_RespondentConnector.php.html">/RespondentConnector.php</a> (line <span class="field">12</span>)
	36	</p>
	37
	38
	39	<pre></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	<span class="var-type">mixed</span>
	60	<a href="#$fileName" title="details" class="var-name">$fileName</a>
	61	</div>
	62	</div>
	63	</div>
	64	</div>
	65
	66	<a name="sec-method-summary"></a>
	67	<div class="info-box">
	68	<div class="info-box-title">Method Summary</span></div>
	69	<div class="nav-bar">
	70	<a href="#sec-description">Description</a> \|
	71	<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
	72
	73	\|
	74	<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
	75	</div>
	76	<div class="info-box-body">
	77	<div class="method-summary">
	78
	79	<div class="method-definition">
	80	<span class="method-result">RespondentConnector</span>
	81	<a href="#__construct" title="details" class="method-name">__construct</a>
	82	()
	83	</div>
	84	<div class="method-definition">
	85	<span class="method-result">void</span>
	86	<a href="#get" title="details" class="method-name">get</a>
	87	(<span class="var-type">type</span> <span class="var-name">$arguments</span>)
	88	</div>
	89	<div class="method-definition">
	90	<span class="method-result">void</span>
	91	<a href="#load" title="details" class="method-name">load</a>
	92	()
	93	</div>
	94	<div class="method-definition">
	95	<span class="method-result">void</span>
	96	<a href="#save" title="details" class="method-name">save</a>
	97	()
	98	</div>
	99	<div class="method-definition">
	100	<span class="method-result">void</span>
	101	<a href="#set" title="details" class="method-name">set</a>
	102	(<span class="var-type">type</span> <span class="var-name">$rToolObject</span>)
	103	</div>
	104	</div>
	105	</div>
	106	</div>
	107
	108	<a name="sec-vars"></a>
	109	<div class="info-box">
	110	<div class="info-box-title">Variables</div>
	111	<div class="nav-bar">
	112	<a href="#sec-description">Description</a> \|
	113	<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
	114
	115
	116	\|
	117	<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
	118
	119	</div>
	120	<div class="info-box-body">
	121	<a name="var$fileName" id="$fileName"><!-- --></A>
	122	<div class="evenrow">
	123
	124	<div class="var-header">
	125	<span class="var-title">
	126	<span class="var-type">mixed</span>
	127	<span class="var-name">$fileName</span>
	128	= <span class="var-default"> 'data/users/respondents.rdf'</span> (line <span class="line-number">14</span>)
	129	</span>
	130	</div>
	131
	132	<!-- ========== Info from phpDoc block ========= -->
	133	<ul class="tags">
	134	<li><span class="field">access:</span> protected</li>
	135	</ul>
	136
	137
	138
	139
	140
	141	</div>
	142
	143	</div>
	144	</div>
	145
	146	<a name="sec-methods"></a>
	147	<div class="info-box">
	148	<div class="info-box-title">Methods</div>
	149	<div class="nav-bar">
	150	<a href="#sec-description">Description</a> \|
	151	<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
	152	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
	153
	154	</div>
	155	<div class="info-box-body">
	156	<A NAME='method_detail'></A>
	157
	158	<a name="method__construct" id="__construct"><!-- --></a>
	159	<div class="oddrow">
	160
	161	<div class="method-header">
	162	<span class="method-title">Constructor __construct</span> (line <span class="line-number">19</span>)
	163	</div>
	164
	165	<!-- ========== Info from phpDoc block ========= -->
	166	<p class="short-description">Constructor for RespondentConnector.</p>
	167	<ul class="tags">
	168	<li><span class="field">access:</span> public</li>
	169	</ul>
	170
	171	<div class="method-signature">
	172	<span class="method-result">RespondentConnector</span>
	173	<span class="method-name">
	174	__construct
	175	</span>
	176	()
	177	</div>
	178
	179
	180
	181	</div>
	182	<a name="methodget" id="get"><!-- --></a>
	183	<div class="evenrow">
	184
	185	<div class="method-header">
	186	<span class="method-title">get</span> (line <span class="line-number">51</span>)
	187	</div>
	188
	189	<!-- ========== Info from phpDoc block ========= -->
	190	<p class="short-description">function get() Gets the array of Respondent objects belonging to arguments supplied.</p>
	191	<ul class="tags">
	192	<li><span class="field">access:</span> public</li>
	193	</ul>
	194
	195	<div class="method-signature">
	196	<span class="method-result">void</span>
	197	<span class="method-name">
	198	get
	199	</span>
	200	(<span class="var-type">type</span> <span class="var-name">$arguments</span>)
	201	</div>
	202
	203	<ul class="parameters">
	204	<li>
	205	<span class="var-type">type</span>
	206	<span class="var-name">$arguments</span><span class="var-description">: : An array containing zero or more of the following keys: 'uid', 'name', 'password'</span> </li>
	207	</ul>
	208
	209	<hr class="separator" />
	210	<div class="notes">Implementation of:</div>
	211	<dl>
	212	<dt><a href="../default/IConnector.html#methodget">IConnector::get()</a></dt>
	213	</dl>
	214
	215	</div>
	216	<a name="methodload" id="load"><!-- --></a>
	217	<div class="oddrow">
	218
	219	<div class="method-header">
	220	<span class="method-title">load</span> (line <span class="line-number">29</span>)
	221	</div>
	222
	223	<!-- ========== Info from phpDoc block ========= -->
	224	<p class="short-description">function load() Loads the file into the standard MemModel.</p>
	225	<ul class="tags">
	226	<li><span class="field">access:</span> public</li>
	227	</ul>
	228
	229	<div class="method-signature">
	230	<span class="method-result">void</span>
	231	<span class="method-name">
	232	load
	233	</span>
	234	()
	235	</div>
	236
	237
	238	<hr class="separator" />
	239	<div class="notes">Implementation of:</div>
	240	<dl>
	241	<dt><a href="../default/IConnector.html#methodload">IConnector::load()</a></dt>
	242	</dl>
	243
	244	</div>
	245	<a name="methodsave" id="save"><!-- --></a>
	246	<div class="evenrow">
	247
	248	<div class="method-header">
	249	<span class="method-title">save</span> (line <span class="line-number">41</span>)
	250	</div>
	251
	252	<!-- ========== Info from phpDoc block ========= -->
	253	<p class="short-description">function save() Saves the MemModel into the given file.</p>
	254	<ul class="tags">
	255	<li><span class="field">access:</span> public</li>
	256	</ul>
	257
	258	<div class="method-signature">
	259	<span class="method-result">void</span>
	260	<span class="method-name">
	261	save
	262	</span>
	263	()
	264	</div>
	265
	266
	267	<hr class="separator" />
	268	<div class="notes">Implementation of:</div>
	269	<dl>
	270	<dt><a href="../default/IConnector.html#methodsave">IConnector::save()</a></dt>
	271	</dl>
	272
	273	</div>
	274	<a name="methodset" id="set"><!-- --></a>
	275	<div class="oddrow">
	276
	277	<div class="method-header">
	278	<span class="method-title">set</span> (line <span class="line-number">96</span>)
	279	</div>
	280
	281	<!-- ========== Info from phpDoc block ========= -->
	282	<p class="short-description">function set()</p>
	283	<ul class="tags">
	284	<li><span class="field">access:</span> public</li>
	285	</ul>
	286
	287	<div class="method-signature">
	288	<span class="method-result">void</span>
	289	<span class="method-name">
	290	set
	291	</span>
	292	(<span class="var-type">type</span> <span class="var-name">$rToolObject</span>)
	293	</div>
	294
	295	<ul class="parameters">
	296	<li>
	297	<span class="var-type">type</span>
	298	<span class="var-name">$rToolObject</span><span class="var-description">: : The ResearchToolObject to be saved.</span> </li>
	299	</ul>
	300
	301	<hr class="separator" />
	302	<div class="notes">Implementation of:</div>
	303	<dl>
	304	<dt><a href="../default/IConnector.html#methodset">IConnector::set()</a></dt>
	305	</dl>
	306
	307	</div>
	308
	309	</div>
	310	</div>
	311
	312
	313	<p class="notes" id="credit">
	314	Documentation generated on Fri, 18 Nov 2011 12:57:06 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	315	</p>
	316	</div></body>
	317	</html>

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

Download in other formats: