Startsida Utforska Hjälp
Registrera dig Logga in
Ayuda_Virtual
/
sloodle_website
2
0
Fork 0
Filer Ärenden 0 Pull-förfrågningar 0 Wiki
Gren: master
Grenar Taggar
sloodle_webs...
/
webroot
/
phpdocs
/
0.21
/
sloodle
/
SloodleLSLResponse.html

SloodleLSLResponse.html 50 KB
Permalänk Historik Rå

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219 
  1. <?xml version="1.0" encoding="iso-8859-1"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3.   <html xmlns="http://www.w3.org/1999/xhtml">
    4. 

  4. 		<head>
    5. 

  5. 			<!-- template designed by Marco Von Ballmoos  -->
    6. 

  6. 			<title>Docs For Class SloodleLSLResponse</title>
    7. 

  7. 			<link rel="stylesheet" href="../media/stylesheet.css" />
    8. 

  8. 						<script src="../media/lib/classTree.js"></script>
    9. 

  9. 												<script language="javascript" type="text/javascript">
    10. 

  10. 				var imgPlus = new Image();
    11. 

  11. 				var imgMinus = new Image();
    12. 

  12. 				imgPlus.src = "../media/images/plus.png";
    13. 

  13. 				imgMinus.src = "../media/images/minus.png";
    14. 

  14. 				
    15. 

  15. 				function showNode(Node){
    16. 

  16. 							switch(navigator.family){
    17. 

  17. 								case 'nn4':
    18. 

  18. 									// Nav 4.x code fork...
    19. 

  19. 							var oTable = document.layers["span" + Node];
    20. 

  20. 							var oImg = document.layers["img" + Node];
    21. 

  21. 									break;
    22. 

  22. 								case 'ie4':
    23. 

  23. 									// IE 4/5 code fork...
    24. 

  24. 							var oTable = document.all["span" + Node];
    25. 

  25. 							var oImg = document.all["img" + Node];
    26. 

  26. 									break;
    27. 

  27. 								case 'gecko':
    28. 

  28. 									// Standards Compliant code fork...
    29. 

  29. 							var oTable = document.getElementById("span" + Node);
    30. 

  30. 							var oImg = document.getElementById("img" + Node);
    31. 

  31. 									break;
    32. 

  32. 							}
    33. 

  33. 					oImg.src = imgMinus.src;
    34. 

  34. 					oTable.style.display = "block";
    35. 

  35. 				}
    36. 

  36. 				
    37. 

  37. 				function hideNode(Node){
    38. 

  38. 							switch(navigator.family){
    39. 

  39. 								case 'nn4':
    40. 

  40. 									// Nav 4.x code fork...
    41. 

  41. 							var oTable = document.layers["span" + Node];
    42. 

  42. 							var oImg = document.layers["img" + Node];
    43. 

  43. 									break;
    44. 

  44. 								case 'ie4':
    45. 

  45. 									// IE 4/5 code fork...
    46. 

  46. 							var oTable = document.all["span" + Node];
    47. 

  47. 							var oImg = document.all["img" + Node];
    48. 

  48. 									break;
    49. 

  49. 								case 'gecko':
    50. 

  50. 									// Standards Compliant code fork...
    51. 

  51. 							var oTable = document.getElementById("span" + Node);
    52. 

  52. 							var oImg = document.getElementById("img" + Node);
    53. 

  53. 									break;
    54. 

  54. 							}
    55. 

  55. 					oImg.src = imgPlus.src;
    56. 

  56. 					oTable.style.display = "none";
    57. 

  57. 				}
    58. 

  58. 				
    59. 

  59. 				function nodeIsVisible(Node){
    60. 

  60. 							switch(navigator.family){
    61. 

  61. 								case 'nn4':
    62. 

  62. 									// Nav 4.x code fork...
    63. 

  63. 							var oTable = document.layers["span" + Node];
    64. 

  64. 									break;
    65. 

  65. 								case 'ie4':
    66. 

  66. 									// IE 4/5 code fork...
    67. 

  67. 							var oTable = document.all["span" + Node];
    68. 

  68. 									break;
    69. 

  69. 								case 'gecko':
    70. 

  70. 									// Standards Compliant code fork...
    71. 

  71. 							var oTable = document.getElementById("span" + Node);
    72. 

  72. 									break;
    73. 

  73. 							}
    74. 

  74. 					return (oTable && oTable.style.display == "block");
    75. 

  75. 				}
    76. 

  76. 				
    77. 

  77. 				function toggleNodeVisibility(Node){
    78. 

  78. 					if (nodeIsVisible(Node)){
    79. 

  79. 						hideNode(Node);
    80. 

  80. 					}else{
    81. 

  81. 						showNode(Node);
    82. 

  82. 					}
    83. 

  83. 				}
    84. 

  84. 			</script>
    85. 

  85. 					</head>
    86. 

  86. 		<body>
    87. 

  87. 			<div class="page-body">			
    88. 

  88. <h2 class="class-name"><img src="../media/images/Class_logo.png"
    89. 

  89. 														alt=" Class"
    90. 

  90. 														title=" Class"
    91. 

  91. 														style="vertical-align: middle"> SloodleLSLResponse</h2>
    92. 

  92. 

  93. <a name="sec-description"></a>
    94. 

  94. <div class="info-box">
    95. 

  95. 	<div class="info-box-title">Description</div>
    96. 

  96. 	<div class="nav-bar">
    97. 

  97. 					<span class="disabled">Description</span> |
    98. 

  98. 													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    99. 

  99. 						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    100. 

  100. 						
    101. 

  101. 					</div>
    102. 

  102. 	<div class="info-box-body">
    103. 

  103.         		<!-- ========== Info from phpDoc block ========= -->
    104. 

  104. <p class="short-description">A helper class to validate and structure data for output according to the <a href="http://slisweb.sjsu.edu/sl/index.php/Sloodle_communications_specification">Sloodle communications specification</a>.</p>
    105. 

  105. 	<ul class="tags">
    106. 

  106. 				<li><span class="field">usedby:</span> <a href="../sloodle/SloodleLSLRequest.html">SloodleLSLRequest</a> - Outputs error messages in appropriate format if an error occurs.</li>
    107. 

  107. 			</ul>
    108. 

  108. 		<p class="notes">
    109. 

  109. 			Located in <a class="field" href="_lib---sl_iolib.php.html">/lib/sl_iolib.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a41">41</a></span>)
    110. 

  110. 		</p>
    111. 

  111. 		
    112. 

  112. 				
    113. 

  113. 		<pre></pre>
    114. 

  114. 	
    115. 

  115. 			</div>
    116. 

  116. </div>
    117. 

  117. 

  118. 

  119. 

  120. 	<a name="sec-var-summary"></a>
    121. 

  121. 	<div class="info-box">
    122. 

  122. 		<div class="info-box-title">Variable Summary</span></div>
    123. 

  123. 		<div class="nav-bar">
    124. 

  124. 			<a href="#sec-description">Description</a> |
    125. 

  125. 						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
    126. 

  126. 							| 
    127. 

  127. 									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    128. 

  128. 							
    129. 

  129. 								</div>
    130. 

  130. 		<div class="info-box-body">
    131. 

  131. 			<div class="var-summary">
    132. 

  132. 																																																																																																								<div class="var-title">
    133. 

  133. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    134. 

  134. 					<span class="var-type">mixed</span>
    135. 

  135. 					<a href="#$data" title="details" class="var-name">$data</a>
    136. 

  136. 				</div>
    137. 

  137. 																<div class="var-title">
    138. 

  138. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    139. 

  139. 					<span class="var-type">integer</span>
    140. 

  140. 					<a href="#$page_number" title="details" class="var-name">$page_number</a>
    141. 

  141. 				</div>
    142. 

  142. 																<div class="var-title">
    143. 

  143. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    144. 

  144. 					<span class="var-type">integer</span>
    145. 

  145. 					<a href="#$page_total" title="details" class="var-name">$page_total</a>
    146. 

  146. 				</div>
    147. 

  147. 																<div class="var-title">
    148. 

  148. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    149. 

  149. 					<span class="var-type">string</span>
    150. 

  150. 					<a href="#$request_descriptor" title="details" class="var-name">$request_descriptor</a>
    151. 

  151. 				</div>
    152. 

  152. 																<div class="var-title">
    153. 

  153. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    154. 

  154. 					<span class="var-type">integer</span>
    155. 

  155. 					<a href="#$request_timestamp" title="details" class="var-name">$request_timestamp</a>
    156. 

  156. 				</div>
    157. 

  157. 																<div class="var-title">
    158. 

  158. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    159. 

  159. 					<span class="var-type">integer</span>
    160. 

  160. 					<a href="#$response_timestamp" title="details" class="var-name">$response_timestamp</a>
    161. 

  161. 				</div>
    162. 

  162. 																<div class="var-title">
    163. 

  163. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    164. 

  164. 					<span class="var-type">mixed</span>
    165. 

  165. 					<a href="#$side_effects" title="details" class="var-name">$side_effects</a>
    166. 

  166. 				</div>
    167. 

  167. 																<div class="var-title">
    168. 

  168. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    169. 

  169. 					<span class="var-type">int</span>
    170. 

  170. 					<a href="#$status_code" title="details" class="var-name">$status_code</a>
    171. 

  171. 				</div>
    172. 

  172. 																<div class="var-title">
    173. 

  173. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    174. 

  174. 					<span class="var-type">string</span>
    175. 

  175. 					<a href="#$status_descriptor" title="details" class="var-name">$status_descriptor</a>
    176. 

  176. 				</div>
    177. 

  177. 																<div class="var-title">
    178. 

  178. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    179. 

  179. 					<span class="var-type">mixed</span>
    180. 

  180. 					<a href="#$tracking_code" title="details" class="var-name">$tracking_code</a>
    181. 

  181. 				</div>
    182. 

  182. 																<div class="var-title">
    183. 

  183. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    184. 

  184. 					<span class="var-type">string</span>
    185. 

  185. 					<a href="#$user_key" title="details" class="var-name">$user_key</a>
    186. 

  186. 				</div>
    187. 

  187. 											</div>
    188. 

  188. 		</div>
    189. 

  189. 	</div>
    190. 

  190. 

  191. 	<a name="sec-method-summary"></a>
    192. 

  192. 	<div class="info-box">
    193. 

  193. 		<div class="info-box-title">Method Summary</span></div>
    194. 

  194. 		<div class="nav-bar">
    195. 

  195. 			<a href="#sec-description">Description</a> |
    196. 

  196. 																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    197. 

  197. 				 
    198. 

  198. 				|
    199. 

  199. 						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
    200. 

  200. 		</div>
    201. 

  201. 		<div class="info-box-body">			
    202. 

  202. 			<div class="method-summary">
    203. 

  203. 																																																																																																																																																																															
    204. 

  204. 				<div class="method-definition">
    205. 

  205. 					<img src="../media/images/Constructor.png" alt=" "/>
    206. 

  206. 											<span class="method-result">void</span>
    207. 

  207. 										<a href="#SloodleLSLResponse" title="details" class="method-name">SloodleLSLResponse</a>
    208. 

  208. 											([<span class="var-type">int</span>&nbsp;<span class="var-name">$status_code</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$status_descriptor</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">NULL</span>])
    209. 

  209. 									</div>
    210. 

  210. 															
    211. 

  211. 				<div class="method-definition">
    212. 

  212. 					<img src="../media/images/Method.png" alt=" "/>
    213. 

  213. 											<span class="method-result">void</span>
    214. 

  214. 										<a href="#add_data_line" title="details" class="method-name">add_data_line</a>
    215. 

  215. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    216. 

  216. 									</div>
    217. 

  217. 															
    218. 

  218. 				<div class="method-definition">
    219. 

  219. 					<img src="../media/images/Method.png" alt=" "/>
    220. 

  220. 											<span class="method-result">void</span>
    221. 

  221. 										<a href="#add_side_effect" title="details" class="method-name">add_side_effect</a>
    222. 

  222. 											(<span class="var-type">integer</span>&nbsp;<span class="var-name">$par</span>)
    223. 

  223. 									</div>
    224. 

  224. 															
    225. 

  225. 				<div class="method-definition">
    226. 

  226. 					<img src="../media/images/Method.png" alt=" "/>
    227. 

  227. 											<span class="method-result">void</span>
    228. 

  228. 										<a href="#add_side_effects" title="details" class="method-name">add_side_effects</a>
    229. 

  229. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    230. 

  230. 									</div>
    231. 

  231. 															
    232. 

  232. 				<div class="method-definition">
    233. 

  233. 					<img src="../media/images/Method.png" alt=" "/>
    234. 

  234. 											<span class="method-result">void</span>
    235. 

  235. 										<a href="#clear_data" title="details" class="method-name">clear_data</a>
    236. 

  236. 										()
    237. 

  237. 									</div>
    238. 

  238. 															
    239. 

  239. 				<div class="method-definition">
    240. 

  240. 					<img src="../media/images/Method.png" alt=" "/>
    241. 

  241. 											<span class="method-result">void</span>
    242. 

  242. 										<a href="#quick_output" title="details" class="method-name">quick_output</a>
    243. 

  243. 											(<span class="var-type">int</span>&nbsp;<span class="var-name">$status_code</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$status_descriptor</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">NULL</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$static</span> = <span class="var-default">TRUE</span>])
    244. 

  244. 									</div>
    245. 

  245. 															
    246. 

  246. 				<div class="method-definition">
    247. 

  247. 					<img src="../media/images/Method.png" alt=" "/>
    248. 

  248. 											<span class="method-result">void</span>
    249. 

  249. 										<a href="#render_to_output" title="details" class="method-name">render_to_output</a>
    250. 

  250. 										()
    251. 

  251. 									</div>
    252. 

  252. 															
    253. 

  253. 				<div class="method-definition">
    254. 

  254. 					<img src="../media/images/Method.png" alt=" "/>
    255. 

  255. 											<span class="method-result">void</span>
    256. 

  256. 										<a href="#render_to_string" title="details" class="method-name">render_to_string</a>
    257. 

  257. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">&$str</span>)
    258. 

  258. 									</div>
    259. 

  259. 															
    260. 

  260. 				<div class="method-definition">
    261. 

  261. 					<img src="../media/images/Method.png" alt=" "/>
    262. 

  262. 											<span class="method-result">void</span>
    263. 

  263. 										<a href="#set_data" title="details" class="method-name">set_data</a>
    264. 

  264. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    265. 

  265. 									</div>
    266. 

  266. 															
    267. 

  267. 				<div class="method-definition">
    268. 

  268. 					<img src="../media/images/Method.png" alt=" "/>
    269. 

  269. 											<span class="method-result">void</span>
    270. 

  270. 										<a href="#set_page_number" title="details" class="method-name">set_page_number</a>
    271. 

  271. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    272. 

  272. 									</div>
    273. 

  273. 															
    274. 

  274. 				<div class="method-definition">
    275. 

  275. 					<img src="../media/images/Method.png" alt=" "/>
    276. 

  276. 											<span class="method-result">void</span>
    277. 

  277. 										<a href="#set_page_total" title="details" class="method-name">set_page_total</a>
    278. 

  278. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    279. 

  279. 									</div>
    280. 

  280. 															
    281. 

  281. 				<div class="method-definition">
    282. 

  282. 					<img src="../media/images/Method.png" alt=" "/>
    283. 

  283. 											<span class="method-result">void</span>
    284. 

  284. 										<a href="#set_request_descriptor" title="details" class="method-name">set_request_descriptor</a>
    285. 

  285. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    286. 

  286. 									</div>
    287. 

  287. 															
    288. 

  288. 				<div class="method-definition">
    289. 

  289. 					<img src="../media/images/Method.png" alt=" "/>
    290. 

  290. 											<span class="method-result">void</span>
    291. 

  291. 										<a href="#set_request_timestamp" title="details" class="method-name">set_request_timestamp</a>
    292. 

  292. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    293. 

  293. 									</div>
    294. 

  294. 															
    295. 

  295. 				<div class="method-definition">
    296. 

  296. 					<img src="../media/images/Method.png" alt=" "/>
    297. 

  297. 											<span class="method-result">void</span>
    298. 

  298. 										<a href="#set_response_timestamp" title="details" class="method-name">set_response_timestamp</a>
    299. 

  299. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    300. 

  300. 									</div>
    301. 

  301. 															
    302. 

  302. 				<div class="method-definition">
    303. 

  303. 					<img src="../media/images/Method.png" alt=" "/>
    304. 

  304. 											<span class="method-result">void</span>
    305. 

  305. 										<a href="#set_side_effects" title="details" class="method-name">set_side_effects</a>
    306. 

  306. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    307. 

  307. 									</div>
    308. 

  308. 															
    309. 

  309. 				<div class="method-definition">
    310. 

  310. 					<img src="../media/images/Method.png" alt=" "/>
    311. 

  311. 											<span class="method-result">void</span>
    312. 

  312. 										<a href="#set_status_code" title="details" class="method-name">set_status_code</a>
    313. 

  313. 											(<span class="var-type">integer</span>&nbsp;<span class="var-name">$par</span>)
    314. 

  314. 									</div>
    315. 

  315. 															
    316. 

  316. 				<div class="method-definition">
    317. 

  317. 					<img src="../media/images/Method.png" alt=" "/>
    318. 

  318. 											<span class="method-result">void</span>
    319. 

  319. 										<a href="#set_status_descriptor" title="details" class="method-name">set_status_descriptor</a>
    320. 

  320. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    321. 

  321. 									</div>
    322. 

  322. 															
    323. 

  323. 				<div class="method-definition">
    324. 

  324. 					<img src="../media/images/Method.png" alt=" "/>
    325. 

  325. 											<span class="method-result">void</span>
    326. 

  326. 										<a href="#set_tracking_code" title="details" class="method-name">set_tracking_code</a>
    327. 

  327. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    328. 

  328. 									</div>
    329. 

  329. 															
    330. 

  330. 				<div class="method-definition">
    331. 

  331. 					<img src="../media/images/Method.png" alt=" "/>
    332. 

  332. 											<span class="method-result">void</span>
    333. 

  333. 										<a href="#set_user_key" title="details" class="method-name">set_user_key</a>
    334. 

  334. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    335. 

  335. 									</div>
    336. 

  336. 															
    337. 

  337. 				<div class="method-definition">
    338. 

  338. 					<img src="../media/images/PrivateMethod.png" alt=" "/>
    339. 

  339. 											<span class="method-result">void</span>
    340. 

  340. 										<a href="#_internal_validation_error" title="details" class="method-name">_internal_validation_error</a>
    341. 

  341. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$msg</span>)
    342. 

  342. 									</div>
    343. 

  343. 											</div>
    344. 

  344. 		</div>
    345. 

  345. 	</div>		
    346. 

  346. 

  347. 	<a name="sec-vars"></a>
    348. 

  348. 	<div class="info-box">
    349. 

  349. 		<div class="info-box-title">Variables</div>
    350. 

  350. 		<div class="nav-bar">
    351. 

  351. 			<a href="#sec-description">Description</a> |
    352. 

  352. 										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
    353. 

  353. 						
    354. 

  354. 			
    355. 

  355. 										| 
    356. 

  356. 									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    357. 

  357. 							
    358. 

  358. 					</div>
    359. 

  359. 		<div class="info-box-body">
    360. 

  360. 			
    361. 

  361. <a name="var$data" id="$data"><!-- --></A>
    362. 

  362. <div class="oddrow">
    363. 

  363. 

  364. 	<div class="var-header">
    365. 

  365. 		<img src="../media/images/PrivateVariable.png" />
    366. 

  366. 		<span class="var-title">
    367. 

  367. 			<span class="var-type">mixed</span>
    368. 

  368. 			<span class="var-name">$data</span>
    369. 

  369. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a156">156</a></span>)
    370. 

  370. 		</span>
    371. 

  371. 	</div>
    372. 

  372. 

  373. 	<!-- ========== Info from phpDoc block ========= -->
    374. 

  374. <p class="short-description">Data to render following the status line in the response.</p>
    375. 

  375. <p class="description"><p>This value can either be a scalar (single value, e.g. int, string, float), or an array.  If it is a single scalar, it is rendered as a single line.  If it is an array, then each element becomes one line.  If an element is a scalar, then it is directly output onto the line.  If an element is an array, then each child element is output as a separate field on the same line.  <strong>Optional. Ignored if NULL.</strong></p></p>
    376. 

  376. 	<ul class="tags">
    377. 

  377. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLResponse.html#methodclear_data">SloodleLSLResponse::clear_data()</a></li>
    378. 

  378. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLResponse.html#methodadd_data_line">SloodleLSLResponse::add_data_line()</a></li>
    379. 

  379. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLResponse.html#methodset_data">SloodleLSLResponse::set_data()</a></li>
    380. 

  380. 				<li><span class="field">see:</span> <a href="../sloodle/_lib---sl_iolib.php.html#defineSLOODLE_LINE_SEPARATOR">SLOODLE_LINE_SEPARATOR</a></li>
    381. 

  381. 				<li><span class="field">see:</span> <a href="../sloodle/_lib---sl_iolib.php.html#defineSLOODLE_FIELD_SEPARATOR">SLOODLE_FIELD_SEPARATOR</a></li>
    382. 

  382. 				<li><span class="field">access:</span> private</li>
    383. 

  383. 			</ul>
    384. 

  384. 	
    385. 

  385. 	
    386. 

  386. 		
    387. 

  387. 		
    388. 

  388. 

  389. </div>
    390. 

  390. <a name="var$page_number" id="$page_number"><!-- --></A>
    391. 

  391. <div class="evenrow">
    392. 

  392. 

  393. 	<div class="var-header">
    394. 

  394. 		<img src="../media/images/PrivateVariable.png" />
    395. 

  395. 		<span class="var-title">
    396. 

  396. 			<span class="var-type">integer</span>
    397. 

  397. 			<span class="var-name">$page_number</span>
    398. 

  398. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a138">138</a></span>)
    399. 

  399. 		</span>
    400. 

  400. 	</div>
    401. 

  401. 

  402. 	<!-- ========== Info from phpDoc block ========= -->
    403. 

  403. <p class="short-description">Current page number.</p>
    404. 

  404. <p class="description"><p>If a response requires multiple pages, this value indicates which page is being returned in this response.  <strong>Optional, unless $page_total is specified. Ignored if NULL.</strong> <em>Not yet supported.</em></p></p>
    405. 

  405. 	<ul class="tags">
    406. 

  406. 				<li><span class="field">access:</span> private</li>
    407. 

  407. 			</ul>
    408. 

  408. 	
    409. 

  409. 	
    410. 

  410. 		
    411. 

  411. 		
    412. 

  412. 

  413. </div>
    414. 

  414. <a name="var$page_total" id="$page_total"><!-- --></A>
    415. 

  415. <div class="oddrow">
    416. 

  416. 

  417. 	<div class="var-header">
    418. 

  418. 		<img src="../media/images/PrivateVariable.png" />
    419. 

  419. 		<span class="var-title">
    420. 

  420. 			<span class="var-type">integer</span>
    421. 

  421. 			<span class="var-name">$page_total</span>
    422. 

  422. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a129">129</a></span>)
    423. 

  423. 		</span>
    424. 

  424. 	</div>
    425. 

  425. 

  426. 	<!-- ========== Info from phpDoc block ========= -->
    427. 

  427. <p class="short-description">Total number of pages.</p>
    428. 

  428. <p class="description"><p>If a response requires multiple pages, this value indicates how many pages there are.  <strong>Optional, unless $page_number is specified. Ignored if NULL.</strong> <em>Not yet supported.</em></p></p>
    429. 

  429. 	<ul class="tags">
    430. 

  430. 				<li><span class="field">access:</span> private</li>
    431. 

  431. 			</ul>
    432. 

  432. 	
    433. 

  433. 	
    434. 

  434. 		
    435. 

  435. 		
    436. 

  436. 

  437. </div>
    438. 

  438. <a name="var$request_descriptor" id="$request_descriptor"><!-- --></A>
    439. 

  439. <div class="evenrow">
    440. 

  440. 

  441. 	<div class="var-header">
    442. 

  442. 		<img src="../media/images/PrivateVariable.png" />
    443. 

  443. 		<span class="var-title">
    444. 

  444. 			<span class="var-type">string</span>
    445. 

  445. 			<span class="var-name">$request_descriptor</span>
    446. 

  446. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a81">81</a></span>)
    447. 

  447. 		</span>
    448. 

  448. 	</div>
    449. 

  449. 

  450. 	<!-- ========== Info from phpDoc block ========= -->
    451. 

  451. <p class="short-description">Request descriptor.</p>
    452. 

  452. <p class="description"><p>A brief string passed into the request by an LSL script (via HTTP parameter 'sloodlerequestdesc'),  which is returned so that it can correctly distinguish one request from anotehr.  <strong>Optional. Ignored if NULL.</strong></p></p>
    453. 

  453. 	<ul class="tags">
    454. 

  454. 				<li><span class="field">access:</span> private</li>
    455. 

  455. 			</ul>
    456. 

  456. 	
    457. 

  457. 	
    458. 

  458. 		
    459. 

  459. 		
    460. 

  460. 

  461. </div>
    462. 

  462. <a name="var$request_timestamp" id="$request_timestamp"><!-- --></A>
    463. 

  463. <div class="oddrow">
    464. 

  464. 

  465. 	<div class="var-header">
    466. 

  466. 		<img src="../media/images/PrivateVariable.png" />
    467. 

  467. 		<span class="var-title">
    468. 

  468. 			<span class="var-type">integer</span>
    469. 

  469. 			<span class="var-name">$request_timestamp</span>
    470. 

  470. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a90">90</a></span>)
    471. 

  471. 		</span>
    472. 

  472. 	</div>
    473. 

  473. 

  474. 	<!-- ========== Info from phpDoc block ========= -->
    475. 

  475. <p class="short-description">Timestamp when the request was originally made by the LSL script.</p>
    476. 

  476. <p class="description"><p>This is <em>not</em> filled-in automatically. You must do it manually if you need it.  <strong>Optional. Ignored if NULL.</strong></p></p>
    477. 

  477. 	<ul class="tags">
    478. 

  478. 				<li><span class="field">access:</span> private</li>
    479. 

  479. 			</ul>
    480. 

  480. 	
    481. 

  481. 	
    482. 

  482. 		
    483. 

  483. 		
    484. 

  484. 

  485. </div>
    486. 

  486. <a name="var$response_timestamp" id="$response_timestamp"><!-- --></A>
    487. 

  487. <div class="evenrow">
    488. 

  488. 

  489. 	<div class="var-header">
    490. 

  490. 		<img src="../media/images/PrivateVariable.png" />
    491. 

  491. 		<span class="var-title">
    492. 

  492. 			<span class="var-type">integer</span>
    493. 

  493. 			<span class="var-name">$response_timestamp</span>
    494. 

  494. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a99">99</a></span>)
    495. 

  495. 		</span>
    496. 

  496. 	</div>
    497. 

  497. 

  498. 	<!-- ========== Info from phpDoc block ========= -->
    499. 

  499. <p class="short-description">Timestamp when the response was generated on the Moodle site.</p>
    500. 

  500. <p class="description"><p>This is <em>not</em> filled-in automatically. You must do it manually if you need it.  <strong>Optional. Ignored if NULL.</strong></p></p>
    501. 

  501. 	<ul class="tags">
    502. 

  502. 				<li><span class="field">access:</span> private</li>
    503. 

  503. 			</ul>
    504. 

  504. 	
    505. 

  505. 	
    506. 

  506. 		
    507. 

  507. 		
    508. 

  508. 

  509. </div>
    510. 

  510. <a name="var$side_effects" id="$side_effects"><!-- --></A>
    511. 

  511. <div class="oddrow">
    512. 

  512. 

  513. 	<div class="var-header">
    514. 

  514. 		<img src="../media/images/PrivateVariable.png" />
    515. 

  515. 		<span class="var-title">
    516. 

  516. 			<span class="var-type">mixed</span>
    517. 

  517. 			<span class="var-name">$side_effects</span>
    518. 

  518. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a71">71</a></span>)
    519. 

  519. 		</span>
    520. 

  520. 	</div>
    521. 

  521. 

  522. 	<!-- ========== Info from phpDoc block ========= -->
    523. 

  523. <p class="short-description">Integer side effect(s) codes.</p>
    524. 

  524. <p class="description"><p>Status code(s) of side effect(s) incurred during the operation.  Can be a single integer, or an array of integers.  <strong>Optional. Ignored if NULL.</strong></p></p>
    525. 

  525. 	<ul class="tags">
    526. 

  526. 				<li><span class="field">access:</span> private</li>
    527. 

  527. 			</ul>
    528. 

  528. 	
    529. 

  529. 	
    530. 

  530. 		
    531. 

  531. 		
    532. 

  532. 

  533. </div>
    534. 

  534. <a name="var$status_code" id="$status_code"><!-- --></A>
    535. 

  535. <div class="evenrow">
    536. 

  536. 

  537. 	<div class="var-header">
    538. 

  538. 		<img src="../media/images/PrivateVariable.png" />
    539. 

  539. 		<span class="var-title">
    540. 

  540. 			<span class="var-type">int</span>
    541. 

  541. 			<span class="var-name">$status_code</span>
    542. 

  542. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a52">52</a></span>)
    543. 

  543. 		</span>
    544. 

  544. 	</div>
    545. 

  545. 

  546. 	<!-- ========== Info from phpDoc block ========= -->
    547. 

  547. <p class="short-description">Integer status code of the response.</p>
    548. 

  548. <p class="description"><p>Refer to the <a href="http://slisweb.sjsu.edu/sl/index.php/Sloodle_status_codes">status codes</a> page on the Sloodle wiki for a reference.  <strong>Required.</strong></p></p>
    549. 

  549. 	<ul class="tags">
    550. 

  550. 				<li><span class="field">access:</span> private</li>
    551. 

  551. 			</ul>
    552. 

  552. 	
    553. 

  553. 	
    554. 

  554. 		
    555. 

  555. 		
    556. 

  556. 

  557. </div>
    558. 

  558. <a name="var$status_descriptor" id="$status_descriptor"><!-- --></A>
    559. 

  559. <div class="oddrow">
    560. 

  560. 

  561. 	<div class="var-header">
    562. 

  562. 		<img src="../media/images/PrivateVariable.png" />
    563. 

  563. 		<span class="var-title">
    564. 

  564. 			<span class="var-type">string</span>
    565. 

  565. 			<span class="var-name">$status_descriptor</span>
    566. 

  566. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a61">61</a></span>)
    567. 

  567. 		</span>
    568. 

  568. 	</div>
    569. 

  569. 

  570. 	<!-- ========== Info from phpDoc block ========= -->
    571. 

  571. <p class="short-description">Status descriptor string.</p>
    572. 

  572. <p class="description"><p>Should contain a generalised description/category of the status code.  <strong>Optional but recommended. Ignored if NULL.</strong></p></p>
    573. 

  573. 	<ul class="tags">
    574. 

  574. 				<li><span class="field">access:</span> private</li>
    575. 

  575. 			</ul>
    576. 

  576. 	
    577. 

  577. 	
    578. 

  578. 		
    579. 

  579. 		
    580. 

  580. 

  581. </div>
    582. 

  582. <a name="var$tracking_code" id="$tracking_code"><!-- --></A>
    583. 

  583. <div class="evenrow">
    584. 

  584. 

  585. 	<div class="var-header">
    586. 

  586. 		<img src="../media/images/PrivateVariable.png" />
    587. 

  587. 		<span class="var-title">
    588. 

  588. 			<span class="var-type">mixed</span>
    589. 

  589. 			<span class="var-name">$tracking_code</span>
    590. 

  590. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a120">120</a></span>)
    591. 

  591. 		</span>
    592. 

  592. 	</div>
    593. 

  593. 

  594. 	<!-- ========== Info from phpDoc block ========= -->
    595. 

  595. <p class="short-description">Tracking code of the request.</p>
    596. 

  596. <p class="description"><p>Use of this value is undefined. Please do not use it.  <strong>Optional. Ignored if NULL.</strong></p></p>
    597. 

  597. 	<ul class="tags">
    598. 

  598. 				<li><span class="field">access:</span> private</li>
    599. 

  599. 			</ul>
    600. 

  600. 	
    601. 

  601. 	
    602. 

  602. 		
    603. 

  603. 		
    604. 

  604. 

  605. </div>
    606. 

  606. <a name="var$user_key" id="$user_key"><!-- --></A>
    607. 

  607. <div class="oddrow">
    608. 

  608. 

  609. 	<div class="var-header">
    610. 

  610. 		<img src="../media/images/PrivateVariable.png" />
    611. 

  611. 		<span class="var-title">
    612. 

  612. 			<span class="var-type">string</span>
    613. 

  613. 			<span class="var-name">$user_key</span>
    614. 

  614. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a111">111</a></span>)
    615. 

  615. 		</span>
    616. 

  616. 	</div>
    617. 

  617. 

  618. 	<!-- ========== Info from phpDoc block ========= -->
    619. 

  619. <p class="short-description">SL agent key.</p>
    620. 

  620. <p class="description"><p>Should be a string specifying the UUID key of the agent in-world being handled. (Typically of the user who initiated the request).  <strong>Optional. Ignored if NULL.</strong></p></p>
    621. 

  621. 	<ul class="tags">
    622. 

  622. 				<li><span class="field">access:</span> private</li>
    623. 

  623. 			</ul>
    624. 

  624. 	
    625. 

  625. 	
    626. 

  626. 		
    627. 

  627. 		
    628. 

  628. 

  629. </div>
    630. 

  630. 
						
    631. 

  631. 		</div>
    632. 

  632. 	</div>
    633. 

  633. 	
    634. 

  634. 	<a name="sec-methods"></a>
    635. 

  635. 	<div class="info-box">
    636. 

  636. 		<div class="info-box-title">Methods</div>
    637. 

  637. 		<div class="nav-bar">
    638. 

  638. 			<a href="#sec-description">Description</a> |
    639. 

  639. 															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    640. 

  640. 																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
    641. 

  641. 						
    642. 

  642. 		</div>
    643. 

  643. 		<div class="info-box-body">
    644. 

  644. 			<A NAME='method_detail'></A>
    645. 

  645. <a name="methodSloodleLSLResponse" id="SloodleLSLResponse"><!-- --></a>
    646. 

  646. <div class="evenrow">
    647. 

  647. 	
    648. 

  648. 	<div class="method-header">
    649. 

  649. 		<img src="../media/images/Constructor.png" />
    650. 

  650. 		<span class="method-title">Constructor SloodleLSLResponse</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a463">463</a></span>)
    651. 

  651. 	</div> 
    652. 

  652. 	
    653. 

  653. 	<!-- ========== Info from phpDoc block ========= -->
    654. 

  654. <p class="short-description"><em>Constructor</em><ul><li>can intialise some variables</li></ul></p>
    655. 

  655. 	<ul class="tags">
    656. 

  656. 				<li><span class="field">access:</span> public</li>
    657. 

  657. 			</ul>
    658. 

  658. 	
    659. 

  659. 	<div class="method-signature">
    660. 

  660. 		<span class="method-result">void</span>
    661. 

  661. 		<span class="method-name">
    662. 

  662. 			SloodleLSLResponse
    663. 

  663. 		</span>
    664. 

  664. 					([<span class="var-type">int</span>&nbsp;<span class="var-name">$status_code</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$status_descriptor</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">NULL</span>])
    665. 

  665. 			</div>
    666. 

  666. 	
    667. 

  667. 			<ul class="parameters">
    668. 

  668. 					<li>
    669. 

  669. 				<span class="var-type">int</span>
    670. 

  670. 				<span class="var-name">$status_code</span><span class="var-description">: The initial status code for the response (optional - ignore if NULL)</span>			</li>
    671. 

  671. 					<li>
    672. 

  672. 				<span class="var-type">string</span>
    673. 

  673. 				<span class="var-name">$status_descriptor</span><span class="var-description">: The initial status descriptor for the response (optional - ignore if NULL)</span>			</li>
    674. 

  674. 					<li>
    675. 

  675. 				<span class="var-type">mixed</span>
    676. 

  676. 				<span class="var-name">$data</span><span class="var-description">: The initial data for the response, which can be a scalar, or a mixed array of scalars/scalar-arrays (see <a href="../sloodle/SloodleLSLResponse.html#var$data">SloodleLSLResponse::$data</a>) (optional - ignore if NULL)</span>			</li>
    677. 

  677. 				</ul>
    678. 

  678. 		
    679. 

  679. 			
    680. 

  680. 	</div>
    681. 

  681. <a name="methodadd_data_line" id="add_data_line"><!-- --></a>
    682. 

  682. <div class="oddrow">
    683. 

  683. 	
    684. 

  684. 	<div class="method-header">
    685. 

  685. 		<img src="../media/images/Method.png" />
    686. 

  686. 		<span class="method-title">add_data_line</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a421">421</a></span>)
    687. 

  687. 	</div> 
    688. 

  688. 	
    689. 

  689. 	<!-- ========== Info from phpDoc block ========= -->
    690. 

  690. <p class="short-description">Adds one line of data to the $data member</p>
    691. 

  691. 	
    692. 

  692. 	<div class="method-signature">
    693. 

  693. 		<span class="method-result">void</span>
    694. 

  694. 		<span class="method-name">
    695. 

  695. 			add_data_line
    696. 

  696. 		</span>
    697. 

  697. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    698. 

  698. 			</div>
    699. 

  699. 	
    700. 

  700. 			<ul class="parameters">
    701. 

  701. 					<li>
    702. 

  702. 				<span class="var-type">mixed</span>
    703. 

  703. 				<span class="var-name">$par</span><span class="var-description">: A scalar, or an array of scalars</span>			</li>
    704. 

  704. 				</ul>
    705. 

  705. 		
    706. 

  706. 			
    707. 

  707. 	</div>
    708. 

  708. <a name="methodadd_side_effect" id="add_side_effect"><!-- --></a>
    709. 

  709. <div class="evenrow">
    710. 

  710. 	
    711. 

  711. 	<div class="method-header">
    712. 

  712. 		<img src="../media/images/Method.png" />
    713. 

  713. 		<span class="method-title">add_side_effect</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a269">269</a></span>)
    714. 

  714. 	</div> 
    715. 

  715. 	
    716. 

  716. 	<!-- ========== Info from phpDoc block ========= -->
    717. 

  717. <p class="short-description">Adds a single side effect code to member $status_code</p>
    718. 

  718. 	
    719. 

  719. 	<div class="method-signature">
    720. 

  720. 		<span class="method-result">void</span>
    721. 

  721. 		<span class="method-name">
    722. 

  722. 			add_side_effect
    723. 

  723. 		</span>
    724. 

  724. 					(<span class="var-type">integer</span>&nbsp;<span class="var-name">$par</span>)
    725. 

  725. 			</div>
    726. 

  726. 	
    727. 

  727. 			<ul class="parameters">
    728. 

  728. 					<li>
    729. 

  729. 				<span class="var-type">integer</span>
    730. 

  730. 				<span class="var-name">$par</span><span class="var-description">: An integer side-effect code.</span>			</li>
    731. 

  731. 				</ul>
    732. 

  732. 		
    733. 

  733. 			
    734. 

  734. 	</div>
    735. 

  735. <a name="methodadd_side_effects" id="add_side_effects"><!-- --></a>
    736. 

  736. <div class="oddrow">
    737. 

  737. 	
    738. 

  738. 	<div class="method-header">
    739. 

  739. 		<img src="../media/images/Method.png" />
    740. 

  740. 		<span class="method-title">add_side_effects</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a228">228</a></span>)
    741. 

  741. 	</div> 
    742. 

  742. 	
    743. 

  743. 	<!-- ========== Info from phpDoc block ========= -->
    744. 

  744. <p class="short-description">Adds one or more integer side effect codes to member $status_code.</p>
    745. 

  745. 	
    746. 

  746. 	<div class="method-signature">
    747. 

  747. 		<span class="method-result">void</span>
    748. 

  748. 		<span class="method-name">
    749. 

  749. 			add_side_effects
    750. 

  750. 		</span>
    751. 

  751. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    752. 

  752. 			</div>
    753. 

  753. 	
    754. 

  754. 			<ul class="parameters">
    755. 

  755. 					<li>
    756. 

  756. 				<span class="var-type">mixed</span>
    757. 

  757. 				<span class="var-name">$par</span><span class="var-description">: An integer side effect code, or an array of them.</span>			</li>
    758. 

  758. 				</ul>
    759. 

  759. 		
    760. 

  760. 			
    761. 

  761. 	</div>
    762. 

  762. <a name="methodclear_data" id="clear_data"><!-- --></a>
    763. 

  763. <div class="evenrow">
    764. 

  764. 	
    765. 

  765. 	<div class="method-header">
    766. 

  766. 		<img src="../media/images/Method.png" />
    767. 

  767. 		<span class="method-title">clear_data</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a447">447</a></span>)
    768. 

  768. 	</div> 
    769. 

  769. 	
    770. 

  770. 	<!-- ========== Info from phpDoc block ========= -->
    771. 

  771. <p class="short-description">Clears all data from member $data</p>
    772. 

  772. 	
    773. 

  773. 	<div class="method-signature">
    774. 

  774. 		<span class="method-result">void</span>
    775. 

  775. 		<span class="method-name">
    776. 

  776. 			clear_data
    777. 

  777. 		</span>
    778. 

  778. 				()
    779. 

  779. 			</div>
    780. 

  780. 	
    781. 

  781. 		
    782. 

  782. 			
    783. 

  783. 	</div>
    784. 

  784. <a name="methodquick_output" id="quick_output"><!-- --></a>
    785. 

  785. <div class="oddrow">
    786. 

  786. 	
    787. 

  787. 	<div class="method-header">
    788. 

  788. 		<img src="../media/images/Method.png" />
    789. 

  789. 		<span class="method-title">quick_output</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a640">640</a></span>)
    790. 

  790. 	</div> 
    791. 

  791. 	
    792. 

  792. 	<!-- ========== Info from phpDoc block ========= -->
    793. 

  793. <p class="short-description">Quick output of data to avoid several accessor calls if the response is very basic.</p>
    794. 

  794. <p class="description"><p>Can be called statically to allow simple output of basic data.  The status code is required, but the other parameters are optional  If an error occurs, the LSL-friendly error message is output to the HTTP response, and the script terminated</p></p>
    795. 

  795. 	<ul class="tags">
    796. 

  796. 				<li><span class="field">access:</span> public</li>
    797. 

  797. 			</ul>
    798. 

  798. 	
    799. 

  799. 	<div class="method-signature">
    800. 

  800. 		<span class="method-result">void</span>
    801. 

  801. 		<span class="method-name">
    802. 

  802. 			quick_output
    803. 

  803. 		</span>
    804. 

  804. 					(<span class="var-type">int</span>&nbsp;<span class="var-name">$status_code</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$status_descriptor</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">NULL</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$static</span> = <span class="var-default">TRUE</span>])
    805. 

  805. 			</div>
    806. 

  806. 	
    807. 

  807. 			<ul class="parameters">
    808. 

  808. 					<li>
    809. 

  809. 				<span class="var-type">int</span>
    810. 

  810. 				<span class="var-name">$status_code</span><span class="var-description">: The status code for the response (required)</span>			</li>
    811. 

  811. 					<li>
    812. 

  812. 				<span class="var-type">string</span>
    813. 

  813. 				<span class="var-name">$status_descriptor</span><span class="var-description">: The status descriptor for the response (optional - ignored if NULL)</span>			</li>
    814. 

  814. 					<li>
    815. 

  815. 				<span class="var-type">mixed</span>
    816. 

  816. 				<span class="var-name">$data</span><span class="var-description">: The data for the response, which can be a scalar, or a mixed array of scalars/scalar-arrays (see <a href="../sloodle/SloodleLSLResponse.html#var$data">SloodleLSLResponse::$data</a>) (optional - ignored if NULL)</span>			</li>
    817. 

  817. 					<li>
    818. 

  818. 				<span class="var-type">bool</span>
    819. 

  819. 				<span class="var-name">$static</span><span class="var-description">: If TRUE (default), then this function will assume it is being call statically, and construct its own response object. Otherwise, it will all the existing member data to render the output.</span>			</li>
    820. 

  820. 				</ul>
    821. 

  821. 		
    822. 

  822. 			
    823. 

  823. 	</div>
    824. 

  824. <a name="methodrender_to_output" id="render_to_output"><!-- --></a>
    825. 

  825. <div class="evenrow">
    826. 

  826. 	
    827. 

  827. 	<div class="method-header">
    828. 

  828. 		<img src="../media/images/Method.png" />
    829. 

  829. 		<span class="method-title">render_to_output</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a612">612</a></span>)
    830. 

  830. 	</div> 
    831. 

  831. 	
    832. 

  832. 	<!-- ========== Info from phpDoc block ========= -->
    833. 

  833. <p class="short-description">Outputs the response directly to the HTTP response.</p>
    834. 

  834. 	<ul class="tags">
    835. 

  835. 				<li><span class="field">access:</span> public</li>
    836. 

  836. 				<li><span class="field">uses:</span> <a href="../sloodle/SloodleLSLResponse.html#methodrender_to_string">SloodleLSLResponse::render_to_string()</a> - Outputs the result from this function directly to the HTTP response stream.</li>
    837. 

  837. 			</ul>
    838. 

  838. 	
    839. 

  839. 	<div class="method-signature">
    840. 

  840. 		<span class="method-result">void</span>
    841. 

  841. 		<span class="method-name">
    842. 

  842. 			render_to_output
    843. 

  843. 		</span>
    844. 

  844. 				()
    845. 

  845. 			</div>
    846. 

  846. 	
    847. 

  847. 		
    848. 

  848. 			
    849. 

  849. 	</div>
    850. 

  850. <a name="methodrender_to_string" id="render_to_string"><!-- --></a>
    851. 

  851. <div class="oddrow">
    852. 

  852. 	
    853. 

  853. 	<div class="method-header">
    854. 

  854. 		<img src="../media/images/Method.png" />
    855. 

  855. 		<span class="method-title">render_to_string</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a480">480</a></span>)
    856. 

  856. 	</div> 
    857. 

  857. 	
    858. 

  858. 	<!-- ========== Info from phpDoc block ========= -->
    859. 

  859. <p class="short-description">Renders the response to a string.</p>
    860. 

  860. <p class="description"><p>Prior to rendering, this function will perform final validation on all the data.  If anything fails, then the script will terminate with an LSL-friendly error message.</p></p>
    861. 

  861. 	<ul class="tags">
    862. 

  862. 				<li><span class="field">access:</span> public</li>
    863. 

  863. 				<li><span class="field">usedby:</span> <a href="../sloodle/SloodleLSLResponse.html#methodrender_to_output">SloodleLSLResponse::render_to_output()</a> - Outputs the result from this function directly to the HTTP response stream.</li>
    864. 

  864. 			</ul>
    865. 

  865. 	
    866. 

  866. 	<div class="method-signature">
    867. 

  867. 		<span class="method-result">void</span>
    868. 

  868. 		<span class="method-name">
    869. 

  869. 			render_to_string
    870. 

  870. 		</span>
    871. 

  871. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">&$str</span>)
    872. 

  872. 			</div>
    873. 

  873. 	
    874. 

  874. 			<ul class="parameters">
    875. 

  875. 					<li>
    876. 

  876. 				<span class="var-type">string</span>
    877. 

  877. 				<span class="var-name">&$str</span><span class="var-description">: Reference to a string object which the response should be rendered to.</span>			</li>
    878. 

  878. 				</ul>
    879. 

  879. 		
    880. 

  880. 			
    881. 

  881. 	</div>
    882. 

  882. <a name="methodset_data" id="set_data"><!-- --></a>
    883. 

  883. <div class="evenrow">
    884. 

  884. 	
    885. 

  885. 	<div class="method-header">
    886. 

  886. 		<img src="../media/images/Method.png" />
    887. 

  887. 		<span class="method-title">set_data</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a382">382</a></span>)
    888. 

  888. 	</div> 
    889. 

  889. 	
    890. 

  890. 	<!-- ========== Info from phpDoc block ========= -->
    891. 

  891. <p class="short-description">Accessor function to set member value $data. <strong>Note: it is recommended that you use the add_data_line() and clear_data() functions instead of this.</strong></p>
    892. 

  892. 	
    893. 

  893. 	<div class="method-signature">
    894. 

  894. 		<span class="method-result">void</span>
    895. 

  895. 		<span class="method-name">
    896. 

  896. 			set_data
    897. 

  897. 		</span>
    898. 

  898. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    899. 

  899. 			</div>
    900. 

  900. 	
    901. 

  901. 			<ul class="parameters">
    902. 

  902. 					<li>
    903. 

  903. 				<span class="var-type">mixed</span>
    904. 

  904. 				<span class="var-name">$par</span><span class="var-description">: Any scalar value, or a mixed array of scalars or scalar arrays, or NULL to clear it</span>			</li>
    905. 

  905. 				</ul>
    906. 

  906. 		
    907. 

  907. 			
    908. 

  908. 	</div>
    909. 

  909. <a name="methodset_page_number" id="set_page_number"><!-- --></a>
    910. 

  910. <div class="oddrow">
    911. 

  911. 	
    912. 

  912. 	<div class="method-header">
    913. 

  913. 		<img src="../media/images/Method.png" />
    914. 

  914. 		<span class="method-title">set_page_number</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a367">367</a></span>)
    915. 

  915. 	</div> 
    916. 

  916. 	
    917. 

  917. 	<!-- ========== Info from phpDoc block ========= -->
    918. 

  918. <p class="short-description">Accessor function to set member value $page_number</p>
    919. 

  919. 	
    920. 

  920. 	<div class="method-signature">
    921. 

  921. 		<span class="method-result">void</span>
    922. 

  922. 		<span class="method-name">
    923. 

  923. 			set_page_number
    924. 

  924. 		</span>
    925. 

  925. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    926. 

  926. 			</div>
    927. 

  927. 	
    928. 

  928. 			<ul class="parameters">
    929. 

  929. 					<li>
    930. 

  930. 				<span class="var-type">mixed</span>
    931. 

  931. 				<span class="var-name">$par</span><span class="var-description">: A positive page number, or NULL to clear it</span>			</li>
    932. 

  932. 				</ul>
    933. 

  933. 		
    934. 

  934. 			
    935. 

  935. 	</div>
    936. 

  936. <a name="methodset_page_total" id="set_page_total"><!-- --></a>
    937. 

  937. <div class="evenrow">
    938. 

  938. 	
    939. 

  939. 	<div class="method-header">
    940. 

  940. 		<img src="../media/images/Method.png" />
    941. 

  941. 		<span class="method-title">set_page_total</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a352">352</a></span>)
    942. 

  942. 	</div> 
    943. 

  943. 	
    944. 

  944. 	<!-- ========== Info from phpDoc block ========= -->
    945. 

  945. <p class="short-description">Accessor function to set member value $page_total</p>
    946. 

  946. 	
    947. 

  947. 	<div class="method-signature">
    948. 

  948. 		<span class="method-result">void</span>
    949. 

  949. 		<span class="method-name">
    950. 

  950. 			set_page_total
    951. 

  951. 		</span>
    952. 

  952. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    953. 

  953. 			</div>
    954. 

  954. 	
    955. 

  955. 			<ul class="parameters">
    956. 

  956. 					<li>
    957. 

  957. 				<span class="var-type">mixed</span>
    958. 

  958. 				<span class="var-name">$par</span><span class="var-description">: A positive page total count, or NULL to clear it</span>			</li>
    959. 

  959. 				</ul>
    960. 

  960. 		
    961. 

  961. 			
    962. 

  962. 	</div>
    963. 

  963. <a name="methodset_request_descriptor" id="set_request_descriptor"><!-- --></a>
    964. 

  964. <div class="oddrow">
    965. 

  965. 	
    966. 

  966. 	<div class="method-header">
    967. 

  967. 		<img src="../media/images/Method.png" />
    968. 

  968. 		<span class="method-title">set_request_descriptor</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a282">282</a></span>)
    969. 

  969. 	</div> 
    970. 

  970. 	
    971. 

  971. 	<!-- ========== Info from phpDoc block ========= -->
    972. 

  972. <p class="short-description">Accessor function to set member value $request_descriptor</p>
    973. 

  973. 	
    974. 

  974. 	<div class="method-signature">
    975. 

  975. 		<span class="method-result">void</span>
    976. 

  976. 		<span class="method-name">
    977. 

  977. 			set_request_descriptor
    978. 

  978. 		</span>
    979. 

  979. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    980. 

  980. 			</div>
    981. 

  981. 	
    982. 

  982. 			<ul class="parameters">
    983. 

  983. 					<li>
    984. 

  984. 				<span class="var-type">mixed</span>
    985. 

  985. 				<span class="var-name">$par</span><span class="var-description">: A string request descriptor, or NULL to clear it</span>			</li>
    986. 

  986. 				</ul>
    987. 

  987. 		
    988. 

  988. 			
    989. 

  989. 	</div>
    990. 

  990. <a name="methodset_request_timestamp" id="set_request_timestamp"><!-- --></a>
    991. 

  991. <div class="evenrow">
    992. 

  992. 	
    993. 

  993. 	<div class="method-header">
    994. 

  994. 		<img src="../media/images/Method.png" />
    995. 

  995. 		<span class="method-title">set_request_timestamp</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a297">297</a></span>)
    996. 

  996. 	</div> 
    997. 

  997. 	
    998. 

  998. 	<!-- ========== Info from phpDoc block ========= -->
    999. 

  999. <p class="short-description">Accessor function to set member value $request_timestamp</p>
    1000. 

  1000. 	
    1001. 

  1001. 	<div class="method-signature">
    1002. 

  1002. 		<span class="method-result">void</span>
    1003. 

  1003. 		<span class="method-name">
    1004. 

  1004. 			set_request_timestamp
    1005. 

  1005. 		</span>
    1006. 

  1006. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    1007. 

  1007. 			</div>
    1008. 

  1008. 	
    1009. 

  1009. 			<ul class="parameters">
    1010. 

  1010. 					<li>
    1011. 

  1011. 				<span class="var-type">mixed</span>
    1012. 

  1012. 				<span class="var-name">$par</span><span class="var-description">: An integer timestamp, or NULL to clear it</span>			</li>
    1013. 

  1013. 				</ul>
    1014. 

  1014. 		
    1015. 

  1015. 			
    1016. 

  1016. 	</div>
    1017. 

  1017. <a name="methodset_response_timestamp" id="set_response_timestamp"><!-- --></a>
    1018. 

  1018. <div class="oddrow">
    1019. 

  1019. 	
    1020. 

  1020. 	<div class="method-header">
    1021. 

  1021. 		<img src="../media/images/Method.png" />
    1022. 

  1022. 		<span class="method-title">set_response_timestamp</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a312">312</a></span>)
    1023. 

  1023. 	</div> 
    1024. 

  1024. 	
    1025. 

  1025. 	<!-- ========== Info from phpDoc block ========= -->
    1026. 

  1026. <p class="short-description">Accessor function to set member value $response_timestamp</p>
    1027. 

  1027. 	
    1028. 

  1028. 	<div class="method-signature">
    1029. 

  1029. 		<span class="method-result">void</span>
    1030. 

  1030. 		<span class="method-name">
    1031. 

  1031. 			set_response_timestamp
    1032. 

  1032. 		</span>
    1033. 

  1033. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    1034. 

  1034. 			</div>
    1035. 

  1035. 	
    1036. 

  1036. 			<ul class="parameters">
    1037. 

  1037. 					<li>
    1038. 

  1038. 				<span class="var-type">mixed</span>
    1039. 

  1039. 				<span class="var-name">$par</span><span class="var-description">: An integer timestamp, or NULL to clear it</span>			</li>
    1040. 

  1040. 				</ul>
    1041. 

  1041. 		
    1042. 

  1042. 			
    1043. 

  1043. 	</div>
    1044. 

  1044. <a name="methodset_side_effects" id="set_side_effects"><!-- --></a>
    1045. 

  1045. <div class="evenrow">
    1046. 

  1046. 	
    1047. 

  1047. 	<div class="method-header">
    1048. 

  1048. 		<img src="../media/images/Method.png" />
    1049. 

  1049. 		<span class="method-title">set_side_effects</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a198">198</a></span>)
    1050. 

  1050. 	</div> 
    1051. 

  1051. 	
    1052. 

  1052. 	<!-- ========== Info from phpDoc block ========= -->
    1053. 

  1053. <p class="short-description">Accessor function to set member value $side_effects. <strong>Note:</strong> it is recommended that you use add_side_effect() or add_side_effects() instead.</p>
    1054. 

  1054. 	
    1055. 

  1055. 	<div class="method-signature">
    1056. 

  1056. 		<span class="method-result">void</span>
    1057. 

  1057. 		<span class="method-name">
    1058. 

  1058. 			set_side_effects
    1059. 

  1059. 		</span>
    1060. 

  1060. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    1061. 

  1061. 			</div>
    1062. 

  1062. 	
    1063. 

  1063. 			<ul class="parameters">
    1064. 

  1064. 					<li>
    1065. 

  1065. 				<span class="var-type">mixed</span>
    1066. 

  1066. 				<span class="var-name">$par</span><span class="var-description">: An integer side effect code, an array of integer side effect codes, or null to clear it</span>			</li>
    1067. 

  1067. 				</ul>
    1068. 

  1068. 		
    1069. 

  1069. 			
    1070. 

  1070. 	</div>
    1071. 

  1071. <a name="methodset_status_code" id="set_status_code"><!-- --></a>
    1072. 

  1072. <div class="oddrow">
    1073. 

  1073. 	
    1074. 

  1074. 	<div class="method-header">
    1075. 

  1075. 		<img src="../media/images/Method.png" />
    1076. 

  1076. 		<span class="method-title">set_status_code</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a168">168</a></span>)
    1077. 

  1077. 	</div> 
    1078. 

  1078. 	
    1079. 

  1079. 	<!-- ========== Info from phpDoc block ========= -->
    1080. 

  1080. <p class="short-description">Accessor function to set member value $status_code</p>
    1081. 

  1081. 	
    1082. 

  1082. 	<div class="method-signature">
    1083. 

  1083. 		<span class="method-result">void</span>
    1084. 

  1084. 		<span class="method-name">
    1085. 

  1085. 			set_status_code
    1086. 

  1086. 		</span>
    1087. 

  1087. 					(<span class="var-type">integer</span>&nbsp;<span class="var-name">$par</span>)
    1088. 

  1088. 			</div>
    1089. 

  1089. 	
    1090. 

  1090. 			<ul class="parameters">
    1091. 

  1091. 					<li>
    1092. 

  1092. 				<span class="var-type">integer</span>
    1093. 

  1093. 				<span class="var-name">$par</span><span class="var-description">: A non-zero status code</span>			</li>
    1094. 

  1094. 				</ul>
    1095. 

  1095. 		
    1096. 

  1096. 			
    1097. 

  1097. 	</div>
    1098. 

  1098. <a name="methodset_status_descriptor" id="set_status_descriptor"><!-- --></a>
    1099. 

  1099. <div class="evenrow">
    1100. 

  1100. 	
    1101. 

  1101. 	<div class="method-header">
    1102. 

  1102. 		<img src="../media/images/Method.png" />
    1103. 

  1103. 		<span class="method-title">set_status_descriptor</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a183">183</a></span>)
    1104. 

  1104. 	</div> 
    1105. 

  1105. 	
    1106. 

  1106. 	<!-- ========== Info from phpDoc block ========= -->
    1107. 

  1107. <p class="short-description">Accessor function to set member value $status_descriptor</p>
    1108. 

  1108. 	
    1109. 

  1109. 	<div class="method-signature">
    1110. 

  1110. 		<span class="method-result">void</span>
    1111. 

  1111. 		<span class="method-name">
    1112. 

  1112. 			set_status_descriptor
    1113. 

  1113. 		</span>
    1114. 

  1114. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    1115. 

  1115. 			</div>
    1116. 

  1116. 	
    1117. 

  1117. 			<ul class="parameters">
    1118. 

  1118. 					<li>
    1119. 

  1119. 				<span class="var-type">mixed</span>
    1120. 

  1120. 				<span class="var-name">$par</span><span class="var-description">: A status descriptor string, or NULL to clear it</span>			</li>
    1121. 

  1121. 				</ul>
    1122. 

  1122. 		
    1123. 

  1123. 			
    1124. 

  1124. 	</div>
    1125. 

  1125. <a name="methodset_tracking_code" id="set_tracking_code"><!-- --></a>
    1126. 

  1126. <div class="oddrow">
    1127. 

  1127. 	
    1128. 

  1128. 	<div class="method-header">
    1129. 

  1129. 		<img src="../media/images/Method.png" />
    1130. 

  1130. 		<span class="method-title">set_tracking_code</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a342">342</a></span>)
    1131. 

  1131. 	</div> 
    1132. 

  1132. 	
    1133. 

  1133. 	<!-- ========== Info from phpDoc block ========= -->
    1134. 

  1134. <p class="short-description">Accessor function to set member value $tracking_code</p>
    1135. 

  1135. 	
    1136. 

  1136. 	<div class="method-signature">
    1137. 

  1137. 		<span class="method-result">void</span>
    1138. 

  1138. 		<span class="method-name">
    1139. 

  1139. 			set_tracking_code
    1140. 

  1140. 		</span>
    1141. 

  1141. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    1142. 

  1142. 			</div>
    1143. 

  1143. 	
    1144. 

  1144. 			<ul class="parameters">
    1145. 

  1145. 					<li>
    1146. 

  1146. 				<span class="var-type">mixed</span>
    1147. 

  1147. 				<span class="var-name">$par</span><span class="var-description">: Any scalar value</span>			</li>
    1148. 

  1148. 				</ul>
    1149. 

  1149. 		
    1150. 

  1150. 			
    1151. 

  1151. 	</div>
    1152. 

  1152. <a name="methodset_user_key" id="set_user_key"><!-- --></a>
    1153. 

  1153. <div class="evenrow">
    1154. 

  1154. 	
    1155. 

  1155. 	<div class="method-header">
    1156. 

  1156. 		<img src="../media/images/Method.png" />
    1157. 

  1157. 		<span class="method-title">set_user_key</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a327">327</a></span>)
    1158. 

  1158. 	</div> 
    1159. 

  1159. 	
    1160. 

  1160. 	<!-- ========== Info from phpDoc block ========= -->
    1161. 

  1161. <p class="short-description">Accessor function to set member value $user_key</p>
    1162. 

  1162. 	
    1163. 

  1163. 	<div class="method-signature">
    1164. 

  1164. 		<span class="method-result">void</span>
    1165. 

  1165. 		<span class="method-name">
    1166. 

  1166. 			set_user_key
    1167. 

  1167. 		</span>
    1168. 

  1168. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$par</span>)
    1169. 

  1169. 			</div>
    1170. 

  1170. 	
    1171. 

  1171. 			<ul class="parameters">
    1172. 

  1172. 					<li>
    1173. 

  1173. 				<span class="var-type">mixed</span>
    1174. 

  1174. 				<span class="var-name">$par</span><span class="var-description">: A string containing a UUID, or NULL to clear it</span>			</li>
    1175. 

  1175. 				</ul>
    1176. 

  1176. 		
    1177. 

  1177. 			
    1178. 

  1178. 	</div>
    1179. 

  1179. <a name="method_internal_validation_error" id="_internal_validation_error"><!-- --></a>
    1180. 

  1180. <div class="oddrow">
    1181. 

  1181. 	
    1182. 

  1182. 	<div class="method-header">
    1183. 

  1183. 		<img src="../media/images/PrivateMethod.png" />
    1184. 

  1184. 		<span class="method-title">_internal_validation_error</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a666">666</a></span>)
    1185. 

  1185. 	</div> 
    1186. 

  1186. 	
    1187. 

  1187. 	<!-- ========== Info from phpDoc block ========= -->
    1188. 

  1188. <p class="short-description">Internal function to report a data validation error.</p>
    1189. 

  1189. <p class="description"><p>Outputs an LSL-friendly error message, and terminates the script</p></p>
    1190. 

  1190. 	<ul class="tags">
    1191. 

  1191. 				<li><span class="field">access:</span> private</li>
    1192. 

  1192. 			</ul>
    1193. 

  1193. 	
    1194. 

  1194. 	<div class="method-signature">
    1195. 

  1195. 		<span class="method-result">void</span>
    1196. 

  1196. 		<span class="method-name">
    1197. 

  1197. 			_internal_validation_error
    1198. 

  1198. 		</span>
    1199. 

  1199. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$msg</span>)
    1200. 

  1200. 			</div>
    1201. 

  1201. 	
    1202. 

  1202. 			<ul class="parameters">
    1203. 

  1203. 					<li>
    1204. 

  1204. 				<span class="var-type">string</span>
    1205. 

  1205. 				<span class="var-name">$msg</span><span class="var-description">: The error message to output.</span>			</li>
    1206. 

  1206. 				</ul>
    1207. 

  1207. 		
    1208. 

  1208. 			
    1209. 

  1209. 	</div>
    1210. 

  1210. 						
    1211. 

  1211. 		</div>
    1212. 

  1212. 	</div>
    1213. 

  1213. 

  1214. 	
    1215. 

  1215. 	<p class="notes" id="credit">
    1216. 

  1216. 		Documentation generated on Tue, 04 Mar 2008 15:08:46 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
    1217. 

  1217. 	</p>
    1218. 

  1218. 	</div></body>
    1219. 

  1219. </html>
    1220.