Startseite Erkunden Hilfe
Registrieren Anmelden
Ayuda_Virtual
/
sloodle_website
2
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki
Branch: master
Branches Tags
sloodle_webs...
/
webroot
/
phpdocs
/
0.3-beta-2008070702
/
sloodle
/
SloodleSession.html

SloodleSession.html 25 KB
Permalink Verlauf Originalformat

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569 
  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 SloodleSession</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"> SloodleSession</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">The primary API class, which manages all other parts.</p>
    105. 

  105. 		<p class="notes">
    106. 

  106. 			Located in <a class="field" href="_lib---sloodle_session.php.html">/lib/sloodle_session.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__libsloodle_session.php.html#a32">32</a></span>)
    107. 

  107. 		</p>
    108. 

  108. 		
    109. 

  109. 				
    110. 

  110. 		<pre></pre>
    111. 

  111. 	
    112. 

  112. 			</div>
    113. 

  113. </div>
    114. 

  114. 

  115. 

  116. 

  117. 	<a name="sec-var-summary"></a>
    118. 

  118. 	<div class="info-box">
    119. 

  119. 		<div class="info-box-title">Variable Summary</span></div>
    120. 

  120. 		<div class="nav-bar">
    121. 

  121. 			<a href="#sec-description">Description</a> |
    122. 

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

  123. 							| 
    124. 

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

  125. 							
    126. 

  126. 								</div>
    127. 

  127. 		<div class="info-box-body">
    128. 

  128. 			<div class="var-summary">
    129. 

  129. 																																																								<div class="var-title">
    130. 

  130. 					<img src="../media/images/Variable.png" alt=" " />
    131. 

  131. 					<span class="var-type"><a href="../sloodle/SloodleCourse.html">SloodleCourse</a></span>
    132. 

  132. 					<a href="#$course" title="details" class="var-name">$course</a>
    133. 

  133. 				</div>
    134. 

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

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

  136. 					<span class="var-type"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span>
    137. 

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

  138. 				</div>
    139. 

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

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

  141. 					<span class="var-type"><a href="../sloodle/SloodleRequest.html">SloodleRequest</a></span>
    142. 

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

  143. 				</div>
    144. 

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

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

  146. 					<span class="var-type"><a href="../sloodle/SloodleResponse.html">SloodleResponse</a></span>
    147. 

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

  148. 				</div>
    149. 

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

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

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

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

  153. 				</div>
    154. 

  154. 											</div>
    155. 

  155. 		</div>
    156. 

  156. 	</div>
    157. 

  157. 

  158. 	<a name="sec-method-summary"></a>
    159. 

  159. 	<div class="info-box">
    160. 

  160. 		<div class="info-box-title">Method Summary</span></div>
    161. 

  161. 		<div class="nav-bar">
    162. 

  162. 			<a href="#sec-description">Description</a> |
    163. 

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

  164. 				 
    165. 

  165. 				|
    166. 

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

  167. 		</div>
    168. 

  168. 		<div class="info-box-body">			
    169. 

  169. 			<div class="method-summary">
    170. 

  170. 																																																															
    171. 

  171. 				<div class="method-definition">
    172. 

  172. 					<img src="../media/images/Constructor.png" alt=" "/>
    173. 

  173. 											<span class="method-result">SloodleSession</span>
    174. 

  174. 										<a href="#SloodleSession" title="details" class="method-name">SloodleSession</a>
    175. 

  175. 											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$process</span> = <span class="var-default">true</span>])
    176. 

  176. 									</div>
    177. 

  177. 															
    178. 

  178. 				<div class="method-definition">
    179. 

  179. 					<img src="../media/images/Method.png" alt=" "/>
    180. 

  180. 											<span class="method-result">bool</span>
    181. 

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

  182. 											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">true</span>])
    183. 

  183. 									</div>
    184. 

  184. 															
    185. 

  185. 				<div class="method-definition">
    186. 

  186. 					<img src="../media/images/Method.png" alt=" "/>
    187. 

  187. 											<span class="method-result">bool</span>
    188. 

  188. 										<a href="#authenticate_user_request" title="details" class="method-name">authenticate_user_request</a>
    189. 

  189. 											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">true</span>])
    190. 

  190. 									</div>
    191. 

  191. 															
    192. 

  192. 				<div class="method-definition">
    193. 

  193. 					<img src="../media/images/Method.png" alt=" "/>
    194. 

  194. 											<span class="method-result">bool</span>
    195. 

  195. 										<a href="#load_module" title="details" class="method-name">load_module</a>
    196. 

  196. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$db</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">true</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$override_access</span> = <span class="var-default">false</span>])
    197. 

  197. 									</div>
    198. 

  198. 															
    199. 

  199. 				<div class="method-definition">
    200. 

  200. 					<img src="../media/images/Method.png" alt=" "/>
    201. 

  201. 											<span class="method-result">bool</span>
    202. 

  202. 										<a href="#validate_avatar" title="details" class="method-name">validate_avatar</a>
    203. 

  203. 											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">true</span>])
    204. 

  204. 									</div>
    205. 

  205. 															
    206. 

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

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

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

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

  210. 											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">true</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$suppress_autoreg</span> = <span class="var-default">false</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$suppress_autoenrol</span> = <span class="var-default">false</span>])
    211. 

  211. 									</div>
    212. 

  212. 											</div>
    213. 

  213. 		</div>
    214. 

  214. 	</div>		
    215. 

  215. 

  216. 	<a name="sec-vars"></a>
    217. 

  217. 	<div class="info-box">
    218. 

  218. 		<div class="info-box-title">Variables</div>
    219. 

  219. 		<div class="nav-bar">
    220. 

  220. 			<a href="#sec-description">Description</a> |
    221. 

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

  222. 						
    223. 

  223. 			
    224. 

  224. 										| 
    225. 

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

  226. 							
    227. 

  227. 					</div>
    228. 

  228. 		<div class="info-box-body">
    229. 

  229. 			
    230. 

  230. <a name="var$course" id="$course"><!-- --></A>
    231. 

  231. <div class="oddrow">
    232. 

  232. 

  233. 	<div class="var-header">
    234. 

  234. 		<img src="../media/images/Variable.png" />
    235. 

  235. 		<span class="var-title">
    236. 

  236. 			<span class="var-type"><a href="../sloodle/SloodleCourse.html">SloodleCourse</a></span>
    237. 

  237. 			<span class="var-name">$course</span>
    238. 

  238. 			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsloodle_session.php.html#a62">62</a></span>)
    239. 

  239. 		</span>
    240. 

  240. 	</div>
    241. 

  241. 

  242. 	<!-- ========== Info from phpDoc block ========= -->
    243. 

  243. <p class="short-description">The Sloodle course structure for the course this session is accessing</p>
    244. 

  244. 	<ul class="tags">
    245. 

  245. 				<li><span class="field">access:</span> public</li>
    246. 

  246. 			</ul>
    247. 

  247. 	
    248. 

  248. 	
    249. 

  249. 		
    250. 

  250. 		
    251. 

  251. 

  252. </div>
    253. 

  253. <a name="var$module" id="$module"><!-- --></A>
    254. 

  254. <div class="evenrow">
    255. 

  255. 

  256. 	<div class="var-header">
    257. 

  257. 		<img src="../media/images/Variable.png" />
    258. 

  258. 		<span class="var-title">
    259. 

  259. 			<span class="var-type"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span>
    260. 

  260. 			<span class="var-name">$module</span>
    261. 

  261. 			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsloodle_session.php.html#a70">70</a></span>)
    262. 

  262. 		</span>
    263. 

  263. 	</div>
    264. 

  264. 

  265. 	<!-- ========== Info from phpDoc block ========= -->
    266. 

  266. <p class="short-description">The Sloodle module this session relates to, if any.</p>
    267. 

  267. <p class="description"><p>Note: this may be the base Sloodle module class, or a derivative.</p></p>
    268. 

  268. 	<ul class="tags">
    269. 

  269. 				<li><span class="field">access:</span> public</li>
    270. 

  270. 			</ul>
    271. 

  271. 	
    272. 

  272. 	
    273. 

  273. 		
    274. 

  274. 		
    275. 

  275. 

  276. </div>
    277. 

  277. <a name="var$request" id="$request"><!-- --></A>
    278. 

  278. <div class="oddrow">
    279. 

  279. 

  280. 	<div class="var-header">
    281. 

  281. 		<img src="../media/images/Variable.png" />
    282. 

  282. 		<span class="var-title">
    283. 

  283. 			<span class="var-type"><a href="../sloodle/SloodleRequest.html">SloodleRequest</a></span>
    284. 

  284. 			<span class="var-name">$request</span>
    285. 

  285. 			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsloodle_session.php.html#a41">41</a></span>)
    286. 

  286. 		</span>
    287. 

  287. 	</div>
    288. 

  288. 

  289. 	<!-- ========== Info from phpDoc block ========= -->
    290. 

  290. <p class="short-description">Incoming HTTP request.</p>
    291. 

  291. 	<ul class="tags">
    292. 

  292. 				<li><span class="field">access:</span> public</li>
    293. 

  293. 			</ul>
    294. 

  294. 	
    295. 

  295. 	
    296. 

  296. 		
    297. 

  297. 		
    298. 

  298. 

  299. </div>
    300. 

  300. <a name="var$response" id="$response"><!-- --></A>
    301. 

  301. <div class="evenrow">
    302. 

  302. 

  303. 	<div class="var-header">
    304. 

  304. 		<img src="../media/images/Variable.png" />
    305. 

  305. 		<span class="var-title">
    306. 

  306. 			<span class="var-type"><a href="../sloodle/SloodleResponse.html">SloodleResponse</a></span>
    307. 

  307. 			<span class="var-name">$response</span>
    308. 

  308. 			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsloodle_session.php.html#a48">48</a></span>)
    309. 

  309. 		</span>
    310. 

  310. 	</div>
    311. 

  311. 

  312. 	<!-- ========== Info from phpDoc block ========= -->
    313. 

  313. <p class="short-description">Outgoing response - can be rendered to HTTP or as a string.</p>
    314. 

  314. 	<ul class="tags">
    315. 

  315. 				<li><span class="field">access:</span> public</li>
    316. 

  316. 			</ul>
    317. 

  317. 	
    318. 

  318. 	
    319. 

  319. 		
    320. 

  320. 		
    321. 

  321. 

  322. </div>
    323. 

  323. <a name="var$user" id="$user"><!-- --></A>
    324. 

  324. <div class="oddrow">
    325. 

  325. 

  326. 	<div class="var-header">
    327. 

  327. 		<img src="../media/images/Variable.png" />
    328. 

  328. 		<span class="var-title">
    329. 

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

  330. 			<span class="var-name">$user</span>
    331. 

  331. 			 = <span class="var-default"> null</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsloodle_session.php.html#a55">55</a></span>)
    332. 

  332. 		</span>
    333. 

  333. 	</div>
    334. 

  334. 

  335. 	<!-- ========== Info from phpDoc block ========= -->
    336. 

  336. <p class="short-description">Current user information.</p>
    337. 

  337. 	<ul class="tags">
    338. 

  338. 				<li><span class="field">access:</span> public</li>
    339. 

  339. 			</ul>
    340. 

  340. 	
    341. 

  341. 	
    342. 

  342. 		
    343. 

  343. 		
    344. 

  344. 

  345. </div>
    346. 

  346. 
						
    347. 

  347. 		</div>
    348. 

  348. 	</div>
    349. 

  349. 	
    350. 

  350. 	<a name="sec-methods"></a>
    351. 

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

  352. 		<div class="info-box-title">Methods</div>
    353. 

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

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

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

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

  357. 						
    358. 

  358. 		</div>
    359. 

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

  360. 			<A NAME='method_detail'></A>
    361. 

  361. <a name="methodSloodleSession" id="SloodleSession"><!-- --></a>
    362. 

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

  363. 	
    364. 

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

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

  366. 		<span class="method-title">Constructor SloodleSession</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsloodle_session.php.html#a79">79</a></span>)
    367. 

  367. 	</div> 
    368. 

  368. 	
    369. 

  369. 	<!-- ========== Info from phpDoc block ========= -->
    370. 

  370. <p class="short-description">Constructor - initialises members</p>
    371. 

  371. 	
    372. 

  372. 	<div class="method-signature">
    373. 

  373. 		<span class="method-result">SloodleSession</span>
    374. 

  374. 		<span class="method-name">
    375. 

  375. 			SloodleSession
    376. 

  376. 		</span>
    377. 

  377. 					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$process</span> = <span class="var-default">true</span>])
    378. 

  378. 			</div>
    379. 

  379. 	
    380. 

  380. 			<ul class="parameters">
    381. 

  381. 					<li>
    382. 

  382. 				<span class="var-type">bool</span>
    383. 

  383. 				<span class="var-name">$process</span><span class="var-description">: If true (default) then basic request data will be processed immediately. Otherwise, it can be done manually by calling $request-&gt;process_request_data()</span>			</li>
    384. 

  384. 				</ul>
    385. 

  385. 		
    386. 

  386. 			
    387. 

  387. 	</div>
    388. 

  388. <a name="methodauthenticate_request" id="authenticate_request"><!-- --></a>
    389. 

  389. <div class="oddrow">
    390. 

  390. 	
    391. 

  391. 	<div class="method-header">
    392. 

  392. 		<img src="../media/images/Method.png" />
    393. 

  393. 		<span class="method-title">authenticate_request</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsloodle_session.php.html#a132">132</a></span>)
    394. 

  394. 	</div> 
    395. 

  395. 	
    396. 

  396. 	<!-- ========== Info from phpDoc block ========= -->
    397. 

  397. <p class="short-description">Verifies security for the incoming request (but does not check user access).</p>
    398. 

  398. <p class="description"><p>Initially ensures that the request is coming in on a valid and enabled course/controller (rejects it if not).  The password is then checked, and it can handle prim-passwords and object-specific passwords.</p></p>
    399. 

  399. 	<ul class="tags">
    400. 

  400. 				<li><span class="field">return:</span> true if successful in authenticating the request, or false if not.</li>
    401. 

  401. 			</ul>
    402. 

  402. 	
    403. 

  403. 	<div class="method-signature">
    404. 

  404. 		<span class="method-result">bool</span>
    405. 

  405. 		<span class="method-name">
    406. 

  406. 			authenticate_request
    407. 

  407. 		</span>
    408. 

  408. 					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">true</span>])
    409. 

  409. 			</div>
    410. 

  410. 	
    411. 

  411. 			<ul class="parameters">
    412. 

  412. 					<li>
    413. 

  413. 				<span class="var-type">bool</span>
    414. 

  414. 				<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>
    415. 

  415. 				</ul>
    416. 

  416. 		
    417. 

  417. 			
    418. 

  418. 	</div>
    419. 

  419. <a name="methodauthenticate_user_request" id="authenticate_user_request"><!-- --></a>
    420. 

  420. <div class="evenrow">
    421. 

  421. 	
    422. 

  422. 	<div class="method-header">
    423. 

  423. 		<img src="../media/images/Method.png" />
    424. 

  424. 		<span class="method-title">authenticate_user_request</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsloodle_session.php.html#a250">250</a></span>)
    425. 

  425. 	</div> 
    426. 

  426. 	
    427. 

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

  428. <p class="short-description">Verifies security for the incoming user-centric request.</p>
    429. 

  429. <p class="description"><p>This ensures that the identified object is authorised for user-centric activities with the specified user.</p></p>
    430. 

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

  431. 				<li><span class="field">return:</span> TRUE if successful, or FALSE on failure (unless parameter $require was TRUE).</li>
    432. 

  432. 			</ul>
    433. 

  433. 	
    434. 

  434. 	<div class="method-signature">
    435. 

  435. 		<span class="method-result">bool</span>
    436. 

  436. 		<span class="method-name">
    437. 

  437. 			authenticate_user_request
    438. 

  438. 		</span>
    439. 

  439. 					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">true</span>])
    440. 

  440. 			</div>
    441. 

  441. 	
    442. 

  442. 			<ul class="parameters">
    443. 

  443. 					<li>
    444. 

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

  445. 				<span class="var-name">$require</span><span class="var-description">: If TRUE (default) then the script will terminate with an error message on failure. Otherwise, it will return false on failure.</span>			</li>
    446. 

  446. 				</ul>
    447. 

  447. 		
    448. 

  448. 			
    449. 

  449. 	</div>
    450. 

  450. <a name="methodload_module" id="load_module"><!-- --></a>
    451. 

  451. <div class="oddrow">
    452. 

  452. 	
    453. 

  453. 	<div class="method-header">
    454. 

  454. 		<img src="../media/images/Method.png" />
    455. 

  455. 		<span class="method-title">load_module</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsloodle_session.php.html#a101">101</a></span>)
    456. 

  456. 	</div> 
    457. 

  457. 	
    458. 

  458. 	<!-- ========== Info from phpDoc block ========= -->
    459. 

  459. <p class="short-description">Constructs and loads the appropriate module part of the session.</p>
    460. 

  460. <p class="description"><p>Note that this function will fail if the current VLE user (in the $user member) does not have permission to access it.</p></p>
    461. 

  461. 	<ul class="tags">
    462. 

  462. 				<li><span class="field">return:</span> True if successful, or false otherwise. (Note, if parameter $require was true, then the script will terminate before this function returns if something goes wrong)</li>
    463. 

  463. 			</ul>
    464. 

  464. 	
    465. 

  465. 	<div class="method-signature">
    466. 

  466. 		<span class="method-result">bool</span>
    467. 

  467. 		<span class="method-name">
    468. 

  468. 			load_module
    469. 

  469. 		</span>
    470. 

  470. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$db</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">true</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$override_access</span> = <span class="var-default">false</span>])
    471. 

  471. 			</div>
    472. 

  472. 	
    473. 

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

  474. 					<li>
    475. 

  475. 				<span class="var-type">string</span>
    476. 

  476. 				<span class="var-name">$type</span><span class="var-description">: The expected type of module - function fails if type is not correctly matched</span>			</li>
    477. 

  477. 					<li>
    478. 

  478. 				<span class="var-type">bool</span>
    479. 

  479. 				<span class="var-name">$db</span><span class="var-description">: If true then the system will also try to load appropriate data from the database, as specified in the module ID request parameter</span>			</li>
    480. 

  480. 					<li>
    481. 

  481. 				<span class="var-type">bool</span>
    482. 

  482. 				<span class="var-name">$require</span><span class="var-description">: If true, then if something goes wrong, the script will be terminated with an error message</span>			</li>
    483. 

  483. 					<li>
    484. 

  484. 				<span class="var-type">bool</span>
    485. 

  485. 				<span class="var-name">$override_access</span><span class="var-description">: If true, then the user access permissions will be overriden to force access (not implemented yet)</span>			</li>
    486. 

  486. 				</ul>
    487. 

  487. 		
    488. 

  488. 			
    489. 

  489. 	</div>
    490. 

  490. <a name="methodvalidate_avatar" id="validate_avatar"><!-- --></a>
    491. 

  491. <div class="evenrow">
    492. 

  492. 	
    493. 

  493. 	<div class="method-header">
    494. 

  494. 		<img src="../media/images/Method.png" />
    495. 

  495. 		<span class="method-title">validate_avatar</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsloodle_session.php.html#a549">549</a></span>)
    496. 

  496. 	</div> 
    497. 

  497. 	
    498. 

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

  499. <p class="short-description">Validate the avatar specified in the request, to ensure it is registered to a Moodle account.</p>
    500. 

  500. <p class="description"><p>(Also ensures that avatar details were in fact provided in the request).  This is effectively a less strict version of validated_user(), which also checks enrolment and such like.  This function will NOT perform auto-registration or auto-enrolment.</p></p>
    501. 

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

  502. 				<li><span class="field">return:</span> Returns true if validation was successful. Returns false on failure (unless $require was true).</li>
    503. 

  503. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleSession.html#methodvalidate_user">SloodleSession::validate_user()</a></li>
    504. 

  504. 			</ul>
    505. 

  505. 	
    506. 

  506. 	<div class="method-signature">
    507. 

  507. 		<span class="method-result">bool</span>
    508. 

  508. 		<span class="method-name">
    509. 

  509. 			validate_avatar
    510. 

  510. 		</span>
    511. 

  511. 					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">true</span>])
    512. 

  512. 			</div>
    513. 

  513. 	
    514. 

  514. 			<ul class="parameters">
    515. 

  515. 					<li>
    516. 

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

  517. 				<span class="var-name">$require</span><span class="var-description">: If true, the script will be terminated with an error message if validation fails</span>			</li>
    518. 

  518. 				</ul>
    519. 

  519. 		
    520. 

  520. 			
    521. 

  521. 	</div>
    522. 

  522. <a name="methodvalidate_user" id="validate_user"><!-- --></a>
    523. 

  523. <div class="oddrow">
    524. 

  524. 	
    525. 

  525. 	<div class="method-header">
    526. 

  526. 		<img src="../media/images/Method.png" />
    527. 

  527. 		<span class="method-title">validate_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsloodle_session.php.html#a340">340</a></span>)
    528. 

  528. 	</div> 
    529. 

  529. 	
    530. 

  530. 	<!-- ========== Info from phpDoc block ========= -->
    531. 

  531. <p class="short-description">Validates the user account and enrolment (ensures there is an avatar linked to a VLE account, and that the VLE account is enrolled in the current course).</p>
    532. 

  532. <p class="description"><p>Attempts auto-registration/enrolment if that is allowed and required, and logs-in the user.  Server access level is checked if it is specified in the request parameters.  If the request indicates that it relates to an object, then the validation fails.  Note: if you only require to ensure that an avatar is registered, then use <a href="../sloodle/SloodleSession.html#methodvalidate_avatar">validate_avatar()</a>.</p></p>
    533. 

  533. 	<ul class="tags">
    534. 

  534. 				<li><span class="field">return:</span> Returns true if validation and/or autoregistration were successful. Returns false on failure (unless $require was true).</li>
    535. 

  535. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleSession.html#methodvalidate_avatar">SloodleSession::validate_avatar()</a></li>
    536. 

  536. 			</ul>
    537. 

  537. 	
    538. 

  538. 	<div class="method-signature">
    539. 

  539. 		<span class="method-result">bool</span>
    540. 

  540. 		<span class="method-name">
    541. 

  541. 			validate_user
    542. 

  542. 		</span>
    543. 

  543. 					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$require</span> = <span class="var-default">true</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$suppress_autoreg</span> = <span class="var-default">false</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$suppress_autoenrol</span> = <span class="var-default">false</span>])
    544. 

  544. 			</div>
    545. 

  545. 	
    546. 

  546. 			<ul class="parameters">
    547. 

  547. 					<li>
    548. 

  548. 				<span class="var-type">bool</span>
    549. 

  549. 				<span class="var-name">$require</span><span class="var-description">: If true, the script will be terminated with an error message if validation fails</span>			</li>
    550. 

  550. 					<li>
    551. 

  551. 				<span class="var-type">bool</span>
    552. 

  552. 				<span class="var-name">$suppress_autoreg</span><span class="var-description">: If true, auto-registration will be completely suppressed for this function call</span>			</li>
    553. 

  553. 					<li>
    554. 

  554. 				<span class="var-type">bool</span>
    555. 

  555. 				<span class="var-name">$suppress_autoenrol</span><span class="var-description">: If true, auto-enrolment will be completely suppressed for this function call</span>			</li>
    556. 

  556. 				</ul>
    557. 

  557. 		
    558. 

  558. 			
    559. 

  559. 	</div>
    560. 

  560. 						
    561. 

  561. 		</div>
    562. 

  562. 	</div>
    563. 

  563. 

  564. 	
    565. 

  565. 	<p class="notes" id="credit">
    566. 

  566. 		Documentation generated on Mon, 07 Jul 2008 12:33:15 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
    567. 

  567. 	</p>
    568. 

  568. 	</div></body>
    569. 

  569. </html>
    570.