首頁 探索 說明
註冊 登入
Ayuda_Virtual
/
sloodle_website
2
0
複刻 0
Files 問題管理 0 合併請求 0 Wiki
分支: master
分支列表 標籤列表
sloodle_webs...
/
webroot
/
phpdocs
/
0.21
/
sloodle
/
SloodleLSLRequest.html

SloodleLSLRequest.html 52 KB
永久連結 文件歷史 原始文件

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220 
  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 SloodleLSLRequest</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"> SloodleLSLRequest</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">Handles incoming HTTP requests, typically from LSL scripts.</p>
    105. 

  105. <p class="description"><p>This class will perform much of the complex and repetitive processing required for handling HTTP requests.</p></p>
    106. 

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

  107. 				<li><span class="field">uses:</span> <a href="../sloodle/SloodleUser.html">SloodleUser</a> - Stores and processes user data incoming from an HTTP request</li>
    108. 

  108. 				<li><span class="field">uses:</span> <a href="../sloodle/SloodleLSLResponse.html">SloodleLSLResponse</a> - Outputs error messages in appropriate format if an error occurs.</li>
    109. 

  109. 			</ul>
    110. 

  110. 		<p class="notes">
    111. 

  111. 			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#a708">708</a></span>)
    112. 

  112. 		</p>
    113. 

  113. 		
    114. 

  114. 				
    115. 

  115. 		<pre></pre>
    116. 

  116. 	
    117. 

  117. 			</div>
    118. 

  118. </div>
    119. 

  119. 

  120. 

  121. 

  122. 	<a name="sec-var-summary"></a>
    123. 

  123. 	<div class="info-box">
    124. 

  124. 		<div class="info-box-title">Variable Summary</span></div>
    125. 

  125. 		<div class="nav-bar">
    126. 

  126. 			<a href="#sec-description">Description</a> |
    127. 

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

  128. 							| 
    129. 

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

  130. 							
    131. 

  131. 								</div>
    132. 

  132. 		<div class="info-box-body">
    133. 

  133. 			<div class="var-summary">
    134. 

  134. 																																																																																																								<div class="var-title">
    135. 

  135. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    136. 

  136. 					<span class="var-type">int</span>
    137. 

  137. 					<a href="#$auth_status" title="details" class="var-name">$auth_status</a>
    138. 

  138. 				</div>
    139. 

  139. 																<div class="var-title">
    140. 

  140. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    141. 

  141. 					<span class="var-type">mixed</span>
    142. 

  142. 					<a href="#$avatar_name" title="details" class="var-name">$avatar_name</a>
    143. 

  143. 				</div>
    144. 

  144. 																<div class="var-title">
    145. 

  145. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    146. 

  146. 					<span class="var-type">mixed</span>
    147. 

  147. 					<a href="#$avatar_uuid" title="details" class="var-name">$avatar_uuid</a>
    148. 

  148. 				</div>
    149. 

  149. 																<div class="var-title">
    150. 

  150. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    151. 

  151. 					<span class="var-type">mixed</span>
    152. 

  152. 					<a href="#$course_id" title="details" class="var-name">$course_id</a>
    153. 

  153. 				</div>
    154. 

  154. 																<div class="var-title">
    155. 

  155. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    156. 

  156. 					<span class="var-type">mixed</span>
    157. 

  157. 					<a href="#$login_security_token" title="details" class="var-name">$login_security_token</a>
    158. 

  158. 				</div>
    159. 

  159. 																<div class="var-title">
    160. 

  160. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    161. 

  161. 					<span class="var-type">mixed</span>
    162. 

  162. 					<a href="#$login_zone_pos" title="details" class="var-name">$login_zone_pos</a>
    163. 

  163. 				</div>
    164. 

  164. 																<div class="var-title">
    165. 

  165. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    166. 

  166. 					<span class="var-type">mixed</span>
    167. 

  167. 					<a href="#$module_id" title="details" class="var-name">$module_id</a>
    168. 

  168. 				</div>
    169. 

  169. 																<div class="var-title">
    170. 

  170. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    171. 

  171. 					<span class="var-type">mixed</span>
    172. 

  172. 					<a href="#$password" title="details" class="var-name">$password</a>
    173. 

  173. 				</div>
    174. 

  174. 																<div class="var-title">
    175. 

  175. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    176. 

  176. 					<span class="var-type">bool</span>
    177. 

  177. 					<a href="#$request_data_processed" title="details" class="var-name">$request_data_processed</a>
    178. 

  178. 				</div>
    179. 

  179. 																<div class="var-title">
    180. 

  180. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    181. 

  181. 					<span class="var-type"><a href="../sloodle/SloodleLSLResponse.html">SloodleLSLResponse</a></span>
    182. 

  182. 					<a href="#$response" title="details" class="var-name">$response</a>
    183. 

  183. 				</div>
    184. 

  184. 																<div class="var-title">
    185. 

  185. 					<img src="../media/images/PrivateVariable.png" alt=" " />
    186. 

  186. 					<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
    187. 

  187. 					<a href="#$user" title="details" class="var-name">$user</a>
    188. 

  188. 				</div>
    189. 

  189. 											</div>
    190. 

  190. 		</div>
    191. 

  191. 	</div>
    192. 

  192. 

  193. 	<a name="sec-method-summary"></a>
    194. 

  194. 	<div class="info-box">
    195. 

  195. 		<div class="info-box-title">Method Summary</span></div>
    196. 

  196. 		<div class="nav-bar">
    197. 

  197. 			<a href="#sec-description">Description</a> |
    198. 

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

  199. 				 
    200. 

  200. 				|
    201. 

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

  202. 		</div>
    203. 

  203. 		<div class="info-box-body">			
    204. 

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

  205. 																																																																																																																																																																															
    206. 

  206. 				<div class="method-definition">
    207. 

  207. 					<img src="../media/images/Constructor.png" alt=" "/>
    208. 

  208. 											<span class="method-result">SloodleLSLRequest</span>
    209. 

  209. 										<a href="#SloodleLSLRequest" title="details" class="method-name">SloodleLSLRequest</a>
    210. 

  210. 											(<span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$user</span>, <span class="var-type"><a href="../sloodle/SloodleLSLResponse.html">SloodleLSLResponse</a></span>&nbsp;<span class="var-name">$response</span>, <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
    211. 

  211. 									</div>
    212. 

  212. 															
    213. 

  213. 				<div class="method-definition">
    214. 

  214. 					<img src="../media/images/Method.png" alt=" "/>
    215. 

  215. 											<span class="method-result">bool</span>
    216. 

  216. 										<a href="#authenticate_request" title="details" class="method-name">authenticate_request</a>
    217. 

  217. 											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">TRUE</span>])
    218. 

  218. 									</div>
    219. 

  219. 															
    220. 

  220. 				<div class="method-definition">
    221. 

  221. 					<img src="../media/images/Method.png" alt=" "/>
    222. 

  222. 											<span class="method-result">int</span>
    223. 

  223. 										<a href="#get_auth_status" title="details" class="method-name">get_auth_status</a>
    224. 

  224. 										()
    225. 

  225. 									</div>
    226. 

  226. 															
    227. 

  227. 				<div class="method-definition">
    228. 

  228. 					<img src="../media/images/Method.png" alt=" "/>
    229. 

  229. 											<span class="method-result">string|null</span>
    230. 

  230. 										<a href="#get_avatar_name" title="details" class="method-name">get_avatar_name</a>
    231. 

  231. 										()
    232. 

  232. 									</div>
    233. 

  233. 															
    234. 

  234. 				<div class="method-definition">
    235. 

  235. 					<img src="../media/images/Method.png" alt=" "/>
    236. 

  236. 											<span class="method-result">string|null</span>
    237. 

  237. 										<a href="#get_avatar_uuid" title="details" class="method-name">get_avatar_uuid</a>
    238. 

  238. 										()
    239. 

  239. 									</div>
    240. 

  240. 															
    241. 

  241. 				<div class="method-definition">
    242. 

  242. 					<img src="../media/images/Method.png" alt=" "/>
    243. 

  243. 											<span class="method-result">integer|null</span>
    244. 

  244. 										<a href="#get_course_id" title="details" class="method-name">get_course_id</a>
    245. 

  245. 										()
    246. 

  246. 									</div>
    247. 

  247. 															
    248. 

  248. 				<div class="method-definition">
    249. 

  249. 					<img src="../media/images/Method.png" alt=" "/>
    250. 

  250. 											<span class="method-result">object A</span>
    251. 

  251. 										<a href="#get_course_module_instance" title="details" class="method-name">get_course_module_instance</a>
    252. 

  252. 											([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">''</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">TRUE</span>])
    253. 

  253. 									</div>
    254. 

  254. 															
    255. 

  255. 				<div class="method-definition">
    256. 

  256. 					<img src="../media/images/Method.png" alt=" "/>
    257. 

  257. 											<span class="method-result">object A</span>
    258. 

  258. 										<a href="#get_course_record" title="details" class="method-name">get_course_record</a>
    259. 

  259. 											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">TRUE</span>])
    260. 

  260. 									</div>
    261. 

  261. 															
    262. 

  262. 				<div class="method-definition">
    263. 

  263. 					<img src="../media/images/Method.png" alt=" "/>
    264. 

  264. 											<span class="method-result">string|null</span>
    265. 

  265. 										<a href="#get_login_security_token" title="details" class="method-name">get_login_security_token</a>
    266. 

  266. 										()
    267. 

  267. 									</div>
    268. 

  268. 															
    269. 

  269. 				<div class="method-definition">
    270. 

  270. 					<img src="../media/images/Method.png" alt=" "/>
    271. 

  271. 											<span class="method-result">integer|null</span>
    272. 

  272. 										<a href="#get_module_id" title="details" class="method-name">get_module_id</a>
    273. 

  273. 										()
    274. 

  274. 									</div>
    275. 

  275. 															
    276. 

  276. 				<div class="method-definition">
    277. 

  277. 					<img src="../media/images/Method.png" alt=" "/>
    278. 

  278. 											<span class="method-result">string|null</span>
    279. 

  279. 										<a href="#get_password" title="details" class="method-name">get_password</a>
    280. 

  280. 										()
    281. 

  281. 									</div>
    282. 

  282. 															
    283. 

  283. 				<div class="method-definition">
    284. 

  284. 					<img src="../media/images/Method.png" alt=" "/>
    285. 

  285. 											<span class="method-result">&SloodleLSLResponse</span>
    286. 

  286. 										<a href="#get_response" title="details" class="method-name">get_response</a>
    287. 

  287. 										()
    288. 

  288. 									</div>
    289. 

  289. 															
    290. 

  290. 				<div class="method-definition">
    291. 

  291. 					<img src="../media/images/Method.png" alt=" "/>
    292. 

  292. 											<span class="method-result">&SloodleUser</span>
    293. 

  293. 										<a href="#get_user" title="details" class="method-name">get_user</a>
    294. 

  294. 										()
    295. 

  295. 									</div>
    296. 

  296. 															
    297. 

  297. 				<div class="method-definition">
    298. 

  298. 					<img src="../media/images/Method.png" alt=" "/>
    299. 

  299. 											<span class="method-result">bool</span>
    300. 

  300. 										<a href="#is_authenticated" title="details" class="method-name">is_authenticated</a>
    301. 

  301. 										()
    302. 

  302. 									</div>
    303. 

  303. 															
    304. 

  304. 				<div class="method-definition">
    305. 

  305. 					<img src="../media/images/Method.png" alt=" "/>
    306. 

  306. 											<span class="method-result">bool</span>
    307. 

  307. 										<a href="#is_auth_failed" title="details" class="method-name">is_auth_failed</a>
    308. 

  308. 										()
    309. 

  309. 									</div>
    310. 

  310. 															
    311. 

  311. 				<div class="method-definition">
    312. 

  312. 					<img src="../media/images/Method.png" alt=" "/>
    313. 

  313. 											<span class="method-result">bool</span>
    314. 

  314. 										<a href="#is_request_data_processed" title="details" class="method-name">is_request_data_processed</a>
    315. 

  315. 										()
    316. 

  316. 									</div>
    317. 

  317. 															
    318. 

  318. 				<div class="method-definition">
    319. 

  319. 					<img src="../media/images/Method.png" alt=" "/>
    320. 

  320. 											<span class="method-result">void</span>
    321. 

  321. 										<a href="#process_request_data" title="details" class="method-name">process_request_data</a>
    322. 

  322. 											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$force</span> = <span class="var-default">FALSE</span>])
    323. 

  323. 									</div>
    324. 

  324. 															
    325. 

  325. 				<div class="method-definition">
    326. 

  326. 					<img src="../media/images/Method.png" alt=" "/>
    327. 

  327. 											<span class="method-result">mixed</span>
    328. 

  328. 										<a href="#required_param" title="details" class="method-name">required_param</a>
    329. 

  329. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$parname</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">PARAM_RAW</span>])
    330. 

  330. 									</div>
    331. 

  331. 															
    332. 

  332. 				<div class="method-definition">
    333. 

  333. 					<img src="../media/images/Method.png" alt=" "/>
    334. 

  334. 											<span class="method-result">void</span>
    335. 

  335. 										<a href="#set_response" title="details" class="method-name">set_response</a>
    336. 

  336. 											(<span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../sloodle/SloodleLSLResponse.html">SloodleLSLResponse</a></span>&nbsp;<span class="var-name">$response</span>)
    337. 

  337. 									</div>
    338. 

  338. 															
    339. 

  339. 				<div class="method-definition">
    340. 

  340. 					<img src="../media/images/Method.png" alt=" "/>
    341. 

  341. 											<span class="method-result">void</span>
    342. 

  342. 										<a href="#set_user" title="details" class="method-name">set_user</a>
    343. 

  343. 											(<span class="var-type"></span>&nbsp;<span class="var-name">&$user</span>, <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
    344. 

  344. 									</div>
    345. 

  345. 											</div>
    346. 

  346. 		</div>
    347. 

  347. 	</div>		
    348. 

  348. 

  349. 	<a name="sec-vars"></a>
    350. 

  350. 	<div class="info-box">
    351. 

  351. 		<div class="info-box-title">Variables</div>
    352. 

  352. 		<div class="nav-bar">
    353. 

  353. 			<a href="#sec-description">Description</a> |
    354. 

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

  355. 						
    356. 

  356. 			
    357. 

  357. 										| 
    358. 

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

  359. 							
    360. 

  360. 					</div>
    361. 

  361. 		<div class="info-box-body">
    362. 

  362. 			
    363. 

  363. <a name="var$auth_status" id="$auth_status"><!-- --></A>
    364. 

  364. <div class="evenrow">
    365. 

  365. 

  366. 	<div class="var-header">
    367. 

  367. 		<img src="../media/images/PrivateVariable.png" />
    368. 

  368. 		<span class="var-title">
    369. 

  369. 			<span class="var-type">int</span>
    370. 

  370. 			<span class="var-name">$auth_status</span>
    371. 

  371. 			 = <span class="var-default"> SLOODLE_AUTH_UNKNOWN</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a737">737</a></span>)
    372. 

  372. 		</span>
    373. 

  373. 	</div>
    374. 

  374. 

  375. 	<!-- ========== Info from phpDoc block ========= -->
    376. 

  376. <p class="short-description">Indicates the status of request authentication.</p>
    377. 

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

  378. 				<li><span class="field">see:</span> <a href="../sloodle/_lib---sl_iolib.php.html#defineSLOODLE_AUTH_FAILED">SLOODLE_AUTH_FAILED</a></li>
    379. 

  379. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLRequest.html#methodauthenticate_request">SloodleLSLRequest::authenticate_request()</a></li>
    380. 

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

  381. 				<li><span class="field">see:</span> <a href="../sloodle/_lib---sl_iolib.php.html#defineSLOODLE_AUTH_OK">SLOODLE_AUTH_OK</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$avatar_name" id="$avatar_name"><!-- --></A>
    391. 

  391. <div class="oddrow">
    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">mixed</span>
    397. 

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

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

  399. 		</span>
    400. 

  400. 	</div>
    401. 

  401. 

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

  403. <p class="short-description">String name of the SL agent specified in the request (or NULL if not specified).</p>
    404. 

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

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

  406. 			</ul>
    407. 

  407. 	
    408. 

  408. 	
    409. 

  409. 		
    410. 

  410. 		
    411. 

  411. 

  412. </div>
    413. 

  413. <a name="var$avatar_uuid" id="$avatar_uuid"><!-- --></A>
    414. 

  414. <div class="evenrow">
    415. 

  415. 

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

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

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

  419. 			<span class="var-type">mixed</span>
    420. 

  420. 			<span class="var-name">$avatar_uuid</span>
    421. 

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

  422. 		</span>
    423. 

  423. 	</div>
    424. 

  424. 

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

  426. <p class="short-description">String UUID of the SL user agent specified in the request (or NULL if not specified).</p>
    427. 

  427. 	<ul class="tags">
    428. 

  428. 				<li><span class="field">access:</span> private</li>
    429. 

  429. 			</ul>
    430. 

  430. 	
    431. 

  431. 	
    432. 

  432. 		
    433. 

  433. 		
    434. 

  434. 

  435. </div>
    436. 

  436. <a name="var$course_id" id="$course_id"><!-- --></A>
    437. 

  437. <div class="oddrow">
    438. 

  438. 

  439. 	<div class="var-header">
    440. 

  440. 		<img src="../media/images/PrivateVariable.png" />
    441. 

  441. 		<span class="var-title">
    442. 

  442. 			<span class="var-type">mixed</span>
    443. 

  443. 			<span class="var-name">$course_id</span>
    444. 

  444. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a749">749</a></span>)
    445. 

  445. 		</span>
    446. 

  446. 	</div>
    447. 

  447. 

  448. 	<!-- ========== Info from phpDoc block ========= -->
    449. 

  449. <p class="short-description">Integer ID of the course specified in the request (or NULL if not specified).</p>
    450. 

  450. 	<ul class="tags">
    451. 

  451. 				<li><span class="field">access:</span> private</li>
    452. 

  452. 			</ul>
    453. 

  453. 	
    454. 

  454. 	
    455. 

  455. 		
    456. 

  456. 		
    457. 

  457. 

  458. </div>
    459. 

  459. <a name="var$login_security_token" id="$login_security_token"><!-- --></A>
    460. 

  460. <div class="evenrow">
    461. 

  461. 

  462. 	<div class="var-header">
    463. 

  463. 		<img src="../media/images/PrivateVariable.png" />
    464. 

  464. 		<span class="var-title">
    465. 

  465. 			<span class="var-type">mixed</span>
    466. 

  466. 			<span class="var-name">$login_security_token</span>
    467. 

  467. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a773">773</a></span>)
    468. 

  468. 		</span>
    469. 

  469. 	</div>
    470. 

  470. 

  471. 	<!-- ========== Info from phpDoc block ========= -->
    472. 

  472. <p class="short-description">String containing the login security token specified in the request (or NULL if not specified).</p>
    473. 

  473. 	<ul class="tags">
    474. 

  474. 				<li><span class="field">access:</span> private</li>
    475. 

  475. 			</ul>
    476. 

  476. 	
    477. 

  477. 	
    478. 

  478. 		
    479. 

  479. 		
    480. 

  480. 

  481. </div>
    482. 

  482. <a name="var$login_zone_pos" id="$login_zone_pos"><!-- --></A>
    483. 

  483. <div class="oddrow">
    484. 

  484. 

  485. 	<div class="var-header">
    486. 

  486. 		<img src="../media/images/PrivateVariable.png" />
    487. 

  487. 		<span class="var-title">
    488. 

  488. 			<span class="var-type">mixed</span>
    489. 

  489. 			<span class="var-name">$login_zone_pos</span>
    490. 

  490. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a743">743</a></span>)
    491. 

  491. 		</span>
    492. 

  492. 	</div>
    493. 

  493. 

  494. 	<!-- ========== Info from phpDoc block ========= -->
    495. 

  495. <p class="short-description">A 3-element array containing the LoginZone position vector specified in HTTP request parameters (or NULL if not specified).</p>
    496. 

  496. 	<ul class="tags">
    497. 

  497. 				<li><span class="field">access:</span> private</li>
    498. 

  498. 			</ul>
    499. 

  499. 	
    500. 

  500. 	
    501. 

  501. 		
    502. 

  502. 		
    503. 

  503. 

  504. </div>
    505. 

  505. <a name="var$module_id" id="$module_id"><!-- --></A>
    506. 

  506. <div class="evenrow">
    507. 

  507. 

  508. 	<div class="var-header">
    509. 

  509. 		<img src="../media/images/PrivateVariable.png" />
    510. 

  510. 		<span class="var-title">
    511. 

  511. 			<span class="var-type">mixed</span>
    512. 

  512. 			<span class="var-name">$module_id</span>
    513. 

  513. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a755">755</a></span>)
    514. 

  514. 		</span>
    515. 

  515. 	</div>
    516. 

  516. 

  517. 	<!-- ========== Info from phpDoc block ========= -->
    518. 

  518. <p class="short-description">Integer ID of the course module instance specified in the request (or NULL if not specified).</p>
    519. 

  519. 	<ul class="tags">
    520. 

  520. 				<li><span class="field">access:</span> private</li>
    521. 

  521. 			</ul>
    522. 

  522. 	
    523. 

  523. 	
    524. 

  524. 		
    525. 

  525. 		
    526. 

  526. 

  527. </div>
    528. 

  528. <a name="var$password" id="$password"><!-- --></A>
    529. 

  529. <div class="oddrow">
    530. 

  530. 

  531. 	<div class="var-header">
    532. 

  532. 		<img src="../media/images/PrivateVariable.png" />
    533. 

  533. 		<span class="var-title">
    534. 

  534. 			<span class="var-type">mixed</span>
    535. 

  535. 			<span class="var-name">$password</span>
    536. 

  536. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a726">726</a></span>)
    537. 

  537. 		</span>
    538. 

  538. 	</div>
    539. 

  539. 

  540. 	<!-- ========== Info from phpDoc block ========= -->
    541. 

  541. <p class="short-description">Contains the password specified in HTTP request parameters (or NULL if not specified).</p>
    542. 

  542. 	<ul class="tags">
    543. 

  543. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLRequest.html#methodauthenticate_request">SloodleLSLRequest::authenticate_request()</a></li>
    544. 

  544. 				<li><span class="field">access:</span> private</li>
    545. 

  545. 			</ul>
    546. 

  546. 	
    547. 

  547. 	
    548. 

  548. 		
    549. 

  549. 		
    550. 

  550. 

  551. </div>
    552. 

  552. <a name="var$request_data_processed" id="$request_data_processed"><!-- --></A>
    553. 

  553. <div class="evenrow">
    554. 

  554. 

  555. 	<div class="var-header">
    556. 

  556. 		<img src="../media/images/PrivateVariable.png" />
    557. 

  557. 		<span class="var-title">
    558. 

  558. 			<span class="var-type">bool</span>
    559. 

  559. 			<span class="var-name">$request_data_processed</span>
    560. 

  560. 			 = <span class="var-default"> FALSE</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a719">719</a></span>)
    561. 

  561. 		</span>
    562. 

  562. 	</div>
    563. 

  563. 

  564. 	<!-- ========== Info from phpDoc block ========= -->
    565. 

  565. <p class="short-description">Indicates whether or not the request data has been processed by the process_request_data() function.</p>
    566. 

  566. 	<ul class="tags">
    567. 

  567. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLRequest.html#methodprocess_request_data">SloodleLSLRequest::process_request_data()</a></li>
    568. 

  568. 				<li><span class="field">access:</span> private</li>
    569. 

  569. 			</ul>
    570. 

  570. 	
    571. 

  571. 	
    572. 

  572. 		
    573. 

  573. 		
    574. 

  574. 

  575. </div>
    576. 

  576. <a name="var$response" id="$response"><!-- --></A>
    577. 

  577. <div class="oddrow">
    578. 

  578. 

  579. 	<div class="var-header">
    580. 

  580. 		<img src="../media/images/PrivateVariable.png" />
    581. 

  581. 		<span class="var-title">
    582. 

  582. 			<span class="var-type"><a href="../sloodle/SloodleLSLResponse.html">SloodleLSLResponse</a></span>
    583. 

  583. 			<span class="var-name">$response</span>
    584. 

  584. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a787">787</a></span>)
    585. 

  585. 		</span>
    586. 

  586. 	</div>
    587. 

  587. 

  588. 	<!-- ========== Info from phpDoc block ========= -->
    589. 

  589. <p class="short-description">The object used to output response data.</p>
    590. 

  590. <p class="description"><p>The object reference may be provided externally in the parameters of the constructor (<a href="../sloodle/SloodleLSLRequest.html#methodSloodleLSLRequest">SloodleLSLRequest()</a>) or via the (<a href="../sloodle/SloodleLSLRequest.html#methodset_response">set_response()</a>) accessor.  Otherwise, it will have been instantiated by this object itself.</p></p>
    591. 

  591. 	<ul class="tags">
    592. 

  592. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLRequest.html#methodset_response">SloodleLSLRequest::set_response()</a></li>
    593. 

  593. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLRequest.html#methodget_response">SloodleLSLRequest::get_response()</a></li>
    594. 

  594. 				<li><span class="field">access:</span> private</li>
    595. 

  595. 			</ul>
    596. 

  596. 	
    597. 

  597. 	
    598. 

  598. 		
    599. 

  599. 		
    600. 

  600. 

  601. </div>
    602. 

  602. <a name="var$user" id="$user"><!-- --></A>
    603. 

  603. <div class="evenrow">
    604. 

  604. 

  605. 	<div class="var-header">
    606. 

  606. 		<img src="../media/images/PrivateVariable.png" />
    607. 

  607. 		<span class="var-title">
    608. 

  608. 			<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
    609. 

  609. 			<span class="var-name">$user</span>
    610. 

  610. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a798">798</a></span>)
    611. 

  611. 		</span>
    612. 

  612. 	</div>
    613. 

  613. 

  614. 	<!-- ========== Info from phpDoc block ========= -->
    615. 

  615. <p class="short-description">The object used to store and process incoming user data.</p>
    616. 

  616. <p class="description"><p>The object reference may be provided externally in the parameters of the constructor (<a href="../sloodle/SloodleLSLRequest.html#methodSloodleLSLRequest">SloodleLSLRequest()</a>) or via the (<a href="../sloodle/SloodleLSLRequest.html#methodset_user">set_user()</a>) accessor.  Otherwise, it will have been instantiated by this object itself.</p></p>
    617. 

  617. 	<ul class="tags">
    618. 

  618. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLRequest.html#methodset_user">SloodleLSLRequest::set_user()</a></li>
    619. 

  619. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLRequest.html#methodget_user">SloodleLSLRequest::get_user()</a></li>
    620. 

  620. 				<li><span class="field">access:</span> private</li>
    621. 

  621. 			</ul>
    622. 

  622. 	
    623. 

  623. 	
    624. 

  624. 		
    625. 

  625. 		
    626. 

  626. 

  627. </div>
    628. 

  628. 
						
    629. 

  629. 		</div>
    630. 

  630. 	</div>
    631. 

  631. 	
    632. 

  632. 	<a name="sec-methods"></a>
    633. 

  633. 	<div class="info-box">
    634. 

  634. 		<div class="info-box-title">Methods</div>
    635. 

  635. 		<div class="nav-bar">
    636. 

  636. 			<a href="#sec-description">Description</a> |
    637. 

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

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

  639. 						
    640. 

  640. 		</div>
    641. 

  641. 		<div class="info-box-body">
    642. 

  642. 			<A NAME='method_detail'></A>
    643. 

  643. <a name="methodSloodleLSLRequest" id="SloodleLSLRequest"><!-- --></a>
    644. 

  644. <div class="oddrow">
    645. 

  645. 	
    646. 

  646. 	<div class="method-header">
    647. 

  647. 		<img src="../media/images/Constructor.png" />
    648. 

  648. 		<span class="method-title">Constructor SloodleLSLRequest</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a973">973</a></span>)
    649. 

  649. 	</div> 
    650. 

  650. 	
    651. 

  651. 	<!-- ========== Info from phpDoc block ========= -->
    652. 

  652. <p class="short-description"><em>Constructor</em><ul><li>initialises the user and response objects.</li></ul></p>
    653. 

  653. <p class="description"><p>If the parameters provide references to appropriate objects, then the constructor will store them.  However, if the parameters are NULL, then the constructor will create its own instances.</p></p>
    654. 

  654. 	
    655. 

  655. 	<div class="method-signature">
    656. 

  656. 		<span class="method-result">SloodleLSLRequest</span>
    657. 

  657. 		<span class="method-name">
    658. 

  658. 			SloodleLSLRequest
    659. 

  659. 		</span>
    660. 

  660. 					(<span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$user</span>, <span class="var-type"><a href="../sloodle/SloodleLSLResponse.html">SloodleLSLResponse</a></span>&nbsp;<span class="var-name">$response</span>, <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
    661. 

  661. 			</div>
    662. 

  662. 	
    663. 

  663. 			<ul class="parameters">
    664. 

  664. 					<li>
    665. 

  665. 				<span class="var-type"><a href="../sloodle/SloodleLSLResponse.html">SloodleLSLResponse</a></span>
    666. 

  666. 				<span class="var-name">$response</span><span class="var-description">: Reference to the response object which this object should use, or NULL</span>			</li>
    667. 

  667. 					<li>
    668. 

  668. 				<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
    669. 

  669. 				<span class="var-name">$user</span><span class="var-description">: Refernce to the user object which this object should use, or NULL</span>			</li>
    670. 

  670. 					<li>
    671. 

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

  672. 				<span class="var-name">&$response</span>			</li>
    673. 

  673. 					<li>
    674. 

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

  675. 				<span class="var-name">&$user</span>			</li>
    676. 

  676. 				</ul>
    677. 

  677. 		
    678. 

  678. 			
    679. 

  679. 	</div>
    680. 

  680. <a name="methodauthenticate_request" id="authenticate_request"><!-- --></a>
    681. 

  681. <div class="evenrow">
    682. 

  682. 	
    683. 

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

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

  685. 		<span class="method-title">authenticate_request</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a1057">1057</a></span>)
    686. 

  686. 	</div> 
    687. 

  687. 	
    688. 

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

  689. <p class="short-description">Authenticates the request against the site using the password parameter.</p>
    690. 

  690. <p class="description"><p>This function can use both site-wide or object-specific prim passwords (the latter of which   uses the 'sloodle_active_object' table in the database).  It will also set the content of member {$link $auth_status} as appropriate.</p></p>
    691. 

  691. 	<ul class="tags">
    692. 

  692. 				<li><span class="field">return:</span> TRUE if successful in authenticating the request, or FALSE if not.</li>
    693. 

  693. 			</ul>
    694. 

  694. 	
    695. 

  695. 	<div class="method-signature">
    696. 

  696. 		<span class="method-result">bool</span>
    697. 

  697. 		<span class="method-name">
    698. 

  698. 			authenticate_request
    699. 

  699. 		</span>
    700. 

  700. 					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">TRUE</span>])
    701. 

  701. 			</div>
    702. 

  702. 	
    703. 

  703. 			<ul class="parameters">
    704. 

  704. 					<li>
    705. 

  705. 				<span class="var-type">bool</span>
    706. 

  706. 				<span class="var-name">$require</span><span class="var-description">: If TRUE, the function will NOT return on authentication failure. Rather, it will terminate the script with an error message.</span>			</li>
    707. 

  707. 				</ul>
    708. 

  708. 		
    709. 

  709. 			
    710. 

  710. 	</div>
    711. 

  711. <a name="methodget_auth_status" id="get_auth_status"><!-- --></a>
    712. 

  712. <div class="oddrow">
    713. 

  713. 	
    714. 

  714. 	<div class="method-header">
    715. 

  715. 		<img src="../media/images/Method.png" />
    716. 

  716. 		<span class="method-title">get_auth_status</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a818">818</a></span>)
    717. 

  717. 	</div> 
    718. 

  718. 	
    719. 

  719. 	<!-- ========== Info from phpDoc block ========= -->
    720. 

  720. <p class="short-description">Returns member variable $auth_status.</p>
    721. 

  721. 	<ul class="tags">
    722. 

  722. 				<li><span class="field">return:</span> One of: <a href="../sloodle/_lib---sl_iolib.php.html#defineSLOODLE_AUTH_OK">SLOODLE_AUTH_OK</a>, <a href="../sloodle/_lib---sl_iolib.php.html#defineSLOODLE_AUTH_UNKNOWN">SLOODLE_AUTH_UNKNOWN</a>, or <a href="../sloodle/_lib---sl_iolib.php.html#defineSLOODLE_AUTH_FAILED">SLOODLE_AUTH_FAILED</a>.</li>
    723. 

  723. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLRequest.html#methodauthenticate_request">SloodleLSLRequest::authenticate_request()</a></li>
    724. 

  724. 			</ul>
    725. 

  725. 	
    726. 

  726. 	<div class="method-signature">
    727. 

  727. 		<span class="method-result">int</span>
    728. 

  728. 		<span class="method-name">
    729. 

  729. 			get_auth_status
    730. 

  730. 		</span>
    731. 

  731. 				()
    732. 

  732. 			</div>
    733. 

  733. 	
    734. 

  734. 		
    735. 

  735. 			
    736. 

  736. 	</div>
    737. 

  737. <a name="methodget_avatar_name" id="get_avatar_name"><!-- --></a>
    738. 

  738. <div class="evenrow">
    739. 

  739. 	
    740. 

  740. 	<div class="method-header">
    741. 

  741. 		<img src="../media/images/Method.png" />
    742. 

  742. 		<span class="method-title">get_avatar_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a919">919</a></span>)
    743. 

  743. 	</div> 
    744. 

  744. 	
    745. 

  745. 	<!-- ========== Info from phpDoc block ========= -->
    746. 

  746. <p class="short-description">Returns member value $avatar_name.</p>
    747. 

  747. <p class="description"><p>Note: this function will ensure that <a href="../sloodle/SloodleLSLRequest.html#methodprocess_request_data">process_request_data()</a> has already been called prior to execution.</p></p>
    748. 

  748. 	<ul class="tags">
    749. 

  749. 				<li><span class="field">return:</span> The avatar name provided in the request parameters, or NULL if there wasn't one</li>
    750. 

  750. 			</ul>
    751. 

  751. 	
    752. 

  752. 	<div class="method-signature">
    753. 

  753. 		<span class="method-result">string|null</span>
    754. 

  754. 		<span class="method-name">
    755. 

  755. 			get_avatar_name
    756. 

  756. 		</span>
    757. 

  757. 				()
    758. 

  758. 			</div>
    759. 

  759. 	
    760. 

  760. 		
    761. 

  761. 			
    762. 

  762. 	</div>
    763. 

  763. <a name="methodget_avatar_uuid" id="get_avatar_uuid"><!-- --></a>
    764. 

  764. <div class="oddrow">
    765. 

  765. 	
    766. 

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

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

  768. 		<span class="method-title">get_avatar_uuid</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a907">907</a></span>)
    769. 

  769. 	</div> 
    770. 

  770. 	
    771. 

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

  772. <p class="short-description">Returns member value $avatar_uuid.</p>
    773. 

  773. <p class="description"><p>Note: this function will ensure that <a href="../sloodle/SloodleLSLRequest.html#methodprocess_request_data">process_request_data()</a> has already been called prior to execution.</p></p>
    774. 

  774. 	<ul class="tags">
    775. 

  775. 				<li><span class="field">return:</span> The avatar UUID provided in the request parameters, or NULL if there wasn't one</li>
    776. 

  776. 			</ul>
    777. 

  777. 	
    778. 

  778. 	<div class="method-signature">
    779. 

  779. 		<span class="method-result">string|null</span>
    780. 

  780. 		<span class="method-name">
    781. 

  781. 			get_avatar_uuid
    782. 

  782. 		</span>
    783. 

  783. 				()
    784. 

  784. 			</div>
    785. 

  785. 	
    786. 

  786. 		
    787. 

  787. 			
    788. 

  788. 	</div>
    789. 

  789. <a name="methodget_course_id" id="get_course_id"><!-- --></a>
    790. 

  790. <div class="evenrow">
    791. 

  791. 	
    792. 

  792. 	<div class="method-header">
    793. 

  793. 		<img src="../media/images/Method.png" />
    794. 

  794. 		<span class="method-title">get_course_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a883">883</a></span>)
    795. 

  795. 	</div> 
    796. 

  796. 	
    797. 

  797. 	<!-- ========== Info from phpDoc block ========= -->
    798. 

  798. <p class="short-description">Returns member value $course_id.</p>
    799. 

  799. <p class="description"><p>Note: this function will ensure that <a href="../sloodle/SloodleLSLRequest.html#methodprocess_request_data">process_request_data()</a> has already been called prior to execution.</p></p>
    800. 

  800. 	<ul class="tags">
    801. 

  801. 				<li><span class="field">return:</span> The course ID provided in the request parameters, or NULL if there wasn't one</li>
    802. 

  802. 			</ul>
    803. 

  803. 	
    804. 

  804. 	<div class="method-signature">
    805. 

  805. 		<span class="method-result">integer|null</span>
    806. 

  806. 		<span class="method-name">
    807. 

  807. 			get_course_id
    808. 

  808. 		</span>
    809. 

  809. 				()
    810. 

  810. 			</div>
    811. 

  811. 	
    812. 

  812. 		
    813. 

  813. 			
    814. 

  814. 	</div>
    815. 

  815. <a name="methodget_course_module_instance" id="get_course_module_instance"><!-- --></a>
    816. 

  816. <div class="oddrow">
    817. 

  817. 	
    818. 

  818. 	<div class="method-header">
    819. 

  819. 		<img src="../media/images/Method.png" />
    820. 

  820. 		<span class="method-title">get_course_module_instance</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a1182">1182</a></span>)
    821. 

  821. 	</div> 
    822. 

  822. 	
    823. 

  823. 	<!-- ========== Info from phpDoc block ========= -->
    824. 

  824. <p class="short-description">Get a course module instance for the module specified in the request  Uses the ID specified in $module_id.</p>
    825. 

  825. 	<ul class="tags">
    826. 

  826. 				<li><span class="field">return:</span> database record if successful, or FALSE if not (e.g. if instance is not found, is not visible, or is not of the correct type)</li>
    827. 

  827. 			</ul>
    828. 

  828. 	
    829. 

  829. 	<div class="method-signature">
    830. 

  830. 		<span class="method-result">object A</span>
    831. 

  831. 		<span class="method-name">
    832. 

  832. 			get_course_module_instance
    833. 

  833. 		</span>
    834. 

  834. 					([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">''</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">TRUE</span>])
    835. 

  835. 			</div>
    836. 

  836. 	
    837. 

  837. 			<ul class="parameters">
    838. 

  838. 					<li>
    839. 

  839. 				<span class="var-type">string</span>
    840. 

  840. 				<span class="var-name">$type</span><span class="var-description">: specifies the name of the module type (e.g. 'forum', 'choice' etc.) - ignored if blank (default).</span>			</li>
    841. 

  841. 					<li>
    842. 

  842. 				<span class="var-type">bool</span>
    843. 

  843. 				<span class="var-name">$require</span><span class="var-description">: If TRUE, the function will NOT return failure. Rather, it will terminate the script with an error message.</span>			</li>
    844. 

  844. 				</ul>
    845. 

  845. 		
    846. 

  846. 			
    847. 

  847. 	</div>
    848. 

  848. <a name="methodget_course_record" id="get_course_record"><!-- --></a>
    849. 

  849. <div class="evenrow">
    850. 

  850. 	
    851. 

  851. 	<div class="method-header">
    852. 

  852. 		<img src="../media/images/Method.png" />
    853. 

  853. 		<span class="method-title">get_course_record</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a1126">1126</a></span>)
    854. 

  854. 	</div> 
    855. 

  855. 	
    856. 

  856. 	<!-- ========== Info from phpDoc block ========= -->
    857. 

  857. <p class="short-description">Gets a database record for the course identified in the request.</p>
    858. 

  858. <p class="description"><p>(Note: this function does not check whether or not the user is enrolled in the course)</p></p>
    859. 

  859. 	<ul class="tags">
    860. 

  860. 				<li><span class="field">return:</span> record directly from the database, or NULL if the course is not found.</li>
    861. 

  861. 			</ul>
    862. 

  862. 	
    863. 

  863. 	<div class="method-signature">
    864. 

  864. 		<span class="method-result">object A</span>
    865. 

  865. 		<span class="method-name">
    866. 

  866. 			get_course_record
    867. 

  867. 		</span>
    868. 

  868. 					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">TRUE</span>])
    869. 

  869. 			</div>
    870. 

  870. 	
    871. 

  871. 			<ul class="parameters">
    872. 

  872. 					<li>
    873. 

  873. 				<span class="var-type">bool</span>
    874. 

  874. 				<span class="var-name">$require</span><span class="var-description">: If TRUE, the function will NOT return failure. Rather, it will terminate the script with an error message.</span>			</li>
    875. 

  875. 				</ul>
    876. 

  876. 		
    877. 

  877. 			
    878. 

  878. 	</div>
    879. 

  879. <a name="methodget_login_security_token" id="get_login_security_token"><!-- --></a>
    880. 

  880. <div class="oddrow">
    881. 

  881. 	
    882. 

  882. 	<div class="method-header">
    883. 

  883. 		<img src="../media/images/Method.png" />
    884. 

  884. 		<span class="method-title">get_login_security_token</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a931">931</a></span>)
    885. 

  885. 	</div> 
    886. 

  886. 	
    887. 

  887. 	<!-- ========== Info from phpDoc block ========= -->
    888. 

  888. <p class="short-description">Returns member value $login_security_token.</p>
    889. 

  889. <p class="description"><p>Note: this function will ensure that <a href="../sloodle/SloodleLSLRequest.html#methodprocess_request_data">process_request_data()</a> has already been called prior to execution.</p></p>
    890. 

  890. 	<ul class="tags">
    891. 

  891. 				<li><span class="field">return:</span> The login security token provided in the request parameters, or NULL if there wasn't one</li>
    892. 

  892. 			</ul>
    893. 

  893. 	
    894. 

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

  895. 		<span class="method-result">string|null</span>
    896. 

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

  897. 			get_login_security_token
    898. 

  898. 		</span>
    899. 

  899. 				()
    900. 

  900. 			</div>
    901. 

  901. 	
    902. 

  902. 		
    903. 

  903. 			
    904. 

  904. 	</div>
    905. 

  905. <a name="methodget_module_id" id="get_module_id"><!-- --></a>
    906. 

  906. <div class="evenrow">
    907. 

  907. 	
    908. 

  908. 	<div class="method-header">
    909. 

  909. 		<img src="../media/images/Method.png" />
    910. 

  910. 		<span class="method-title">get_module_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a895">895</a></span>)
    911. 

  911. 	</div> 
    912. 

  912. 	
    913. 

  913. 	<!-- ========== Info from phpDoc block ========= -->
    914. 

  914. <p class="short-description">Returns member value $module_id.</p>
    915. 

  915. <p class="description"><p>Note: this function will ensure that <a href="../sloodle/SloodleLSLRequest.html#methodprocess_request_data">process_request_data()</a> has already been called prior to execution.</p></p>
    916. 

  916. 	<ul class="tags">
    917. 

  917. 				<li><span class="field">return:</span> The course module instance ID provided in the request parameters, or NULL if there wasn't one</li>
    918. 

  918. 			</ul>
    919. 

  919. 	
    920. 

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

  921. 		<span class="method-result">integer|null</span>
    922. 

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

  923. 			get_module_id
    924. 

  924. 		</span>
    925. 

  925. 				()
    926. 

  926. 			</div>
    927. 

  927. 	
    928. 

  928. 		
    929. 

  929. 			
    930. 

  930. 	</div>
    931. 

  931. <a name="methodget_password" id="get_password"><!-- --></a>
    932. 

  932. <div class="oddrow">
    933. 

  933. 	
    934. 

  934. 	<div class="method-header">
    935. 

  935. 		<img src="../media/images/Method.png" />
    936. 

  936. 		<span class="method-title">get_password</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a871">871</a></span>)
    937. 

  937. 	</div> 
    938. 

  938. 	
    939. 

  939. 	<!-- ========== Info from phpDoc block ========= -->
    940. 

  940. <p class="short-description">Returns member value $password.</p>
    941. 

  941. <p class="description"><p>Note: this function will ensure that <a href="../sloodle/SloodleLSLRequest.html#methodprocess_request_data">process_request_data()</a> has already been called prior to execution.</p></p>
    942. 

  942. 	<ul class="tags">
    943. 

  943. 				<li><span class="field">return:</span> The password provided in the request parameters, or NULL if there wasn't one</li>
    944. 

  944. 			</ul>
    945. 

  945. 	
    946. 

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

  947. 		<span class="method-result">string|null</span>
    948. 

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

  949. 			get_password
    950. 

  950. 		</span>
    951. 

  951. 				()
    952. 

  952. 			</div>
    953. 

  953. 	
    954. 

  954. 		
    955. 

  955. 			
    956. 

  956. 	</div>
    957. 

  957. <a name="methodget_response" id="get_response"><!-- --></a>
    958. 

  958. <div class="evenrow">
    959. 

  959. 	
    960. 

  960. 	<div class="method-header">
    961. 

  961. 		<img src="../media/images/Method.png" />
    962. 

  962. 		<span class="method-title">get_response</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a943">943</a></span>)
    963. 

  963. 	</div> 
    964. 

  964. 	
    965. 

  965. 	<!-- ========== Info from phpDoc block ========= -->
    966. 

  966. <p class="short-description">Returns member value $response.</p>
    967. 

  967. <p class="description"><p>Note: this function will ensure that <a href="../sloodle/SloodleLSLRequest.html#methodprocess_request_data">process_request_data()</a> has already been called prior to execution.</p></p>
    968. 

  968. 	<ul class="tags">
    969. 

  969. 				<li><span class="field">return:</span> A reference to the response object used by this object</li>
    970. 

  970. 			</ul>
    971. 

  971. 	
    972. 

  972. 	<div class="method-signature">
    973. 

  973. 		<span class="method-result">&SloodleLSLResponse</span>
    974. 

  974. 		<span class="method-name">
    975. 

  975. 			get_response
    976. 

  976. 		</span>
    977. 

  977. 				()
    978. 

  978. 			</div>
    979. 

  979. 	
    980. 

  980. 		
    981. 

  981. 			
    982. 

  982. 	</div>
    983. 

  983. <a name="methodget_user" id="get_user"><!-- --></a>
    984. 

  984. <div class="oddrow">
    985. 

  985. 	
    986. 

  986. 	<div class="method-header">
    987. 

  987. 		<img src="../media/images/Method.png" />
    988. 

  988. 		<span class="method-title">get_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a955">955</a></span>)
    989. 

  989. 	</div> 
    990. 

  990. 	
    991. 

  991. 	<!-- ========== Info from phpDoc block ========= -->
    992. 

  992. <p class="short-description">Returns member value $user.</p>
    993. 

  993. <p class="description"><p>Note: this function will ensure that <a href="../sloodle/SloodleLSLRequest.html#methodprocess_request_data">process_request_data()</a> has already been called prior to execution.</p></p>
    994. 

  994. 	<ul class="tags">
    995. 

  995. 				<li><span class="field">return:</span> A reference to the user object used by this object</li>
    996. 

  996. 			</ul>
    997. 

  997. 	
    998. 

  998. 	<div class="method-signature">
    999. 

  999. 		<span class="method-result">&SloodleUser</span>
    1000. 

  1000. 		<span class="method-name">
    1001. 

  1001. 			get_user
    1002. 

  1002. 		</span>
    1003. 

  1003. 				()
    1004. 

  1004. 			</div>
    1005. 

  1005. 	
    1006. 

  1006. 		
    1007. 

  1007. 			
    1008. 

  1008. 	</div>
    1009. 

  1009. <a name="methodis_authenticated" id="is_authenticated"><!-- --></a>
    1010. 

  1010. <div class="evenrow">
    1011. 

  1011. 	
    1012. 

  1012. 	<div class="method-header">
    1013. 

  1013. 		<img src="../media/images/Method.png" />
    1014. 

  1014. 		<span class="method-title">is_authenticated</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a829">829</a></span>)
    1015. 

  1015. 	</div> 
    1016. 

  1016. 	
    1017. 

  1017. 	<!-- ========== Info from phpDoc block ========= -->
    1018. 

  1018. <p class="short-description">Indicates whether or not request authentication has succeeded.</p>
    1019. 

  1019. 	<ul class="tags">
    1020. 

  1020. 				<li><span class="field">return:</span> TRUE if the request data has been authenticated, or FALSE if it failed or has not been attempted yet</li>
    1021. 

  1021. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLRequest.html#var$auth_status">SloodleLSLRequest::$auth_status</a></li>
    1022. 

  1022. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLRequest.html#methodauthenticate_request">SloodleLSLRequest::authenticate_request()</a></li>
    1023. 

  1023. 			</ul>
    1024. 

  1024. 	
    1025. 

  1025. 	<div class="method-signature">
    1026. 

  1026. 		<span class="method-result">bool</span>
    1027. 

  1027. 		<span class="method-name">
    1028. 

  1028. 			is_authenticated
    1029. 

  1029. 		</span>
    1030. 

  1030. 				()
    1031. 

  1031. 			</div>
    1032. 

  1032. 	
    1033. 

  1033. 		
    1034. 

  1034. 			
    1035. 

  1035. 	</div>
    1036. 

  1036. <a name="methodis_auth_failed" id="is_auth_failed"><!-- --></a>
    1037. 

  1037. <div class="oddrow">
    1038. 

  1038. 	
    1039. 

  1039. 	<div class="method-header">
    1040. 

  1040. 		<img src="../media/images/Method.png" />
    1041. 

  1041. 		<span class="method-title">is_auth_failed</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a840">840</a></span>)
    1042. 

  1042. 	</div> 
    1043. 

  1043. 	
    1044. 

  1044. 	<!-- ========== Info from phpDoc block ========= -->
    1045. 

  1045. <p class="short-description">Indicates whether or not request authentication has failed.</p>
    1046. 

  1046. 	<ul class="tags">
    1047. 

  1047. 				<li><span class="field">return:</span> TRUE if the request data has failed authentication, or FALSE if it passed or has not been attempted yet</li>
    1048. 

  1048. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLRequest.html#var$auth_status">SloodleLSLRequest::$auth_status</a></li>
    1049. 

  1049. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLRequest.html#methodauthenticate_request">SloodleLSLRequest::authenticate_request()</a></li>
    1050. 

  1050. 			</ul>
    1051. 

  1051. 	
    1052. 

  1052. 	<div class="method-signature">
    1053. 

  1053. 		<span class="method-result">bool</span>
    1054. 

  1054. 		<span class="method-name">
    1055. 

  1055. 			is_auth_failed
    1056. 

  1056. 		</span>
    1057. 

  1057. 				()
    1058. 

  1058. 			</div>
    1059. 

  1059. 	
    1060. 

  1060. 		
    1061. 

  1061. 			
    1062. 

  1062. 	</div>
    1063. 

  1063. <a name="methodis_request_data_processed" id="is_request_data_processed"><!-- --></a>
    1064. 

  1064. <div class="evenrow">
    1065. 

  1065. 	
    1066. 

  1066. 	<div class="method-header">
    1067. 

  1067. 		<img src="../media/images/Method.png" />
    1068. 

  1068. 		<span class="method-title">is_request_data_processed</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a808">808</a></span>)
    1069. 

  1069. 	</div> 
    1070. 

  1070. 	
    1071. 

  1071. 	<!-- ========== Info from phpDoc block ========= -->
    1072. 

  1072. <p class="short-description">Returns member variable $request_data_processed.</p>
    1073. 

  1073. 	<ul class="tags">
    1074. 

  1074. 				<li><span class="field">return:</span> TRUE if the request data has been processed, or FALSE if not</li>
    1075. 

  1075. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleLSLRequest.html#methodprocess_request_data">SloodleLSLRequest::process_request_data()</a></li>
    1076. 

  1076. 			</ul>
    1077. 

  1077. 	
    1078. 

  1078. 	<div class="method-signature">
    1079. 

  1079. 		<span class="method-result">bool</span>
    1080. 

  1080. 		<span class="method-name">
    1081. 

  1081. 			is_request_data_processed
    1082. 

  1082. 		</span>
    1083. 

  1083. 				()
    1084. 

  1084. 			</div>
    1085. 

  1085. 	
    1086. 

  1086. 		
    1087. 

  1087. 			
    1088. 

  1088. 	</div>
    1089. 

  1089. <a name="methodprocess_request_data" id="process_request_data"><!-- --></a>
    1090. 

  1090. <div class="oddrow">
    1091. 

  1091. 	
    1092. 

  1092. 	<div class="method-header">
    1093. 

  1093. 		<img src="../media/images/Method.png" />
    1094. 

  1094. 		<span class="method-title">process_request_data</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a1005">1005</a></span>)
    1095. 

  1095. 	</div> 
    1096. 

  1096. 	
    1097. 

  1097. 	<!-- ========== Info from phpDoc block ========= -->
    1098. 

  1098. <p class="short-description">Process all of the standard data provided by the HTTP request.</p>
    1099. 

  1099. <p class="description"><p>This function should normally be called very shortly after the start of a script, as it will   check all the expected HTTP request parameters, perform basic processing, and store the data.  It will also send data to the appropriate SloodleLSLResposne and <a href="../sloodle/SloodleUser.html">SloodleUser</a> objects.  When called, it will check the <a href="../sloodle/SloodleLSLRequest.html#var$request_data_processed">$request_data_processed</a> member to see if it has already been called.  If so, it will not execute again, unless the $force parameter is TRUE.  <strong>Note:</strong> most functions in this class will automatically call this function if needed to ensure data is available.</p></p>
    1100. 

  1100. 	
    1101. 

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

  1102. 		<span class="method-result">void</span>
    1103. 

  1103. 		<span class="method-name">
    1104. 

  1104. 			process_request_data
    1105. 

  1105. 		</span>
    1106. 

  1106. 					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$force</span> = <span class="var-default">FALSE</span>])
    1107. 

  1107. 			</div>
    1108. 

  1108. 	
    1109. 

  1109. 			<ul class="parameters">
    1110. 

  1110. 					<li>
    1111. 

  1111. 				<span class="var-type">bool</span>
    1112. 

  1112. 				<span class="var-name">$force</span><span class="var-description">: If TRUE, then the function is forced to execute again, even if it has already been executed. (Default: FALSE).</span>			</li>
    1113. 

  1113. 				</ul>
    1114. 

  1114. 		
    1115. 

  1115. 			
    1116. 

  1116. 	</div>
    1117. 

  1117. <a name="methodrequired_param" id="required_param"><!-- --></a>
    1118. 

  1118. <div class="evenrow">
    1119. 

  1119. 	
    1120. 

  1120. 	<div class="method-header">
    1121. 

  1121. 		<img src="../media/images/Method.png" />
    1122. 

  1122. 		<span class="method-title">required_param</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a1253">1253</a></span>)
    1123. 

  1123. 	</div> 
    1124. 

  1124. 	
    1125. 

  1125. 	<!-- ========== Info from phpDoc block ========= -->
    1126. 

  1126. <p class="short-description">Obtains a named HTTP request parameter, and terminate with an error message if it has not been provided.</p>
    1127. 

  1127. <p class="description"><p>Note: for LSL linker scripts, this should *always* be used instead of the Moodle function, as this will   render appropraitely formatted error messages, which LSL scripts can understand.</p></p>
    1128. 

  1128. 	<ul class="tags">
    1129. 

  1129. 				<li><span class="field">return:</span> The converted and cleaned parameter if it is found</li>
    1130. 

  1130. 			</ul>
    1131. 

  1131. 	
    1132. 

  1132. 	<div class="method-signature">
    1133. 

  1133. 		<span class="method-result">mixed</span>
    1134. 

  1134. 		<span class="method-name">
    1135. 

  1135. 			required_param
    1136. 

  1136. 		</span>
    1137. 

  1137. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$parname</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">PARAM_RAW</span>])
    1138. 

  1138. 			</div>
    1139. 

  1139. 	
    1140. 

  1140. 			<ul class="parameters">
    1141. 

  1141. 					<li>
    1142. 

  1142. 				<span class="var-type">string</span>
    1143. 

  1143. 				<span class="var-name">$parname</span><span class="var-description">: The name of the HTTP request parameter to get.</span>			</li>
    1144. 

  1144. 					<li>
    1145. 

  1145. 				<span class="var-type">int</span>
    1146. 

  1146. 				<span class="var-name">$type</span><span class="var-description">: Specifies the expected type of parameter, as according to the Moodle documentation.</span>			</li>
    1147. 

  1147. 				</ul>
    1148. 

  1148. 		
    1149. 

  1149. 			
    1150. 

  1150. 	</div>
    1151. 

  1151. <a name="methodset_response" id="set_response"><!-- --></a>
    1152. 

  1152. <div class="oddrow">
    1153. 

  1153. 	
    1154. 

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

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

  1156. 		<span class="method-title">set_response</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a849">849</a></span>)
    1157. 

  1157. 	</div> 
    1158. 

  1158. 	
    1159. 

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

  1160. <p class="short-description">Sets the <a href="../sloodle/SloodleLSLRequest.html#var$response">SloodleLSLRequest::$response</a> member.</p>
    1161. 

  1161. 	
    1162. 

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

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

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

  1165. 			set_response
    1166. 

  1166. 		</span>
    1167. 

  1167. 					(<span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../sloodle/SloodleLSLResponse.html">SloodleLSLResponse</a></span>&nbsp;<span class="var-name">$response</span>)
    1168. 

  1168. 			</div>
    1169. 

  1169. 	
    1170. 

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

  1171. 					<li>
    1172. 

  1172. 				<span class="var-type"><a href="../sloodle/SloodleLSLResponse.html">SloodleLSLResponse</a></span>
    1173. 

  1173. 				<span class="var-name">$response</span><span class="var-description">: Reference to a <a href="../sloodle/SloodleLSLResponse.html">SloodleLSLResponse</a> object</span>			</li>
    1174. 

  1174. 					<li>
    1175. 

  1175. 				<span class="var-type"></span>
    1176. 

  1176. 				<span class="var-name">&$response</span>			</li>
    1177. 

  1177. 				</ul>
    1178. 

  1178. 		
    1179. 

  1179. 			
    1180. 

  1180. 	</div>
    1181. 

  1181. <a name="methodset_user" id="set_user"><!-- --></a>
    1182. 

  1182. <div class="evenrow">
    1183. 

  1183. 	
    1184. 

  1184. 	<div class="method-header">
    1185. 

  1185. 		<img src="../media/images/Method.png" />
    1186. 

  1186. 		<span class="method-title">set_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_iolib.php.html#a858">858</a></span>)
    1187. 

  1187. 	</div> 
    1188. 

  1188. 	
    1189. 

  1189. 	<!-- ========== Info from phpDoc block ========= -->
    1190. 

  1190. <p class="short-description">Sets the <a href="../sloodle/SloodleLSLRequest.html#var$user">SloodleLSLRequest::$user</a> member.</p>
    1191. 

  1191. 	
    1192. 

  1192. 	<div class="method-signature">
    1193. 

  1193. 		<span class="method-result">void</span>
    1194. 

  1194. 		<span class="method-name">
    1195. 

  1195. 			set_user
    1196. 

  1196. 		</span>
    1197. 

  1197. 					(<span class="var-type"></span>&nbsp;<span class="var-name">&$user</span>, <span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>&nbsp;<span class="var-name">$user</span>)
    1198. 

  1198. 			</div>
    1199. 

  1199. 	
    1200. 

  1200. 			<ul class="parameters">
    1201. 

  1201. 					<li>
    1202. 

  1202. 				<span class="var-type"><a href="../sloodle/SloodleUser.html">SloodleUser</a></span>
    1203. 

  1203. 				<span class="var-name">$user</span><span class="var-description">: Reference to a <a href="../sloodle/SloodleUser.html">SloodleUser</a> object</span>			</li>
    1204. 

  1204. 					<li>
    1205. 

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

  1206. 				<span class="var-name">&$user</span>			</li>
    1207. 

  1207. 				</ul>
    1208. 

  1208. 		
    1209. 

  1209. 			
    1210. 

  1210. 	</div>
    1211. 

  1211. 						
    1212. 

  1212. 		</div>
    1213. 

  1213. 	</div>
    1214. 

  1214. 

  1215. 	
    1216. 

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

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

  1218. 	</p>
    1219. 

  1219. 	</div></body>
    1220. 

  1220. </html>
    1221.