Начало Каталог Помощ
Регистрация Вход
Ayuda_Virtual
/
sloodle_website
2
0
Разклонения 0
Файлове Задачи 0 Заявки за сливане 0 Уики
Клон: master
Клонове Маркери
sloodle_webs...
/
webroot
/
phpdocs
/
0.21
/
sloodle
/
SloodleUser.html

SloodleUser.html 58 KB
Постоянна връзка История Директен файл

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315 
  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 SloodleUser</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"> SloodleUser</h2>
    92. 

  92. 

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

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

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

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

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

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

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

  100. 						
    101. 

  101. 					</div>
    102. 

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

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

  104. <p class="short-description">A class to represent a single user, including Moodle and Sloodle data.</p>
    105. 

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

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

  107. 			</ul>
    108. 

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

  109. 			Located in <a class="field" href="_lib---sl_userlib.php.html">/lib/sl_userlib.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a29">29</a></span>)
    110. 

  110. 		</p>
    111. 

  111. 		
    112. 

  112. 				
    113. 

  113. 		<pre></pre>
    114. 

  114. 	
    115. 

  115. 			</div>
    116. 

  116. </div>
    117. 

  117. 

  118. 

  119. 

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

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

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

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

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

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

  126. 							| 
    127. 

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

  128. 							
    129. 

  129. 								</div>
    130. 

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

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

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

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

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

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

  136. 				</div>
    137. 

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

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

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

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

  141. 				</div>
    142. 

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

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

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

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

  146. 				</div>
    147. 

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

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

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

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

  151. 				</div>
    152. 

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

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

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

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

  156. 				</div>
    157. 

  157. 											</div>
    158. 

  158. 		</div>
    159. 

  159. 	</div>
    160. 

  160. 

  161. 	<a name="sec-method-summary"></a>
    162. 

  162. 	<div class="info-box">
    163. 

  163. 		<div class="info-box-title">Method Summary</span></div>
    164. 

  164. 		<div class="nav-bar">
    165. 

  165. 			<a href="#sec-description">Description</a> |
    166. 

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

  167. 				 
    168. 

  168. 				|
    169. 

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

  170. 		</div>
    171. 

  171. 		<div class="info-box-body">			
    172. 

  172. 			<div class="method-summary">
    173. 

  173. 																																																																																																																																																																																																																															
    174. 

  174. 				<div class="method-definition">
    175. 

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

  176. 											<span class="method-result">void</span>
    177. 

  177. 										<a href="#SloodleUser" title="details" class="method-name">SloodleUser</a>
    178. 

  178. 										()
    179. 

  179. 									</div>
    180. 

  180. 															
    181. 

  181. 				<div class="method-definition">
    182. 

  182. 					<img src="../media/images/Method.png" alt=" "/>
    183. 

  183. 											<span class="method-result">mixed</span>
    184. 

  184. 										<a href="#create_moodle_user" title="details" class="method-name">create_moodle_user</a>
    185. 

  185. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$firstname</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$lastname</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$email</span>)
    186. 

  186. 									</div>
    187. 

  187. 															
    188. 

  188. 				<div class="method-definition">
    189. 

  189. 					<img src="../media/images/Method.png" alt=" "/>
    190. 

  190. 											<span class="method-result">bool</span>
    191. 

  191. 										<a href="#create_sloodle_user" title="details" class="method-name">create_sloodle_user</a>
    192. 

  192. 											([<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$avname</span> = <span class="var-default">''</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$userid</span> = <span class="var-default">0</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$loginposition</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$loginpositionexpires</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$loginpositionregion</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$loginsecuritytoken</span> = <span class="var-default">''</span>])
    193. 

  193. 									</div>
    194. 

  194. 															
    195. 

  195. 				<div class="method-definition">
    196. 

  196. 					<img src="../media/images/Method.png" alt=" "/>
    197. 

  197. 											<span class="method-result">mixed</span>
    198. 

  198. 										<a href="#delete_login_position" title="details" class="method-name">delete_login_position</a>
    199. 

  199. 										()
    200. 

  200. 									</div>
    201. 

  201. 															
    202. 

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

  203. 					<img src="../media/images/Method.png" alt=" "/>
    204. 

  204. 											<span class="method-result">mixed</span>
    205. 

  205. 										<a href="#delete_sloodle_user" title="details" class="method-name">delete_sloodle_user</a>
    206. 

  206. 										()
    207. 

  207. 									</div>
    208. 

  208. 															
    209. 

  209. 				<div class="method-definition">
    210. 

  210. 					<img src="../media/images/Method.png" alt=" "/>
    211. 

  211. 											<span class="method-result">mixed</span>
    212. 

  212. 										<a href="#find_linked_moodle_user" title="details" class="method-name">find_linked_moodle_user</a>
    213. 

  213. 											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$use_cache</span> = <span class="var-default">FALSE</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$cache_data</span> = <span class="var-default">TRUE</span>])
    214. 

  214. 									</div>
    215. 

  215. 															
    216. 

  216. 				<div class="method-definition">
    217. 

  217. 					<img src="../media/images/Method.png" alt=" "/>
    218. 

  218. 											<span class="method-result">mixed</span>
    219. 

  219. 										<a href="#find_linked_sloodle_user" title="details" class="method-name">find_linked_sloodle_user</a>
    220. 

  220. 											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$cache_data</span> = <span class="var-default">TRUE</span>])
    221. 

  221. 									</div>
    222. 

  222. 															
    223. 

  223. 				<div class="method-definition">
    224. 

  224. 					<img src="../media/images/Method.png" alt=" "/>
    225. 

  225. 											<span class="method-result">mixed</span>
    226. 

  226. 										<a href="#find_sloodle_user" title="details" class="method-name">find_sloodle_user</a>
    227. 

  227. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$cache_data</span> = <span class="var-default">TRUE</span>])
    228. 

  228. 									</div>
    229. 

  229. 															
    230. 

  230. 				<div class="method-definition">
    231. 

  231. 					<img src="../media/images/Method.png" alt=" "/>
    232. 

  232. 											<span class="method-result">void</span>
    233. 

  233. 										<a href="#find_sloodle_user_by_login_position" title="details" class="method-name">find_sloodle_user_by_login_position</a>
    234. 

  234. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$position</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$cache_data</span> = <span class="var-default">TRUE</span>])
    235. 

  235. 									</div>
    236. 

  236. 															
    237. 

  237. 				<div class="method-definition">
    238. 

  238. 					<img src="../media/images/Method.png" alt=" "/>
    239. 

  239. 											<span class="method-result">mixed</span>
    240. 

  240. 										<a href="#generate_login_position" title="details" class="method-name">generate_login_position</a>
    241. 

  241. 											(<span class="var-type">int</span>&nbsp;<span class="var-name">$expires</span>)
    242. 

  242. 									</div>
    243. 

  243. 															
    244. 

  244. 				<div class="method-definition">
    245. 

  245. 					<img src="../media/images/Method.png" alt=" "/>
    246. 

  246. 											<span class="method-result">int</span>
    247. 

  247. 										<a href="#get_moodle_user_id" title="details" class="method-name">get_moodle_user_id</a>
    248. 

  248. 										()
    249. 

  249. 									</div>
    250. 

  250. 															
    251. 

  251. 				<div class="method-definition">
    252. 

  252. 					<img src="../media/images/Method.png" alt=" "/>
    253. 

  253. 											<span class="method-result">int</span>
    254. 

  254. 										<a href="#get_sloodle_user_id" title="details" class="method-name">get_sloodle_user_id</a>
    255. 

  255. 										()
    256. 

  256. 									</div>
    257. 

  257. 															
    258. 

  258. 				<div class="method-definition">
    259. 

  259. 					<img src="../media/images/Method.png" alt=" "/>
    260. 

  260. 											<span class="method-result">bool</span>
    261. 

  261. 										<a href="#has_login_security_token" title="details" class="method-name">has_login_security_token</a>
    262. 

  262. 											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$use_cache</span> = <span class="var-default">FALSE</span>])
    263. 

  263. 									</div>
    264. 

  264. 															
    265. 

  265. 				<div class="method-definition">
    266. 

  266. 					<img src="../media/images/Method.png" alt=" "/>
    267. 

  267. 											<span class="method-result">bool</span>
    268. 

  268. 										<a href="#insert_sloodle_user_cache_to_db" title="details" class="method-name">insert_sloodle_user_cache_to_db</a>
    269. 

  269. 										()
    270. 

  270. 									</div>
    271. 

  271. 															
    272. 

  272. 				<div class="method-definition">
    273. 

  273. 					<img src="../media/images/Method.png" alt=" "/>
    274. 

  274. 											<span class="method-result">void</span>
    275. 

  275. 										<a href="#is_user_in_course" title="details" class="method-name">is_user_in_course</a>
    276. 

  276. 											(<span class="var-type">int</span>&nbsp;<span class="var-name">$course_id</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$use_cache</span> = <span class="var-default">FALSE</span>], <span class="var-type">bool</span>&nbsp;<span class="var-name">2</span>)
    277. 

  277. 									</div>
    278. 

  278. 															
    279. 

  279. 				<div class="method-definition">
    280. 

  280. 					<img src="../media/images/Method.png" alt=" "/>
    281. 

  281. 											<span class="method-result">mixed</span>
    282. 

  282. 										<a href="#link_users" title="details" class="method-name">link_users</a>
    283. 

  283. 										()
    284. 

  284. 									</div>
    285. 

  285. 															
    286. 

  286. 				<div class="method-definition">
    287. 

  287. 					<img src="../media/images/Method.png" alt=" "/>
    288. 

  288. 											<span class="method-result">bool</span>
    289. 

  289. 										<a href="#login_moodle_user" title="details" class="method-name">login_moodle_user</a>
    290. 

  290. 										()
    291. 

  291. 									</div>
    292. 

  292. 															
    293. 

  293. 				<div class="method-definition">
    294. 

  294. 					<img src="../media/images/Method.png" alt=" "/>
    295. 

  295. 											<span class="method-result">bool</span>
    296. 

  296. 										<a href="#regenerate_login_security_token" title="details" class="method-name">regenerate_login_security_token</a>
    297. 

  297. 											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$cache_data</span> = <span class="var-default">TRUE</span>])
    298. 

  298. 									</div>
    299. 

  299. 															
    300. 

  300. 				<div class="method-definition">
    301. 

  301. 					<img src="../media/images/Method.png" alt=" "/>
    302. 

  302. 											<span class="method-result">void</span>
    303. 

  303. 										<a href="#set_moodle_user_id" title="details" class="method-name">set_moodle_user_id</a>
    304. 

  304. 											(<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>)
    305. 

  305. 									</div>
    306. 

  306. 															
    307. 

  307. 				<div class="method-definition">
    308. 

  308. 					<img src="../media/images/Method.png" alt=" "/>
    309. 

  309. 											<span class="method-result">void</span>
    310. 

  310. 										<a href="#set_sloodle_user_id" title="details" class="method-name">set_sloodle_user_id</a>
    311. 

  311. 											(<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>)
    312. 

  312. 									</div>
    313. 

  313. 															
    314. 

  314. 				<div class="method-definition">
    315. 

  315. 					<img src="../media/images/Method.png" alt=" "/>
    316. 

  316. 											<span class="method-result">mixed</span>
    317. 

  317. 										<a href="#unlink_sloodle_user" title="details" class="method-name">unlink_sloodle_user</a>
    318. 

  318. 										()
    319. 

  319. 									</div>
    320. 

  320. 															
    321. 

  321. 				<div class="method-definition">
    322. 

  322. 					<img src="../media/images/Method.png" alt=" "/>
    323. 

  323. 											<span class="method-result">True</span>
    324. 

  324. 										<a href="#update_enrolled_courses_cache_from_db" title="details" class="method-name">update_enrolled_courses_cache_from_db</a>
    325. 

  325. 										()
    326. 

  326. 									</div>
    327. 

  327. 															
    328. 

  328. 				<div class="method-definition">
    329. 

  329. 					<img src="../media/images/Method.png" alt=" "/>
    330. 

  330. 											<span class="method-result">mixed</span>
    331. 

  331. 										<a href="#update_moodle_user_cache_from_db" title="details" class="method-name">update_moodle_user_cache_from_db</a>
    332. 

  332. 										()
    333. 

  333. 									</div>
    334. 

  334. 															
    335. 

  335. 				<div class="method-definition">
    336. 

  336. 					<img src="../media/images/Method.png" alt=" "/>
    337. 

  337. 											<span class="method-result">mixed</span>
    338. 

  338. 										<a href="#update_sloodle_user_cache_from_db" title="details" class="method-name">update_sloodle_user_cache_from_db</a>
    339. 

  339. 										()
    340. 

  340. 									</div>
    341. 

  341. 															
    342. 

  342. 				<div class="method-definition">
    343. 

  343. 					<img src="../media/images/Method.png" alt=" "/>
    344. 

  344. 											<span class="method-result">mixed</span>
    345. 

  345. 										<a href="#update_sloodle_user_cache_to_db" title="details" class="method-name">update_sloodle_user_cache_to_db</a>
    346. 

  346. 										()
    347. 

  347. 									</div>
    348. 

  348. 															
    349. 

  349. 				<div class="method-definition">
    350. 

  350. 					<img src="../media/images/Method.png" alt=" "/>
    351. 

  351. 											<span class="method-result">mixed</span>
    352. 

  352. 										<a href="#users_linked" title="details" class="method-name">users_linked</a>
    353. 

  353. 											([<span class="var-type">bool</span>&nbsp;<span class="var-name">$use_cache</span> = <span class="var-default">FALSE</span>])
    354. 

  354. 									</div>
    355. 

  355. 											</div>
    356. 

  356. 		</div>
    357. 

  357. 	</div>		
    358. 

  358. 

  359. 	<a name="sec-vars"></a>
    360. 

  360. 	<div class="info-box">
    361. 

  361. 		<div class="info-box-title">Variables</div>
    362. 

  362. 		<div class="nav-bar">
    363. 

  363. 			<a href="#sec-description">Description</a> |
    364. 

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

  365. 						
    366. 

  366. 			
    367. 

  367. 										| 
    368. 

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

  369. 							
    370. 

  370. 					</div>
    371. 

  371. 		<div class="info-box-body">
    372. 

  372. 			
    373. 

  373. <a name="var$enrolled_courses_cache" id="$enrolled_courses_cache"><!-- --></A>
    374. 

  374. <div class="oddrow">
    375. 

  375. 

  376. 	<div class="var-header">
    377. 

  377. 		<img src="../media/images/Variable.png" />
    378. 

  378. 		<span class="var-title">
    379. 

  379. 			<span class="var-type">array</span>
    380. 

  380. 			<span class="var-name">$enrolled_courses_cache</span>
    381. 

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

  382. 		</span>
    383. 

  383. 	</div>
    384. 

  384. 

  385. 	<!-- ========== Info from phpDoc block ========= -->
    386. 

  386. <p class="short-description">Cache of courses which the Moodle user is enrolled in  Used by some functions fetching database data about a Moodle user's courses.</p>
    387. 

  387. <p class="description"><p>It is an array which caches the list of courses the Moodle user is enrolled in  Note that update is *not* automatic, but you can manually call {@link: update_enrolled_courses_cache_from_db()}.  After construction, it will always be a numeric array of integers (but may be empty)  Each element will be a course ID (integer).</p></p>
    388. 

  388. 	<ul class="tags">
    389. 

  389. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleUser.html#var$moodle_user_cache">SloodleUser::$moodle_user_cache</a></li>
    390. 

  390. 				<li><span class="field">access:</span> public</li>
    391. 

  391. 			</ul>
    392. 

  392. 	
    393. 

  393. 	
    394. 

  394. 		
    395. 

  395. 		
    396. 

  396. 

  397. </div>
    398. 

  398. <a name="var$moodle_user_cache" id="$moodle_user_cache"><!-- --></A>
    399. 

  399. <div class="evenrow">
    400. 

  400. 

  401. 	<div class="var-header">
    402. 

  402. 		<img src="../media/images/Variable.png" />
    403. 

  403. 		<span class="var-title">
    404. 

  404. 			<span class="var-type">object</span>
    405. 

  405. 			<span class="var-name">$moodle_user_cache</span>
    406. 

  406. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a86">86</a></span>)
    407. 

  407. 		</span>
    408. 

  408. 	</div>
    409. 

  409. 

  410. 	<!-- ========== Info from phpDoc block ========= -->
    411. 

  411. <p class="short-description">Moodle user data cache.</p>
    412. 

  412. <p class="description"><p>Used by various functions fetching database data about a Moodle user.  Contents can also be used in subsequent function calls to prevent the need for an additional database query (typically by specifying a $use_cache parameter).  Update is *not* automatic.  It can be updated manually by calling {@link: update_moodle_user_cache_from_db()}.  Unlike the Sloodle equivalent, this cannot be used to update the database  After construction, it will always be an object.</p></p>
    413. 

  413. 	<ul class="tags">
    414. 

  414. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleUser.html#var$enrolled_courses_cache">SloodleUser::$enrolled_courses_cache</a></li>
    415. 

  415. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleUser.html#var$sloodle_user_cache">SloodleUser::$sloodle_user_cache</a></li>
    416. 

  416. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleUser.html#var$moodle_user_id">SloodleUser::$moodle_user_id</a></li>
    417. 

  417. 				<li><span class="field">access:</span> public</li>
    418. 

  418. 			</ul>
    419. 

  419. 	
    420. 

  420. 	
    421. 

  421. 		
    422. 

  422. 		
    423. 

  423. 

  424. </div>
    425. 

  425. <a name="var$moodle_user_id" id="$moodle_user_id"><!-- --></A>
    426. 

  426. <div class="oddrow">
    427. 

  427. 

  428. 	<div class="var-header">
    429. 

  429. 		<img src="../media/images/PrivateVariable.png" />
    430. 

  430. 		<span class="var-title">
    431. 

  431. 			<span class="var-type">int</span>
    432. 

  432. 			<span class="var-name">$moodle_user_id</span>
    433. 

  433. 			 = <span class="var-default"> 0</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a52">52</a></span>)
    434. 

  434. 		</span>
    435. 

  435. 	</div>
    436. 

  436. 

  437. 	<!-- ========== Info from phpDoc block ========= -->
    438. 

  438. <p class="short-description">Integer ID of a Moodle user entry in the database.</p>
    439. 

  439. <p class="description"><p>Value 0 represents no user.</p></p>
    440. 

  440. 	<ul class="tags">
    441. 

  441. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleUser.html#var$sloodle_user_id">SloodleUser::$sloodle_user_id</a></li>
    442. 

  442. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleUser.html#var$moodle_user_cache">SloodleUser::$moodle_user_cache</a></li>
    443. 

  443. 				<li><span class="field">access:</span> private</li>
    444. 

  444. 			</ul>
    445. 

  445. 	
    446. 

  446. 	
    447. 

  447. 		
    448. 

  448. 		
    449. 

  449. 

  450. </div>
    451. 

  451. <a name="var$sloodle_user_cache" id="$sloodle_user_cache"><!-- --></A>
    452. 

  452. <div class="evenrow">
    453. 

  453. 

  454. 	<div class="var-header">
    455. 

  455. 		<img src="../media/images/Variable.png" />
    456. 

  456. 		<span class="var-title">
    457. 

  457. 			<span class="var-type">object</span>
    458. 

  458. 			<span class="var-name">$sloodle_user_cache</span>
    459. 

  459. 			 = <span class="var-default"> NULL</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a70">70</a></span>)
    460. 

  460. 		</span>
    461. 

  461. 	</div>
    462. 

  462. 

  463. 	<!-- ========== Info from phpDoc block ========= -->
    464. 

  464. <p class="short-description">Sloodle user data cache.</p>
    465. 

  465. <p class="description"><p>Used by various functions fetching database data about a Sloodle user.  Contents can also be used in subsequent function calls to prevent the need for an additional database query (typically by specifying a $use_cache parameter).  Update is *not* automatic.  It can be updated manually by calling {@link: update_sloodle_user_cache_from_db()}.  Data placed here can also be used to edit the database using {@link: insert_sloodle_user_cache_to_db()} or {@link: update_sloodle_user_cache_to_db()}.  After construction, it will always be an object.</p></p>
    466. 

  466. 	<ul class="tags">
    467. 

  467. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleUser.html#var$moodle_user_cache">SloodleUser::$moodle_user_cache</a></li>
    468. 

  468. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleUser.html#var$sloodle_user_id">SloodleUser::$sloodle_user_id</a></li>
    469. 

  469. 				<li><span class="field">access:</span> public</li>
    470. 

  470. 			</ul>
    471. 

  471. 	
    472. 

  472. 	
    473. 

  473. 		
    474. 

  474. 		
    475. 

  475. 

  476. </div>
    477. 

  477. <a name="var$sloodle_user_id" id="$sloodle_user_id"><!-- --></A>
    478. 

  478. <div class="oddrow">
    479. 

  479. 

  480. 	<div class="var-header">
    481. 

  481. 		<img src="../media/images/PrivateVariable.png" />
    482. 

  482. 		<span class="var-title">
    483. 

  483. 			<span class="var-type">int</span>
    484. 

  484. 			<span class="var-name">$sloodle_user_id</span>
    485. 

  485. 			 = <span class="var-default"> 0</span>			(line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a42">42</a></span>)
    486. 

  486. 		</span>
    487. 

  487. 	</div>
    488. 

  488. 

  489. 	<!-- ========== Info from phpDoc block ========= -->
    490. 

  490. <p class="short-description">Integer ID of a Sloodle user entry in the database.</p>
    491. 

  491. <p class="description"><p>Value 0 represents no user.</p></p>
    492. 

  492. 	<ul class="tags">
    493. 

  493. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleUser.html#var$moodle_user_id">SloodleUser::$moodle_user_id</a></li>
    494. 

  494. 				<li><span class="field">see:</span> <a href="../sloodle/SloodleUser.html#var$sloodle_user_cache">SloodleUser::$sloodle_user_cache</a></li>
    495. 

  495. 				<li><span class="field">access:</span> private</li>
    496. 

  496. 			</ul>
    497. 

  497. 	
    498. 

  498. 	
    499. 

  499. 		
    500. 

  500. 		
    501. 

  501. 

  502. </div>
    503. 

  503. 
						
    504. 

  504. 		</div>
    505. 

  505. 	</div>
    506. 

  506. 	
    507. 

  507. 	<a name="sec-methods"></a>
    508. 

  508. 	<div class="info-box">
    509. 

  509. 		<div class="info-box-title">Methods</div>
    510. 

  510. 		<div class="nav-bar">
    511. 

  511. 			<a href="#sec-description">Description</a> |
    512. 

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

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

  514. 						
    515. 

  515. 		</div>
    516. 

  516. 		<div class="info-box-body">
    517. 

  517. 			<A NAME='method_detail'></A>
    518. 

  518. <a name="methodSloodleUser" id="SloodleUser"><!-- --></a>
    519. 

  519. <div class="evenrow">
    520. 

  520. 	
    521. 

  521. 	<div class="method-header">
    522. 

  522. 		<img src="../media/images/Constructor.png" />
    523. 

  523. 		<span class="method-title">Constructor SloodleUser</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a109">109</a></span>)
    524. 

  524. 	</div> 
    525. 

  525. 	
    526. 

  526. 	<!-- ========== Info from phpDoc block ========= -->
    527. 

  527. <p class="short-description">Class constructor.</p>
    528. 

  528. 	<ul class="tags">
    529. 

  529. 				<li><span class="field">access:</span> public</li>
    530. 

  530. 			</ul>
    531. 

  531. 	
    532. 

  532. 	<div class="method-signature">
    533. 

  533. 		<span class="method-result">void</span>
    534. 

  534. 		<span class="method-name">
    535. 

  535. 			SloodleUser
    536. 

  536. 		</span>
    537. 

  537. 				()
    538. 

  538. 			</div>
    539. 

  539. 	
    540. 

  540. 		
    541. 

  541. 			
    542. 

  542. 	</div>
    543. 

  543. <a name="methodcreate_moodle_user" id="create_moodle_user"><!-- --></a>
    544. 

  544. <div class="oddrow">
    545. 

  545. 	
    546. 

  546. 	<div class="method-header">
    547. 

  547. 		<img src="../media/images/Method.png" />
    548. 

  548. 		<span class="method-title">create_moodle_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a453">453</a></span>)
    549. 

  549. 	</div> 
    550. 

  550. 	
    551. 

  551. 	<!-- ========== Info from phpDoc block ========= -->
    552. 

  552. <p class="short-description">Create a Moodle user account with the specified first name, last name and email address.</p>
    553. 

  553. 	<ul class="tags">
    554. 

  554. 				<li><span class="field">return:</span> True if successful, or a string error message if something goes wrong.</li>
    555. 

  555. 				<li><span class="field">access:</span> public</li>
    556. 

  556. 			</ul>
    557. 

  557. 	
    558. 

  558. 	<div class="method-signature">
    559. 

  559. 		<span class="method-result">mixed</span>
    560. 

  560. 		<span class="method-name">
    561. 

  561. 			create_moodle_user
    562. 

  562. 		</span>
    563. 

  563. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$firstname</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$lastname</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$email</span>)
    564. 

  564. 			</div>
    565. 

  565. 	
    566. 

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

  567. 					<li>
    568. 

  568. 				<span class="var-type"></span>
    569. 

  569. 				<span class="var-name">$firstname</span>			</li>
    570. 

  570. 					<li>
    571. 

  571. 				<span class="var-type"></span>
    572. 

  572. 				<span class="var-name">$lastname</span>			</li>
    573. 

  573. 					<li>
    574. 

  574. 				<span class="var-type"></span>
    575. 

  575. 				<span class="var-name">$email</span>			</li>
    576. 

  576. 				</ul>
    577. 

  577. 		
    578. 

  578. 			
    579. 

  579. 	</div>
    580. 

  580. <a name="methodcreate_sloodle_user" id="create_sloodle_user"><!-- --></a>
    581. 

  581. <div class="evenrow">
    582. 

  582. 	
    583. 

  583. 	<div class="method-header">
    584. 

  584. 		<img src="../media/images/Method.png" />
    585. 

  585. 		<span class="method-title">create_sloodle_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a347">347</a></span>)
    586. 

  586. 	</div> 
    587. 

  587. 	
    588. 

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

  589. <p class="short-description">Create a new Sloodle user.</p>
    590. 

  590. <p class="description"><p>All parameters are optional. To enable loginzone authentication, you *must* specify position and expiry time.  Note that, if no login security token is specified, it is generated automatically.  If successful, the new ID is stored and the user data is cached.</p></p>
    591. 

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

  592. 				<li><span class="field">return:</span> True if successful, or false if not.</li>
    593. 

  593. 				<li><span class="field">access:</span> public</li>
    594. 

  594. 			</ul>
    595. 

  595. 	
    596. 

  596. 	<div class="method-signature">
    597. 

  597. 		<span class="method-result">bool</span>
    598. 

  598. 		<span class="method-name">
    599. 

  599. 			create_sloodle_user
    600. 

  600. 		</span>
    601. 

  601. 					([<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$avname</span> = <span class="var-default">''</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$userid</span> = <span class="var-default">0</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$loginposition</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$loginpositionexpires</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$loginpositionregion</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$loginsecuritytoken</span> = <span class="var-default">''</span>])
    602. 

  602. 			</div>
    603. 

  603. 	
    604. 

  604. 			<ul class="parameters">
    605. 

  605. 					<li>
    606. 

  606. 				<span class="var-type">string</span>
    607. 

  607. 				<span class="var-name">$uuid</span><span class="var-description">: avatar UUID</span>			</li>
    608. 

  608. 					<li>
    609. 

  609. 				<span class="var-type">string</span>
    610. 

  610. 				<span class="var-name">$avname</span><span class="var-description">: avatar name</span>			</li>
    611. 

  611. 					<li>
    612. 

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

  613. 				<span class="var-name">$userid</span><span class="var-description">: ID of Moodle user to be linked with this Sloodle user</span>			</li>
    614. 

  614. 					<li>
    615. 

  615. 				<span class="var-type">string</span>
    616. 

  616. 				<span class="var-name">$loginposition</span><span class="var-description">: a position vector of format &lt;x,y,z&gt;, representing the allocated loginzone position</span>			</li>
    617. 

  617. 					<li>
    618. 

  618. 				<span class="var-type">string</span>
    619. 

  619. 				<span class="var-name">$loginpositionexpires</span><span class="var-description">: an indication of when the allocated loginposition expires (format unknown)</span>			</li>
    620. 

  620. 					<li>
    621. 

  621. 				<span class="var-type">string</span>
    622. 

  622. 				<span class="var-name">$loginpositionregion</span><span class="var-description">: the name of the region in which the loginzone is (NOT IN USE YET!)</span>			</li>
    623. 

  623. 					<li>
    624. 

  624. 				<span class="var-type">string</span>
    625. 

  625. 				<span class="var-name">$loginsecuritytoken</span><span class="var-description">: a security token (random letters/numbers) used to allow secure authentication</span>			</li>
    626. 

  626. 				</ul>
    627. 

  627. 		
    628. 

  628. 			
    629. 

  629. 	</div>
    630. 

  630. <a name="methoddelete_login_position" id="delete_login_position"><!-- --></a>
    631. 

  631. <div class="oddrow">
    632. 

  632. 	
    633. 

  633. 	<div class="method-header">
    634. 

  634. 		<img src="../media/images/Method.png" />
    635. 

  635. 		<span class="method-title">delete_login_position</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a379">379</a></span>)
    636. 

  636. 	</div> 
    637. 

  637. 	
    638. 

  638. 	<!-- ========== Info from phpDoc block ========= -->
    639. 

  639. <p class="short-description">Clears the login position from the currently selected Sloodle user.</p>
    640. 

  640. <p class="description"><p>This function will user the user identified by {@link:$sloodle_user_id},  retrieve all the user data, remove the login position values, and update the database.</p></p>
    641. 

  641. 	<ul class="tags">
    642. 

  642. 				<li><span class="field">return:</span> True if successful, false if the database query fails, or a string if an error occurs.</li>
    643. 

  643. 				<li><span class="field">access:</span> public</li>
    644. 

  644. 			</ul>
    645. 

  645. 	
    646. 

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

  647. 		<span class="method-result">mixed</span>
    648. 

  648. 		<span class="method-name">
    649. 

  649. 			delete_login_position
    650. 

  650. 		</span>
    651. 

  651. 				()
    652. 

  652. 			</div>
    653. 

  653. 	
    654. 

  654. 		
    655. 

  655. 			
    656. 

  656. 	</div>
    657. 

  657. <a name="methoddelete_sloodle_user" id="delete_sloodle_user"><!-- --></a>
    658. 

  658. <div class="evenrow">
    659. 

  659. 	
    660. 

  660. 	<div class="method-header">
    661. 

  661. 		<img src="../media/images/Method.png" />
    662. 

  662. 		<span class="method-title">delete_sloodle_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a243">243</a></span>)
    663. 

  663. 	</div> 
    664. 

  664. 	
    665. 

  665. 	<!-- ========== Info from phpDoc block ========= -->
    666. 

  666. <p class="short-description">Deletes the Sloodle user identified by {@link:$sloodle_user_id}.</p>
    667. 

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

  668. 				<li><span class="field">return:</span> True if successful, false on failure, or a string error message if something goes wrong</li>
    669. 

  669. 				<li><span class="field">access:</span> public</li>
    670. 

  670. 			</ul>
    671. 

  671. 	
    672. 

  672. 	<div class="method-signature">
    673. 

  673. 		<span class="method-result">mixed</span>
    674. 

  674. 		<span class="method-name">
    675. 

  675. 			delete_sloodle_user
    676. 

  676. 		</span>
    677. 

  677. 				()
    678. 

  678. 			</div>
    679. 

  679. 	
    680. 

  680. 		
    681. 

  681. 			
    682. 

  682. 	</div>
    683. 

  683. <a name="methodfind_linked_moodle_user" id="find_linked_moodle_user"><!-- --></a>
    684. 

  684. <div class="oddrow">
    685. 

  685. 	
    686. 

  686. 	<div class="method-header">
    687. 

  687. 		<img src="../media/images/Method.png" />
    688. 

  688. 		<span class="method-title">find_linked_moodle_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a611">611</a></span>)
    689. 

  689. 	</div> 
    690. 

  690. 	
    691. 

  691. 	<!-- ========== Info from phpDoc block ========= -->
    692. 

  692. <p class="short-description">Find the Moodle user linked to the current Sloodle user.</p>
    693. 

  693. <p class="description"><p>Stores the Moodle user ID in {@link:$moodle_user_id}.</p></p>
    694. 

  694. 	<ul class="tags">
    695. 

  695. 				<li><span class="field">return:</span> True if successful, false if no link was found, or a string if an error occurs</li>
    696. 

  696. 				<li><span class="field">access:</span> public</li>
    697. 

  697. 			</ul>
    698. 

  698. 	
    699. 

  699. 	<div class="method-signature">
    700. 

  700. 		<span class="method-result">mixed</span>
    701. 

  701. 		<span class="method-name">
    702. 

  702. 			find_linked_moodle_user
    703. 

  703. 		</span>
    704. 

  704. 					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$use_cache</span> = <span class="var-default">FALSE</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$cache_data</span> = <span class="var-default">TRUE</span>])
    705. 

  705. 			</div>
    706. 

  706. 	
    707. 

  707. 			<ul class="parameters">
    708. 

  708. 					<li>
    709. 

  709. 				<span class="var-type">bool</span>
    710. 

  710. 				<span class="var-name">$use_cache</span><span class="var-description">: If true (not default) this function will use the local Sloodle user cache instead of querying the database again.</span>			</li>
    711. 

  711. 					<li>
    712. 

  712. 				<span class="var-type">bool</span>
    713. 

  713. 				<span class="var-name">$cache_data</span><span class="var-description">: If true (default) then the Moodle user data is automatically cached by this function</span>			</li>
    714. 

  714. 				</ul>
    715. 

  715. 		
    716. 

  716. 			
    717. 

  717. 	</div>
    718. 

  718. <a name="methodfind_linked_sloodle_user" id="find_linked_sloodle_user"><!-- --></a>
    719. 

  719. <div class="evenrow">
    720. 

  720. 	
    721. 

  721. 	<div class="method-header">
    722. 

  722. 		<img src="../media/images/Method.png" />
    723. 

  723. 		<span class="method-title">find_linked_sloodle_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a579">579</a></span>)
    724. 

  724. 	</div> 
    725. 

  725. 	
    726. 

  726. 	<!-- ========== Info from phpDoc block ========= -->
    727. 

  727. <p class="short-description">Find the Sloodle user linked to the current Moodle user.</p>
    728. 

  728. <p class="description"><p>Stores the Sloodle user ID in {@link:$sloodle_user_id}.</p></p>
    729. 

  729. 	<ul class="tags">
    730. 

  730. 				<li><span class="field">return:</span> True if successful, false if no link was found, or a string if an error occurs</li>
    731. 

  731. 				<li><span class="field">access:</span> public</li>
    732. 

  732. 			</ul>
    733. 

  733. 	
    734. 

  734. 	<div class="method-signature">
    735. 

  735. 		<span class="method-result">mixed</span>
    736. 

  736. 		<span class="method-name">
    737. 

  737. 			find_linked_sloodle_user
    738. 

  738. 		</span>
    739. 

  739. 					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$cache_data</span> = <span class="var-default">TRUE</span>])
    740. 

  740. 			</div>
    741. 

  741. 	
    742. 

  742. 			<ul class="parameters">
    743. 

  743. 					<li>
    744. 

  744. 				<span class="var-type">bool</span>
    745. 

  745. 				<span class="var-name">$cache_data</span><span class="var-description">: If true (default) then the Sloodle user data is automatically cached by this function.</span>			</li>
    746. 

  746. 				</ul>
    747. 

  747. 		
    748. 

  748. 			
    749. 

  749. 	</div>
    750. 

  750. <a name="methodfind_sloodle_user" id="find_sloodle_user"><!-- --></a>
    751. 

  751. <div class="oddrow">
    752. 

  752. 	
    753. 

  753. 	<div class="method-header">
    754. 

  754. 		<img src="../media/images/Method.png" />
    755. 

  755. 		<span class="method-title">find_sloodle_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a548">548</a></span>)
    756. 

  756. 	</div> 
    757. 

  757. 	
    758. 

  758. 	<!-- ========== Info from phpDoc block ========= -->
    759. 

  759. <p class="short-description">Attempts to find a Sloodle user by their UUID and/or avatar nam.</p>
    760. 

  760. <p class="description"><p>Note: the UUID takes precedence, but the name can be used as a fall-back.  The ID of the user is stored in {@link:$sloodle_user_id}.</p></p>
    761. 

  761. 	<ul class="tags">
    762. 

  762. 				<li><span class="field">return:</span> True if successful, false if user was not found, or a string is some other error occurred.</li>
    763. 

  763. 				<li><span class="field">access:</span> public</li>
    764. 

  764. 			</ul>
    765. 

  765. 	
    766. 

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

  767. 		<span class="method-result">mixed</span>
    768. 

  768. 		<span class="method-name">
    769. 

  769. 			find_sloodle_user
    770. 

  770. 		</span>
    771. 

  771. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$cache_data</span> = <span class="var-default">TRUE</span>])
    772. 

  772. 			</div>
    773. 

  773. 	
    774. 

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

  775. 					<li>
    776. 

  776. 				<span class="var-type">string</span>
    777. 

  777. 				<span class="var-name">$uuid</span><span class="var-description">: The UUID of the avatar</span>			</li>
    778. 

  778. 					<li>
    779. 

  779. 				<span class="var-type">string</span>
    780. 

  780. 				<span class="var-name">$name</span><span class="var-description">: The name of the avatar</span>			</li>
    781. 

  781. 					<li>
    782. 

  782. 				<span class="var-type">bool</span>
    783. 

  783. 				<span class="var-name">$cache_data</span><span class="var-description">: If true (default) then the user data is stored in the cache variable, {@link:$sloodle_user_cache}.</span>			</li>
    784. 

  784. 				</ul>
    785. 

  785. 		
    786. 

  786. 			
    787. 

  787. 	</div>
    788. 

  788. <a name="methodfind_sloodle_user_by_login_position" id="find_sloodle_user_by_login_position"><!-- --></a>
    789. 

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

  790. 	
    791. 

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

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

  793. 		<span class="method-title">find_sloodle_user_by_login_position</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a660">660</a></span>)
    794. 

  794. 	</div> 
    795. 

  795. 	
    796. 

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

  797. <p class="short-description">Attempt to find a Sloodle user by their loginzone position  If successful, the user ID is stored in {@link:$sloodle_user_id} and the function returns true.</p>
    798. 

  798. <p class="description"><p>If no user was found for the given position, false is returned (this may occur if the LoginZone position has expired).  If an error occurs, then a string containing an error message is returned.</p></p>
    799. 

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

  800. 				<li><span class="field">access:</span> public</li>
    801. 

  801. 			</ul>
    802. 

  802. 	
    803. 

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

  804. 		<span class="method-result">void</span>
    805. 

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

  806. 			find_sloodle_user_by_login_position
    807. 

  807. 		</span>
    808. 

  808. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$position</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$cache_data</span> = <span class="var-default">TRUE</span>])
    809. 

  809. 			</div>
    810. 

  810. 	
    811. 

  811. 			<ul class="parameters">
    812. 

  812. 					<li>
    813. 

  813. 				<span class="var-type">mixed</span>
    814. 

  814. 				<span class="var-name">$position</span><span class="var-description">: A vector, either as a string (&quot;&lt;x,y,z&gt;&quot;) or an associative array.</span>			</li>
    815. 

  815. 					<li>
    816. 

  816. 				<span class="var-type">bool</span>
    817. 

  817. 				<span class="var-name">$cache_data</span><span class="var-description">: If true (default) then the user data is cached. Otherwise it is discarded.</span>			</li>
    818. 

  818. 				</ul>
    819. 

  819. 		
    820. 

  820. 			
    821. 

  821. 	</div>
    822. 

  822. <a name="methodgenerate_login_position" id="generate_login_position"><!-- --></a>
    823. 

  823. <div class="oddrow">
    824. 

  824. 	
    825. 

  825. 	<div class="method-header">
    826. 

  826. 		<img src="../media/images/Method.png" />
    827. 

  827. 		<span class="method-title">generate_login_position</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a402">402</a></span>)
    828. 

  828. 	</div> 
    829. 

  829. 	
    830. 

  830. 	<!-- ========== Info from phpDoc block ========= -->
    831. 

  831. <p class="short-description">Generates a new login position for the current Sloodle user.</p>
    832. 

  832. <p class="description"><p>Stores the new login position in the database, and refreshes the user cache</p></p>
    833. 

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

  834. 				<li><span class="field">return:</span> A numerical array containing the new position if successful, FALSE on failure, or a string if an error occurs</li>
    835. 

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

  836. 			</ul>
    837. 

  837. 	
    838. 

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

  839. 		<span class="method-result">mixed</span>
    840. 

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

  841. 			generate_login_position
    842. 

  842. 		</span>
    843. 

  843. 					(<span class="var-type">int</span>&nbsp;<span class="var-name">$expires</span>)
    844. 

  844. 			</div>
    845. 

  845. 	
    846. 

  846. 			<ul class="parameters">
    847. 

  847. 					<li>
    848. 

  848. 				<span class="var-type">int</span>
    849. 

  849. 				<span class="var-name">$expires</span><span class="var-description">: A timestamp indicating when the position should expire.</span>			</li>
    850. 

  850. 				</ul>
    851. 

  851. 		
    852. 

  852. 			
    853. 

  853. 	</div>
    854. 

  854. <a name="methodget_moodle_user_id" id="get_moodle_user_id"><!-- --></a>
    855. 

  855. <div class="evenrow">
    856. 

  856. 	
    857. 

  857. 	<div class="method-header">
    858. 

  858. 		<img src="../media/images/Method.png" />
    859. 

  859. 		<span class="method-title">get_moodle_user_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a146">146</a></span>)
    860. 

  860. 	</div> 
    861. 

  861. 	
    862. 

  862. 	<!-- ========== Info from phpDoc block ========= -->
    863. 

  863. <p class="short-description">Accessor: gets the Moodle user ID member, {@link: $moodle_user_id}.</p>
    864. 

  864. 	<ul class="tags">
    865. 

  865. 				<li><span class="field">access:</span> public</li>
    866. 

  866. 			</ul>
    867. 

  867. 	
    868. 

  868. 	<div class="method-signature">
    869. 

  869. 		<span class="method-result">int</span>
    870. 

  870. 		<span class="method-name">
    871. 

  871. 			get_moodle_user_id
    872. 

  872. 		</span>
    873. 

  873. 				()
    874. 

  874. 			</div>
    875. 

  875. 	
    876. 

  876. 		
    877. 

  877. 			
    878. 

  878. 	</div>
    879. 

  879. <a name="methodget_sloodle_user_id" id="get_sloodle_user_id"><!-- --></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_sloodle_user_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a125">125</a></span>)
    885. 

  885. 	</div> 
    886. 

  886. 	
    887. 

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

  888. <p class="short-description">Accessor: gets the Sloodle user ID member, {@link: $sloodle_user_id}.</p>
    889. 

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

  890. 				<li><span class="field">access:</span> public</li>
    891. 

  891. 			</ul>
    892. 

  892. 	
    893. 

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

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

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

  896. 			get_sloodle_user_id
    897. 

  897. 		</span>
    898. 

  898. 				()
    899. 

  899. 			</div>
    900. 

  900. 	
    901. 

  901. 		
    902. 

  902. 			
    903. 

  903. 	</div>
    904. 

  904. <a name="methodhas_login_security_token" id="has_login_security_token"><!-- --></a>
    905. 

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

  906. 	
    907. 

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

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

  909. 		<span class="method-title">has_login_security_token</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a770">770</a></span>)
    910. 

  910. 	</div> 
    911. 

  911. 	
    912. 

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

  913. <p class="short-description">Checks if the current Sloodle user has a login security token</p>
    914. 

  914. 	<ul class="tags">
    915. 

  915. 				<li><span class="field">return:</span> True if the user has a login security token, or false otherwise.</li>
    916. 

  916. 				<li><span class="field">access:</span> public</li>
    917. 

  917. 			</ul>
    918. 

  918. 	
    919. 

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

  920. 		<span class="method-result">bool</span>
    921. 

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

  922. 			has_login_security_token
    923. 

  923. 		</span>
    924. 

  924. 					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$use_cache</span> = <span class="var-default">FALSE</span>])
    925. 

  925. 			</div>
    926. 

  926. 	
    927. 

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

  928. 					<li>
    929. 

  929. 				<span class="var-type">bool</span>
    930. 

  930. 				<span class="var-name">$use_cache</span><span class="var-description">: If true then the cached user data will be used instead of querying the database.</span>			</li>
    931. 

  931. 				</ul>
    932. 

  932. 		
    933. 

  933. 			
    934. 

  934. 	</div>
    935. 

  935. <a name="methodinsert_sloodle_user_cache_to_db" id="insert_sloodle_user_cache_to_db"><!-- --></a>
    936. 

  936. <div class="oddrow">
    937. 

  937. 	
    938. 

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

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

  940. 		<span class="method-title">insert_sloodle_user_cache_to_db</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a317">317</a></span>)
    941. 

  941. 	</div> 
    942. 

  942. 	
    943. 

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

  944. <p class="short-description">Use the Sloodle user cache to insert a new entry in the Sloodle user database table.</p>
    945. 

  945. <p class="description"><p>Uses the object entirely as-is, except that the 'id' field is ignored.  The ID of the new entry is stored in {@link:$sloodle_user_id}.</p></p>
    946. 

  946. 	<ul class="tags">
    947. 

  947. 				<li><span class="field">return:</span> True if successful, or false on failure.</li>
    948. 

  948. 				<li><span class="field">access:</span> public</li>
    949. 

  949. 			</ul>
    950. 

  950. 	
    951. 

  951. 	<div class="method-signature">
    952. 

  952. 		<span class="method-result">bool</span>
    953. 

  953. 		<span class="method-name">
    954. 

  954. 			insert_sloodle_user_cache_to_db
    955. 

  955. 		</span>
    956. 

  956. 				()
    957. 

  957. 			</div>
    958. 

  958. 	
    959. 

  959. 		
    960. 

  960. 			
    961. 

  961. 	</div>
    962. 

  962. <a name="methodis_user_in_course" id="is_user_in_course"><!-- --></a>
    963. 

  963. <div class="evenrow">
    964. 

  964. 	
    965. 

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

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

  967. 		<span class="method-title">is_user_in_course</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a831">831</a></span>)
    968. 

  968. 	</div> 
    969. 

  969. 	
    970. 

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

  971. <p class="short-description">Checks if the current Moodle user is already enrolled in the specified course.</p>
    972. 

  972. 	<ul class="tags">
    973. 

  973. 				<li><span class="field">access:</span> public</li>
    974. 

  974. 			</ul>
    975. 

  975. 	
    976. 

  976. 	<div class="method-signature">
    977. 

  977. 		<span class="method-result">void</span>
    978. 

  978. 		<span class="method-name">
    979. 

  979. 			is_user_in_course
    980. 

  980. 		</span>
    981. 

  981. 					(<span class="var-type">int</span>&nbsp;<span class="var-name">$course_id</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$use_cache</span> = <span class="var-default">FALSE</span>], <span class="var-type">bool</span>&nbsp;<span class="var-name">2</span>)
    982. 

  982. 			</div>
    983. 

  983. 	
    984. 

  984. 			<ul class="parameters">
    985. 

  985. 					<li>
    986. 

  986. 				<span class="var-type">int</span>
    987. 

  987. 				<span class="var-name">$course_id</span><span class="var-description">: ID number of a course to check.</span>			</li>
    988. 

  988. 					<li>
    989. 

  989. 				<span class="var-type">bool</span>
    990. 

  990. 				<span class="var-name">$use_cache</span><span class="var-description">: If true (not default) then the function uses the enrolled courses cache, instead of querying the database for new data.</span>			</li>
    991. 

  991. 					<li>
    992. 

  992. 				<span class="var-type">bool</span>
    993. 

  993. 				<span class="var-name">2</span><span class="var-description">: True if the user is enrolled, or false if not.</span>			</li>
    994. 

  994. 				</ul>
    995. 

  995. 		
    996. 

  996. 			
    997. 

  997. 	</div>
    998. 

  998. <a name="methodlink_users" id="link_users"><!-- --></a>
    999. 

  999. <div class="oddrow">
    1000. 

  1000. 	
    1001. 

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

  1002. 		<img src="../media/images/Method.png" />
    1003. 

  1003. 		<span class="method-title">link_users</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a200">200</a></span>)
    1004. 

  1004. 	</div> 
    1005. 

  1005. 	
    1006. 

  1006. 	<!-- ========== Info from phpDoc block ========= -->
    1007. 

  1007. <p class="short-description">Links the current Sloodle and Moodle accounts together.</p>
    1008. 

  1008. <p class="description"><p><strong>NOTE:</strong> does not remove any other links to the Moodle account.</p></p>
    1009. 

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

  1010. 				<li><span class="field">return:</span> True if successful, false on failure, or a string error message if something goes wrong</li>
    1011. 

  1011. 				<li><span class="field">access:</span> public</li>
    1012. 

  1012. 			</ul>
    1013. 

  1013. 	
    1014. 

  1014. 	<div class="method-signature">
    1015. 

  1015. 		<span class="method-result">mixed</span>
    1016. 

  1016. 		<span class="method-name">
    1017. 

  1017. 			link_users
    1018. 

  1018. 		</span>
    1019. 

  1019. 				()
    1020. 

  1020. 			</div>
    1021. 

  1021. 	
    1022. 

  1022. 		
    1023. 

  1023. 			
    1024. 

  1024. 	</div>
    1025. 

  1025. <a name="methodlogin_moodle_user" id="login_moodle_user"><!-- --></a>
    1026. 

  1026. <div class="evenrow">
    1027. 

  1027. 	
    1028. 

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

  1029. 		<img src="../media/images/Method.png" />
    1030. 

  1030. 		<span class="method-title">login_moodle_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a728">728</a></span>)
    1031. 

  1031. 	</div> 
    1032. 

  1032. 	
    1033. 

  1033. 	<!-- ========== Info from phpDoc block ========= -->
    1034. 

  1034. <p class="short-description">Performs an internal login of the current Moodle user.</p>
    1035. 

  1035. <p class="description"><p>Stores all the user data in the global $USER variable.  Note: if login fails, $USER is unchanged.  Additionally, note that this function will not perform automatic registration.</p></p>
    1036. 

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

  1037. 				<li><span class="field">return:</span> True if successful, or false otherwise.</li>
    1038. 

  1038. 				<li><span class="field">access:</span> public</li>
    1039. 

  1039. 			</ul>
    1040. 

  1040. 	
    1041. 

  1041. 	<div class="method-signature">
    1042. 

  1042. 		<span class="method-result">bool</span>
    1043. 

  1043. 		<span class="method-name">
    1044. 

  1044. 			login_moodle_user
    1045. 

  1045. 		</span>
    1046. 

  1046. 				()
    1047. 

  1047. 			</div>
    1048. 

  1048. 	
    1049. 

  1049. 		
    1050. 

  1050. 			
    1051. 

  1051. 	</div>
    1052. 

  1052. <a name="methodregenerate_login_security_token" id="regenerate_login_security_token"><!-- --></a>
    1053. 

  1053. <div class="oddrow">
    1054. 

  1054. 	
    1055. 

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

  1056. 		<img src="../media/images/Method.png" />
    1057. 

  1057. 		<span class="method-title">regenerate_login_security_token</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a747">747</a></span>)
    1058. 

  1058. 	</div> 
    1059. 

  1059. 	
    1060. 

  1060. 	<!-- ========== Info from phpDoc block ========= -->
    1061. 

  1061. <p class="short-description">Generates a new login security token for the current Sloodle user</p>
    1062. 

  1062. 	<ul class="tags">
    1063. 

  1063. 				<li><span class="field">return:</span> True if successful, or false if an error occurs (such as there being no current Sloodle user)</li>
    1064. 

  1064. 				<li><span class="field">access:</span> public</li>
    1065. 

  1065. 			</ul>
    1066. 

  1066. 	
    1067. 

  1067. 	<div class="method-signature">
    1068. 

  1068. 		<span class="method-result">bool</span>
    1069. 

  1069. 		<span class="method-name">
    1070. 

  1070. 			regenerate_login_security_token
    1071. 

  1071. 		</span>
    1072. 

  1072. 					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$cache_data</span> = <span class="var-default">TRUE</span>])
    1073. 

  1073. 			</div>
    1074. 

  1074. 	
    1075. 

  1075. 			<ul class="parameters">
    1076. 

  1076. 					<li>
    1077. 

  1077. 				<span class="var-type">bool</span>
    1078. 

  1078. 				<span class="var-name">$cache_data</span><span class="var-description">: If true (default) then the new login security token will be stored in the Sloodle user cache (as well as the database).</span>			</li>
    1079. 

  1079. 				</ul>
    1080. 

  1080. 		
    1081. 

  1081. 			
    1082. 

  1082. 	</div>
    1083. 

  1083. <a name="methodset_moodle_user_id" id="set_moodle_user_id"><!-- --></a>
    1084. 

  1084. <div class="evenrow">
    1085. 

  1085. 	
    1086. 

  1086. 	<div class="method-header">
    1087. 

  1087. 		<img src="../media/images/Method.png" />
    1088. 

  1088. 		<span class="method-title">set_moodle_user_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a157">157</a></span>)
    1089. 

  1089. 	</div> 
    1090. 

  1090. 	
    1091. 

  1091. 	<!-- ========== Info from phpDoc block ========= -->
    1092. 

  1092. <p class="short-description">Accessor: sets the Moodle user ID member, {@link: $moodle_user_id}.</p>
    1093. 

  1093. 	<ul class="tags">
    1094. 

  1094. 				<li><span class="field">access:</span> public</li>
    1095. 

  1095. 			</ul>
    1096. 

  1096. 	
    1097. 

  1097. 	<div class="method-signature">
    1098. 

  1098. 		<span class="method-result">void</span>
    1099. 

  1099. 		<span class="method-name">
    1100. 

  1100. 			set_moodle_user_id
    1101. 

  1101. 		</span>
    1102. 

  1102. 					(<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>)
    1103. 

  1103. 			</div>
    1104. 

  1104. 	
    1105. 

  1105. 			<ul class="parameters">
    1106. 

  1106. 					<li>
    1107. 

  1107. 				<span class="var-type">int</span>
    1108. 

  1108. 				<span class="var-name">$id</span><span class="var-description">: The integer ID of a Moodle user entry (or 0 for no entry).</span>			</li>
    1109. 

  1109. 				</ul>
    1110. 

  1110. 		
    1111. 

  1111. 			
    1112. 

  1112. 	</div>
    1113. 

  1113. <a name="methodset_sloodle_user_id" id="set_sloodle_user_id"><!-- --></a>
    1114. 

  1114. <div class="oddrow">
    1115. 

  1115. 	
    1116. 

  1116. 	<div class="method-header">
    1117. 

  1117. 		<img src="../media/images/Method.png" />
    1118. 

  1118. 		<span class="method-title">set_sloodle_user_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a136">136</a></span>)
    1119. 

  1119. 	</div> 
    1120. 

  1120. 	
    1121. 

  1121. 	<!-- ========== Info from phpDoc block ========= -->
    1122. 

  1122. <p class="short-description">Accessor: sets the Sloodle user ID member, {@link: $sloodle_user_id}.</p>
    1123. 

  1123. 	<ul class="tags">
    1124. 

  1124. 				<li><span class="field">access:</span> public</li>
    1125. 

  1125. 			</ul>
    1126. 

  1126. 	
    1127. 

  1127. 	<div class="method-signature">
    1128. 

  1128. 		<span class="method-result">void</span>
    1129. 

  1129. 		<span class="method-name">
    1130. 

  1130. 			set_sloodle_user_id
    1131. 

  1131. 		</span>
    1132. 

  1132. 					(<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>)
    1133. 

  1133. 			</div>
    1134. 

  1134. 	
    1135. 

  1135. 			<ul class="parameters">
    1136. 

  1136. 					<li>
    1137. 

  1137. 				<span class="var-type">int</span>
    1138. 

  1138. 				<span class="var-name">$id</span><span class="var-description">: The integer ID of a Sloodle user entry (or 0 for no entry).</span>			</li>
    1139. 

  1139. 				</ul>
    1140. 

  1140. 		
    1141. 

  1141. 			
    1142. 

  1142. 	</div>
    1143. 

  1143. <a name="methodunlink_sloodle_user" id="unlink_sloodle_user"><!-- --></a>
    1144. 

  1144. <div class="evenrow">
    1145. 

  1145. 	
    1146. 

  1146. 	<div class="method-header">
    1147. 

  1147. 		<img src="../media/images/Method.png" />
    1148. 

  1148. 		<span class="method-title">unlink_sloodle_user</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a221">221</a></span>)
    1149. 

  1149. 	</div> 
    1150. 

  1150. 	
    1151. 

  1151. 	<!-- ========== Info from phpDoc block ========= -->
    1152. 

  1152. <p class="short-description">Completely unlinks the Sloodle user from any Moodle account.</p>
    1153. 

  1153. 	<ul class="tags">
    1154. 

  1154. 				<li><span class="field">return:</span> True if successful, false on failure, or a string error message if something goes wrong</li>
    1155. 

  1155. 				<li><span class="field">access:</span> public</li>
    1156. 

  1156. 			</ul>
    1157. 

  1157. 	
    1158. 

  1158. 	<div class="method-signature">
    1159. 

  1159. 		<span class="method-result">mixed</span>
    1160. 

  1160. 		<span class="method-name">
    1161. 

  1161. 			unlink_sloodle_user
    1162. 

  1162. 		</span>
    1163. 

  1163. 				()
    1164. 

  1164. 			</div>
    1165. 

  1165. 	
    1166. 

  1166. 		
    1167. 

  1167. 			
    1168. 

  1168. 	</div>
    1169. 

  1169. <a name="methodupdate_enrolled_courses_cache_from_db" id="update_enrolled_courses_cache_from_db"><!-- --></a>
    1170. 

  1170. <div class="oddrow">
    1171. 

  1171. 	
    1172. 

  1172. 	<div class="method-header">
    1173. 

  1173. 		<img src="../media/images/Method.png" />
    1174. 

  1174. 		<span class="method-title">update_enrolled_courses_cache_from_db</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a801">801</a></span>)
    1175. 

  1175. 	</div> 
    1176. 

  1176. 	
    1177. 

  1177. 	<!-- ========== Info from phpDoc block ========= -->
    1178. 

  1178. <p class="short-description">Use the database to update the cache of courses which the current Moodle user is enrolled in.</p>
    1179. 

  1179. <p class="description"><p>Note that admins are considered by this function to be enrolled in all courses.</p></p>
    1180. 

  1180. 	<ul class="tags">
    1181. 

  1181. 				<li><span class="field">return:</span> if successul, or false otherwise.</li>
    1182. 

  1182. 				<li><span class="field">access:</span> public</li>
    1183. 

  1183. 			</ul>
    1184. 

  1184. 	
    1185. 

  1185. 	<div class="method-signature">
    1186. 

  1186. 		<span class="method-result">True</span>
    1187. 

  1187. 		<span class="method-name">
    1188. 

  1188. 			update_enrolled_courses_cache_from_db
    1189. 

  1189. 		</span>
    1190. 

  1190. 				()
    1191. 

  1191. 			</div>
    1192. 

  1192. 	
    1193. 

  1193. 		
    1194. 

  1194. 			
    1195. 

  1195. 	</div>
    1196. 

  1196. <a name="methodupdate_moodle_user_cache_from_db" id="update_moodle_user_cache_from_db"><!-- --></a>
    1197. 

  1197. <div class="evenrow">
    1198. 

  1198. 	
    1199. 

  1199. 	<div class="method-header">
    1200. 

  1200. 		<img src="../media/images/Method.png" />
    1201. 

  1201. 		<span class="method-title">update_moodle_user_cache_from_db</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a273">273</a></span>)
    1202. 

  1202. 	</div> 
    1203. 

  1203. 	
    1204. 

  1204. 	<!-- ========== Info from phpDoc block ========= -->
    1205. 

  1205. <p class="short-description">Update the Moodle user cache ({@link:$moodle_user_cache}) from the database</p>
    1206. 

  1206. 	<ul class="tags">
    1207. 

  1207. 				<li><span class="field">return:</span> True if successful, false on failure, or a string error message if something goes wrong</li>
    1208. 

  1208. 				<li><span class="field">access:</span> public</li>
    1209. 

  1209. 			</ul>
    1210. 

  1210. 	
    1211. 

  1211. 	<div class="method-signature">
    1212. 

  1212. 		<span class="method-result">mixed</span>
    1213. 

  1213. 		<span class="method-name">
    1214. 

  1214. 			update_moodle_user_cache_from_db
    1215. 

  1215. 		</span>
    1216. 

  1216. 				()
    1217. 

  1217. 			</div>
    1218. 

  1218. 	
    1219. 

  1219. 		
    1220. 

  1220. 			
    1221. 

  1221. 	</div>
    1222. 

  1222. <a name="methodupdate_sloodle_user_cache_from_db" id="update_sloodle_user_cache_from_db"><!-- --></a>
    1223. 

  1223. <div class="oddrow">
    1224. 

  1224. 	
    1225. 

  1225. 	<div class="method-header">
    1226. 

  1226. 		<img src="../media/images/Method.png" />
    1227. 

  1227. 		<span class="method-title">update_sloodle_user_cache_from_db</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a257">257</a></span>)
    1228. 

  1228. 	</div> 
    1229. 

  1229. 	
    1230. 

  1230. 	<!-- ========== Info from phpDoc block ========= -->
    1231. 

  1231. <p class="short-description">Updates the Sloodle user cache ({@link:$sloodle_user_cache}) from the database</p>
    1232. 

  1232. 	<ul class="tags">
    1233. 

  1233. 				<li><span class="field">return:</span> True if successful, false on failure, or a string error message if something goes wrong</li>
    1234. 

  1234. 				<li><span class="field">access:</span> public</li>
    1235. 

  1235. 			</ul>
    1236. 

  1236. 	
    1237. 

  1237. 	<div class="method-signature">
    1238. 

  1238. 		<span class="method-result">mixed</span>
    1239. 

  1239. 		<span class="method-name">
    1240. 

  1240. 			update_sloodle_user_cache_from_db
    1241. 

  1241. 		</span>
    1242. 

  1242. 				()
    1243. 

  1243. 			</div>
    1244. 

  1244. 	
    1245. 

  1245. 		
    1246. 

  1246. 			
    1247. 

  1247. 	</div>
    1248. 

  1248. <a name="methodupdate_sloodle_user_cache_to_db" id="update_sloodle_user_cache_to_db"><!-- --></a>
    1249. 

  1249. <div class="evenrow">
    1250. 

  1250. 	
    1251. 

  1251. 	<div class="method-header">
    1252. 

  1252. 		<img src="../media/images/Method.png" />
    1253. 

  1253. 		<span class="method-title">update_sloodle_user_cache_to_db</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a291">291</a></span>)
    1254. 

  1254. 	</div> 
    1255. 

  1255. 	
    1256. 

  1256. 	<!-- ========== Info from phpDoc block ========= -->
    1257. 

  1257. <p class="short-description">Use the Sloodle user cache to update an entry in the Sloodle users database table.</p>
    1258. 

  1258. <p class="description"><p>Uses the object-entirely as-is, so the 'id' field must be accurate.  Ignores anu unset fields.</p></p>
    1259. 

  1259. 	<ul class="tags">
    1260. 

  1260. 				<li><span class="field">return:</span> True if successful, false if the query fails, or a string error message if something goes wrong</li>
    1261. 

  1261. 				<li><span class="field">access:</span> public</li>
    1262. 

  1262. 			</ul>
    1263. 

  1263. 	
    1264. 

  1264. 	<div class="method-signature">
    1265. 

  1265. 		<span class="method-result">mixed</span>
    1266. 

  1266. 		<span class="method-name">
    1267. 

  1267. 			update_sloodle_user_cache_to_db
    1268. 

  1268. 		</span>
    1269. 

  1269. 				()
    1270. 

  1270. 			</div>
    1271. 

  1271. 	
    1272. 

  1272. 		
    1273. 

  1273. 			
    1274. 

  1274. 	</div>
    1275. 

  1275. <a name="methodusers_linked" id="users_linked"><!-- --></a>
    1276. 

  1276. <div class="oddrow">
    1277. 

  1277. 	
    1278. 

  1278. 	<div class="method-header">
    1279. 

  1279. 		<img src="../media/images/Method.png" />
    1280. 

  1280. 		<span class="method-title">users_linked</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libsl_userlib.php.html#a171">171</a></span>)
    1281. 

  1281. 	</div> 
    1282. 

  1282. 	
    1283. 

  1283. 	<!-- ========== Info from phpDoc block ========= -->
    1284. 

  1284. <p class="short-description">Determines whether or not the current Sloodle and Moodle users are linked.</p>
    1285. 

  1285. 	<ul class="tags">
    1286. 

  1286. 				<li><span class="field">return:</span> Ture if users are linked, false if not, or a string error message if something goes wrong.</li>
    1287. 

  1287. 				<li><span class="field">access:</span> public</li>
    1288. 

  1288. 			</ul>
    1289. 

  1289. 	
    1290. 

  1290. 	<div class="method-signature">
    1291. 

  1291. 		<span class="method-result">mixed</span>
    1292. 

  1292. 		<span class="method-name">
    1293. 

  1293. 			users_linked
    1294. 

  1294. 		</span>
    1295. 

  1295. 					([<span class="var-type">bool</span>&nbsp;<span class="var-name">$use_cache</span> = <span class="var-default">FALSE</span>])
    1296. 

  1296. 			</div>
    1297. 

  1297. 	
    1298. 

  1298. 			<ul class="parameters">
    1299. 

  1299. 					<li>
    1300. 

  1300. 				<span class="var-type">bool</span>
    1301. 

  1301. 				<span class="var-name">$use_cache</span><span class="var-description">: If true (not default) then the Sloodle and Moodle user caches ({@link:$sloodle_user_cache} and {@link:$moodle_user_cache})will be used instead of querying the database.</span>			</li>
    1302. 

  1302. 				</ul>
    1303. 

  1303. 		
    1304. 

  1304. 			
    1305. 

  1305. 	</div>
    1306. 

  1306. 						
    1307. 

  1307. 		</div>
    1308. 

  1308. 	</div>
    1309. 

  1309. 

  1310. 	
    1311. 

  1311. 	<p class="notes" id="credit">
    1312. 

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

  1313. 	</p>
    1314. 

  1314. 	</div></body>
    1315. 

  1315. </html>
    1316.