elementindex_sloodle.html 95 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title></title>
  7. <link rel="stylesheet" href="media/stylesheet.css" />
  8. </head>
  9. <body>
  10. <a name="top"></a>
  11. <h2>[sloodle] element index</h2>
  12. <h3>Package indexes</h3>
  13. <ul>
  14. <li><a href="elementindex_sloodleblog.html">sloodleblog</a></li>
  15. <li><a href="elementindex_sloodleplaceholders.html">sloodleplaceholders</a></li>
  16. <li><a href="elementindex_sloodlelang.html">sloodlelang</a></li>
  17. <li><a href="elementindex_sloodlelogin.html">sloodlelogin</a></li>
  18. <li><a href="elementindex_sloodlechat.html">sloodlechat</a></li>
  19. <li><a href="elementindex_sloodlechoice.html">sloodlechoice</a></li>
  20. <li><a href="elementindex_sloodleglossary.html">sloodleglossary</a></li>
  21. <li><a href="elementindex_sloodlequiz.html">sloodlequiz</a></li>
  22. <li><a href="elementindex_sloodleclassroom.html">sloodleclassroom</a></li>
  23. <li><a href="elementindex_sloodledistrib.html">sloodledistrib</a></li>
  24. </ul>
  25. <a href="elementindex.html">All elements</a>
  26. <br />
  27. <div class="index-letter-menu">
  28. <a class="index-letter" href="elementindex_sloodle.html#a">a</a>
  29. <a class="index-letter" href="elementindex_sloodle.html#c">c</a>
  30. <a class="index-letter" href="elementindex_sloodle.html#d">d</a>
  31. <a class="index-letter" href="elementindex_sloodle.html#e">e</a>
  32. <a class="index-letter" href="elementindex_sloodle.html#f">f</a>
  33. <a class="index-letter" href="elementindex_sloodle.html#g">g</a>
  34. <a class="index-letter" href="elementindex_sloodle.html#h">h</a>
  35. <a class="index-letter" href="elementindex_sloodle.html#i">i</a>
  36. <a class="index-letter" href="elementindex_sloodle.html#l">l</a>
  37. <a class="index-letter" href="elementindex_sloodle.html#m">m</a>
  38. <a class="index-letter" href="elementindex_sloodle.html#p">p</a>
  39. <a class="index-letter" href="elementindex_sloodle.html#q">q</a>
  40. <a class="index-letter" href="elementindex_sloodle.html#r">r</a>
  41. <a class="index-letter" href="elementindex_sloodle.html#s">s</a>
  42. <a class="index-letter" href="elementindex_sloodle.html#t">t</a>
  43. <a class="index-letter" href="elementindex_sloodle.html#u">u</a>
  44. <a class="index-letter" href="elementindex_sloodle.html#v">v</a>
  45. <a class="index-letter" href="elementindex_sloodle.html#_">_</a>
  46. </div>
  47. <a name="_"></a>
  48. <div class="index-letter-section">
  49. <div style="float: left" class="index-letter-title">_</div>
  50. <div style="float: right"><a href="#top">top</a></div>
  51. <div style="clear: both"></div>
  52. </div>
  53. <dl>
  54. <dt class="field">
  55. <img src="media/images/PrivateMethod.png" alt="Method" title="Method" /></title>
  56. <span class="method-title">_internal_validation_error</span>
  57. </dt>
  58. <dd class="index-item-body">
  59. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#method_internal_validation_error">SloodleLSLResponse::_internal_validation_error()</a> in sl_iolib.php</div>
  60. <div class="index-item-description">Internal function to report a data validation error.</div>
  61. </dd>
  62. </dl>
  63. <a name="a"></a>
  64. <div class="index-letter-section">
  65. <div style="float: left" class="index-letter-title">a</div>
  66. <div style="float: right"><a href="#top">top</a></div>
  67. <div style="clear: both"></div>
  68. </div>
  69. <dl>
  70. <dt class="field">
  71. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  72. <span class="var-title">$auth_status</span>
  73. </dt>
  74. <dd class="index-item-body">
  75. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#var$auth_status">SloodleLSLRequest::$auth_status</a> in sl_iolib.php</div>
  76. <div class="index-item-description">Indicates the status of request authentication.</div>
  77. </dd>
  78. <dt class="field">
  79. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  80. <span class="var-title">$avatar_name</span>
  81. </dt>
  82. <dd class="index-item-body">
  83. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#var$avatar_name">SloodleLSLRequest::$avatar_name</a> in sl_iolib.php</div>
  84. <div class="index-item-description">String name of the SL agent specified in the request (or NULL if not specified).</div>
  85. </dd>
  86. <dt class="field">
  87. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  88. <span class="var-title">$avatar_uuid</span>
  89. </dt>
  90. <dd class="index-item-body">
  91. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#var$avatar_uuid">SloodleLSLRequest::$avatar_uuid</a> in sl_iolib.php</div>
  92. <div class="index-item-description">String UUID of the SL user agent specified in the request (or NULL if not specified).</div>
  93. </dd>
  94. <dt class="field">
  95. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  96. <span class="method-title">add_data_line</span>
  97. </dt>
  98. <dd class="index-item-body">
  99. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodadd_data_line">SloodleLSLResponse::add_data_line()</a> in sl_iolib.php</div>
  100. <div class="index-item-description">Adds one line of data to the $data member</div>
  101. </dd>
  102. <dt class="field">
  103. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  104. <span class="method-title">add_side_effect</span>
  105. </dt>
  106. <dd class="index-item-body">
  107. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodadd_side_effect">SloodleLSLResponse::add_side_effect()</a> in sl_iolib.php</div>
  108. <div class="index-item-description">Adds a single side effect code to member $status_code</div>
  109. </dd>
  110. <dt class="field">
  111. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  112. <span class="method-title">add_side_effects</span>
  113. </dt>
  114. <dd class="index-item-body">
  115. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodadd_side_effects">SloodleLSLResponse::add_side_effects()</a> in sl_iolib.php</div>
  116. <div class="index-item-description">Adds one or more integer side effect codes to member $status_code.</div>
  117. </dd>
  118. <dt class="field">
  119. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  120. <span class="method-title">authenticate_request</span>
  121. </dt>
  122. <dd class="index-item-body">
  123. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodauthenticate_request">SloodleLSLRequest::authenticate_request()</a> in sl_iolib.php</div>
  124. <div class="index-item-description">Authenticates the request against the site using the password parameter.</div>
  125. </dd>
  126. </dl>
  127. <a name="c"></a>
  128. <div class="index-letter-section">
  129. <div style="float: left" class="index-letter-title">c</div>
  130. <div style="float: right"><a href="#top">top</a></div>
  131. <div style="clear: both"></div>
  132. </div>
  133. <dl>
  134. <dt class="field">
  135. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  136. <span class="var-title">$course_id</span>
  137. </dt>
  138. <dd class="index-item-body">
  139. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#var$course_id">SloodleLSLRequest::$course_id</a> in sl_iolib.php</div>
  140. <div class="index-item-description">Integer ID of the course specified in the request (or NULL if not specified).</div>
  141. </dd>
  142. <dt class="field">
  143. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  144. <span class="method-title">clear_data</span>
  145. </dt>
  146. <dd class="index-item-body">
  147. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodclear_data">SloodleLSLResponse::clear_data()</a> in sl_iolib.php</div>
  148. <div class="index-item-description">Clears all data from member $data</div>
  149. </dd>
  150. <dt class="field">
  151. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  152. <span class="include-title">config.php</span>
  153. </dt>
  154. <dd class="index-item-body">
  155. <div class="index-item-details"><a href="sloodle/_config.php.html">config.php</a> in config.php</div>
  156. </dd>
  157. <dt class="field">
  158. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  159. <span class="method-title">confirm_by_login_security_token</span>
  160. </dt>
  161. <dd class="index-item-body">
  162. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#methodconfirm_by_login_security_token">SloodleLSLHandler::confirm_by_login_security_token()</a> in sl_lsllib.php</div>
  163. <div class="index-item-description">Authenticates the avatar identified in the request by the login security token.</div>
  164. </dd>
  165. <dt class="field">
  166. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  167. <span class="method-title">create_moodle_user</span>
  168. </dt>
  169. <dd class="index-item-body">
  170. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodcreate_moodle_user">SloodleUser::create_moodle_user()</a> in sl_userlib.php</div>
  171. <div class="index-item-description">Create a Moodle user account with the specified first name, last name and email address.</div>
  172. </dd>
  173. <dt class="field">
  174. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  175. <span class="method-title">create_sloodle_user</span>
  176. </dt>
  177. <dd class="index-item-body">
  178. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodcreate_sloodle_user">SloodleUser::create_sloodle_user()</a> in sl_userlib.php</div>
  179. <div class="index-item-description">Create a new Sloodle user.</div>
  180. </dd>
  181. </dl>
  182. <a name="d"></a>
  183. <div class="index-letter-section">
  184. <div style="float: left" class="index-letter-title">d</div>
  185. <div style="float: right"><a href="#top">top</a></div>
  186. <div style="clear: both"></div>
  187. </div>
  188. <dl>
  189. <dt class="field">
  190. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  191. <span class="var-title">$data</span>
  192. </dt>
  193. <dd class="index-item-body">
  194. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#var$data">SloodleLSLResponse::$data</a> in sl_iolib.php</div>
  195. <div class="index-item-description">Data to render following the status line in the response.</div>
  196. </dd>
  197. <dt class="field">
  198. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  199. <span class="method-title">delete_login_position</span>
  200. </dt>
  201. <dd class="index-item-body">
  202. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methoddelete_login_position">SloodleUser::delete_login_position()</a> in sl_userlib.php</div>
  203. <div class="index-item-description">Clears the login position from the currently selected Sloodle user.</div>
  204. </dd>
  205. <dt class="field">
  206. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  207. <span class="method-title">delete_sloodle_user</span>
  208. </dt>
  209. <dd class="index-item-body">
  210. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methoddelete_sloodle_user">SloodleUser::delete_sloodle_user()</a> in sl_userlib.php</div>
  211. <div class="index-item-description">Deletes the Sloodle user identified by {@link:$sloodle_user_id}.</div>
  212. </dd>
  213. </dl>
  214. <a name="e"></a>
  215. <div class="index-letter-section">
  216. <div style="float: left" class="index-letter-title">e</div>
  217. <div style="float: right"><a href="#top">top</a></div>
  218. <div style="clear: both"></div>
  219. </div>
  220. <dl>
  221. <dt class="field">
  222. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  223. <span class="var-title">$enrolled_courses_cache</span>
  224. </dt>
  225. <dd class="index-item-body">
  226. <div class="index-item-details"><a href="sloodle/SloodleUser.html#var$enrolled_courses_cache">SloodleUser::$enrolled_courses_cache</a> in sl_userlib.php</div>
  227. <div class="index-item-description">Cache of courses which the Moodle user is enrolled in Used by some functions fetching database data about a Moodle user's courses.</div>
  228. </dd>
  229. </dl>
  230. <a name="f"></a>
  231. <div class="index-letter-section">
  232. <div style="float: left" class="index-letter-title">f</div>
  233. <div style="float: right"><a href="#top">top</a></div>
  234. <div style="clear: both"></div>
  235. </div>
  236. <dl>
  237. <dt class="field">
  238. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  239. <span class="method-title">find_linked_moodle_user</span>
  240. </dt>
  241. <dd class="index-item-body">
  242. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodfind_linked_moodle_user">SloodleUser::find_linked_moodle_user()</a> in sl_userlib.php</div>
  243. <div class="index-item-description">Find the Moodle user linked to the current Sloodle user.</div>
  244. </dd>
  245. <dt class="field">
  246. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  247. <span class="method-title">find_linked_sloodle_user</span>
  248. </dt>
  249. <dd class="index-item-body">
  250. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodfind_linked_sloodle_user">SloodleUser::find_linked_sloodle_user()</a> in sl_userlib.php</div>
  251. <div class="index-item-description">Find the Sloodle user linked to the current Moodle user.</div>
  252. </dd>
  253. <dt class="field">
  254. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  255. <span class="method-title">find_sloodle_user</span>
  256. </dt>
  257. <dd class="index-item-body">
  258. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodfind_sloodle_user">SloodleUser::find_sloodle_user()</a> in sl_userlib.php</div>
  259. <div class="index-item-description">Attempts to find a Sloodle user by their UUID and/or avatar nam.</div>
  260. </dd>
  261. <dt class="field">
  262. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  263. <span class="method-title">find_sloodle_user_by_login_position</span>
  264. </dt>
  265. <dd class="index-item-body">
  266. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodfind_sloodle_user_by_login_position">SloodleUser::find_sloodle_user_by_login_position()</a> in sl_userlib.php</div>
  267. <div class="index-item-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.</div>
  268. </dd>
  269. </dl>
  270. <a name="g"></a>
  271. <div class="index-letter-section">
  272. <div style="float: left" class="index-letter-title">g</div>
  273. <div style="float: right"><a href="#top">top</a></div>
  274. <div style="clear: both"></div>
  275. </div>
  276. <dl>
  277. <dt class="field">
  278. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  279. <span class="method-title">generate_login_position</span>
  280. </dt>
  281. <dd class="index-item-body">
  282. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodgenerate_login_position">SloodleUser::generate_login_position()</a> in sl_userlib.php</div>
  283. <div class="index-item-description">Generates a new login position for the current Sloodle user.</div>
  284. </dd>
  285. <dt class="field">
  286. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  287. <span class="method-title">get_auth_status</span>
  288. </dt>
  289. <dd class="index-item-body">
  290. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodget_auth_status">SloodleLSLRequest::get_auth_status()</a> in sl_iolib.php</div>
  291. <div class="index-item-description">Returns member variable $auth_status.</div>
  292. </dd>
  293. <dt class="field">
  294. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  295. <span class="method-title">get_avatar_name</span>
  296. </dt>
  297. <dd class="index-item-body">
  298. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodget_avatar_name">SloodleLSLRequest::get_avatar_name()</a> in sl_iolib.php</div>
  299. <div class="index-item-description">Returns member value $avatar_name.</div>
  300. </dd>
  301. <dt class="field">
  302. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  303. <span class="method-title">get_avatar_uuid</span>
  304. </dt>
  305. <dd class="index-item-body">
  306. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodget_avatar_uuid">SloodleLSLRequest::get_avatar_uuid()</a> in sl_iolib.php</div>
  307. <div class="index-item-description">Returns member value $avatar_uuid.</div>
  308. </dd>
  309. <dt class="field">
  310. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  311. <span class="method-title">get_course_id</span>
  312. </dt>
  313. <dd class="index-item-body">
  314. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodget_course_id">SloodleLSLRequest::get_course_id()</a> in sl_iolib.php</div>
  315. <div class="index-item-description">Returns member value $course_id.</div>
  316. </dd>
  317. <dt class="field">
  318. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  319. <span class="method-title">get_course_module_instance</span>
  320. </dt>
  321. <dd class="index-item-body">
  322. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodget_course_module_instance">SloodleLSLRequest::get_course_module_instance()</a> in sl_iolib.php</div>
  323. <div class="index-item-description">Get a course module instance for the module specified in the request Uses the ID specified in $module_id.</div>
  324. </dd>
  325. <dt class="field">
  326. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  327. <span class="method-title">get_course_record</span>
  328. </dt>
  329. <dd class="index-item-body">
  330. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodget_course_record">SloodleLSLRequest::get_course_record()</a> in sl_iolib.php</div>
  331. <div class="index-item-description">Gets a database record for the course identified in the request.</div>
  332. </dd>
  333. <dt class="field">
  334. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  335. <span class="method-title">get_login_security_token</span>
  336. </dt>
  337. <dd class="index-item-body">
  338. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodget_login_security_token">SloodleLSLRequest::get_login_security_token()</a> in sl_iolib.php</div>
  339. <div class="index-item-description">Returns member value $login_security_token.</div>
  340. </dd>
  341. <dt class="field">
  342. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  343. <span class="method-title">get_module_id</span>
  344. </dt>
  345. <dd class="index-item-body">
  346. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodget_module_id">SloodleLSLRequest::get_module_id()</a> in sl_iolib.php</div>
  347. <div class="index-item-description">Returns member value $module_id.</div>
  348. </dd>
  349. <dt class="field">
  350. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  351. <span class="method-title">get_moodle_user_id</span>
  352. </dt>
  353. <dd class="index-item-body">
  354. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodget_moodle_user_id">SloodleUser::get_moodle_user_id()</a> in sl_userlib.php</div>
  355. <div class="index-item-description">Accessor: gets the Moodle user ID member, {@link: $moodle_user_id}.</div>
  356. </dd>
  357. <dt class="field">
  358. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  359. <span class="method-title">get_password</span>
  360. </dt>
  361. <dd class="index-item-body">
  362. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodget_password">SloodleLSLRequest::get_password()</a> in sl_iolib.php</div>
  363. <div class="index-item-description">Returns member value $password.</div>
  364. </dd>
  365. <dt class="field">
  366. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  367. <span class="method-title">get_response</span>
  368. </dt>
  369. <dd class="index-item-body">
  370. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodget_response">SloodleLSLRequest::get_response()</a> in sl_iolib.php</div>
  371. <div class="index-item-description">Returns member value $response.</div>
  372. </dd>
  373. <dt class="field">
  374. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  375. <span class="method-title">get_sloodle_user_id</span>
  376. </dt>
  377. <dd class="index-item-body">
  378. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodget_sloodle_user_id">SloodleUser::get_sloodle_user_id()</a> in sl_userlib.php</div>
  379. <div class="index-item-description">Accessor: gets the Sloodle user ID member, {@link: $sloodle_user_id}.</div>
  380. </dd>
  381. <dt class="field">
  382. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  383. <span class="method-title">get_user</span>
  384. </dt>
  385. <dd class="index-item-body">
  386. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodget_user">SloodleLSLRequest::get_user()</a> in sl_iolib.php</div>
  387. <div class="index-item-description">Returns member value $user.</div>
  388. </dd>
  389. </dl>
  390. <a name="h"></a>
  391. <div class="index-letter-section">
  392. <div style="float: left" class="index-letter-title">h</div>
  393. <div style="float: right"><a href="#top">top</a></div>
  394. <div style="clear: both"></div>
  395. </div>
  396. <dl>
  397. <dt class="field">
  398. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  399. <span class="method-title">has_login_security_token</span>
  400. </dt>
  401. <dd class="index-item-body">
  402. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodhas_login_security_token">SloodleUser::has_login_security_token()</a> in sl_userlib.php</div>
  403. <div class="index-item-description">Checks if the current Sloodle user has a login security token</div>
  404. </dd>
  405. </dl>
  406. <a name="i"></a>
  407. <div class="index-letter-section">
  408. <div style="float: left" class="index-letter-title">i</div>
  409. <div style="float: right"><a href="#top">top</a></div>
  410. <div style="clear: both"></div>
  411. </div>
  412. <dl>
  413. <dt class="field">
  414. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  415. <span class="method-title">insert_sloodle_user_cache_to_db</span>
  416. </dt>
  417. <dd class="index-item-body">
  418. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodinsert_sloodle_user_cache_to_db">SloodleUser::insert_sloodle_user_cache_to_db()</a> in sl_userlib.php</div>
  419. <div class="index-item-description">Use the Sloodle user cache to insert a new entry in the Sloodle user database table.</div>
  420. </dd>
  421. <dt class="field">
  422. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  423. <span class="method-title">is_authenticated</span>
  424. </dt>
  425. <dd class="index-item-body">
  426. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodis_authenticated">SloodleLSLRequest::is_authenticated()</a> in sl_iolib.php</div>
  427. <div class="index-item-description">Indicates whether or not request authentication has succeeded.</div>
  428. </dd>
  429. <dt class="field">
  430. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  431. <span class="method-title">is_auth_failed</span>
  432. </dt>
  433. <dd class="index-item-body">
  434. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodis_auth_failed">SloodleLSLRequest::is_auth_failed()</a> in sl_iolib.php</div>
  435. <div class="index-item-description">Indicates whether or not request authentication has failed.</div>
  436. </dd>
  437. <dt class="field">
  438. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  439. <span class="method-title">is_request_data_processed</span>
  440. </dt>
  441. <dd class="index-item-body">
  442. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodis_request_data_processed">SloodleLSLRequest::is_request_data_processed()</a> in sl_iolib.php</div>
  443. <div class="index-item-description">Returns member variable $request_data_processed.</div>
  444. </dd>
  445. <dt class="field">
  446. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  447. <span class="method-title">is_user_enrolled_by_request</span>
  448. </dt>
  449. <dd class="index-item-body">
  450. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#methodis_user_enrolled_by_request">SloodleLSLHandler::is_user_enrolled_by_request()</a> in sl_lsllib.php</div>
  451. <div class="index-item-description">Checks that a user is enrolled in a course, based on request data.</div>
  452. </dd>
  453. <dt class="field">
  454. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  455. <span class="method-title">is_user_in_course</span>
  456. </dt>
  457. <dd class="index-item-body">
  458. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodis_user_in_course">SloodleUser::is_user_in_course()</a> in sl_userlib.php</div>
  459. <div class="index-item-description">Checks if the current Moodle user is already enrolled in the specified course.</div>
  460. </dd>
  461. </dl>
  462. <a name="l"></a>
  463. <div class="index-letter-section">
  464. <div style="float: left" class="index-letter-title">l</div>
  465. <div style="float: right"><a href="#top">top</a></div>
  466. <div style="clear: both"></div>
  467. </div>
  468. <dl>
  469. <dt class="field">
  470. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  471. <span class="var-title">$login_security_token</span>
  472. </dt>
  473. <dd class="index-item-body">
  474. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#var$login_security_token">SloodleLSLRequest::$login_security_token</a> in sl_iolib.php</div>
  475. <div class="index-item-description">String containing the login security token specified in the request (or NULL if not specified).</div>
  476. </dd>
  477. <dt class="field">
  478. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  479. <span class="var-title">$login_zone_pos</span>
  480. </dt>
  481. <dd class="index-item-body">
  482. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#var$login_zone_pos">SloodleLSLRequest::$login_zone_pos</a> in sl_iolib.php</div>
  483. <div class="index-item-description">A 3-element array containing the LoginZone position vector specified in HTTP request parameters (or NULL if not specified).</div>
  484. </dd>
  485. <dt class="field">
  486. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  487. <span class="include-title">lib.php</span>
  488. </dt>
  489. <dd class="index-item-body">
  490. <div class="index-item-details"><a href="sloodle/_lib.php.html">lib.php</a> in lib.php</div>
  491. </dd>
  492. <dt class="field">
  493. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  494. <span class="method-title">link_users</span>
  495. </dt>
  496. <dd class="index-item-body">
  497. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodlink_users">SloodleUser::link_users()</a> in sl_userlib.php</div>
  498. <div class="index-item-description">Links the current Sloodle and Moodle accounts together.</div>
  499. </dd>
  500. <dt class="field">
  501. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  502. <span class="method-title">login_by_request</span>
  503. </dt>
  504. <dd class="index-item-body">
  505. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#methodlogin_by_request">SloodleLSLHandler::login_by_request()</a> in sl_lsllib.php</div>
  506. <div class="index-item-description">Performs an internal 'login' based on user identified in request.</div>
  507. </dd>
  508. <dt class="field">
  509. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  510. <span class="method-title">login_moodle_user</span>
  511. </dt>
  512. <dd class="index-item-body">
  513. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodlogin_moodle_user">SloodleUser::login_moodle_user()</a> in sl_userlib.php</div>
  514. <div class="index-item-description">Performs an internal login of the current Moodle user.</div>
  515. </dd>
  516. </dl>
  517. <a name="m"></a>
  518. <div class="index-letter-section">
  519. <div style="float: left" class="index-letter-title">m</div>
  520. <div style="float: right"><a href="#top">top</a></div>
  521. <div style="clear: both"></div>
  522. </div>
  523. <dl>
  524. <dt class="field">
  525. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  526. <span class="var-title">$module_id</span>
  527. </dt>
  528. <dd class="index-item-body">
  529. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#var$module_id">SloodleLSLRequest::$module_id</a> in sl_iolib.php</div>
  530. <div class="index-item-description">Integer ID of the course module instance specified in the request (or NULL if not specified).</div>
  531. </dd>
  532. <dt class="field">
  533. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  534. <span class="var-title">$moodle_user_cache</span>
  535. </dt>
  536. <dd class="index-item-body">
  537. <div class="index-item-details"><a href="sloodle/SloodleUser.html#var$moodle_user_cache">SloodleUser::$moodle_user_cache</a> in sl_userlib.php</div>
  538. <div class="index-item-description">Moodle user data cache.</div>
  539. </dd>
  540. <dt class="field">
  541. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  542. <span class="var-title">$moodle_user_id</span>
  543. </dt>
  544. <dd class="index-item-body">
  545. <div class="index-item-details"><a href="sloodle/SloodleUser.html#var$moodle_user_id">SloodleUser::$moodle_user_id</a> in sl_userlib.php</div>
  546. <div class="index-item-description">Integer ID of a Moodle user entry in the database.</div>
  547. </dd>
  548. </dl>
  549. <a name="p"></a>
  550. <div class="index-letter-section">
  551. <div style="float: left" class="index-letter-title">p</div>
  552. <div style="float: right"><a href="#top">top</a></div>
  553. <div style="clear: both"></div>
  554. </div>
  555. <dl>
  556. <dt class="field">
  557. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  558. <span class="var-title">$page_number</span>
  559. </dt>
  560. <dd class="index-item-body">
  561. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#var$page_number">SloodleLSLResponse::$page_number</a> in sl_iolib.php</div>
  562. <div class="index-item-description">Current page number.</div>
  563. </dd>
  564. <dt class="field">
  565. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  566. <span class="var-title">$page_total</span>
  567. </dt>
  568. <dd class="index-item-body">
  569. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#var$page_total">SloodleLSLResponse::$page_total</a> in sl_iolib.php</div>
  570. <div class="index-item-description">Total number of pages.</div>
  571. </dd>
  572. <dt class="field">
  573. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  574. <span class="var-title">$password</span>
  575. </dt>
  576. <dd class="index-item-body">
  577. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#var$password">SloodleLSLRequest::$password</a> in sl_iolib.php</div>
  578. <div class="index-item-description">Contains the password specified in HTTP request parameters (or NULL if not specified).</div>
  579. </dd>
  580. <dt class="field">
  581. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  582. <span class="method-title">process_request_data</span>
  583. </dt>
  584. <dd class="index-item-body">
  585. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodprocess_request_data">SloodleLSLRequest::process_request_data()</a> in sl_iolib.php</div>
  586. <div class="index-item-description">Process all of the standard data provided by the HTTP request.</div>
  587. </dd>
  588. </dl>
  589. <a name="q"></a>
  590. <div class="index-letter-section">
  591. <div style="float: left" class="index-letter-title">q</div>
  592. <div style="float: right"><a href="#top">top</a></div>
  593. <div style="clear: both"></div>
  594. </div>
  595. <dl>
  596. <dt class="field">
  597. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  598. <span class="method-title">quick_output</span>
  599. </dt>
  600. <dd class="index-item-body">
  601. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodquick_output">SloodleLSLResponse::quick_output()</a> in sl_iolib.php</div>
  602. <div class="index-item-description">Quick output of data to avoid several accessor calls if the response is very basic.</div>
  603. </dd>
  604. </dl>
  605. <a name="r"></a>
  606. <div class="index-letter-section">
  607. <div style="float: left" class="index-letter-title">r</div>
  608. <div style="float: right"><a href="#top">top</a></div>
  609. <div style="clear: both"></div>
  610. </div>
  611. <dl>
  612. <dt class="field">
  613. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  614. <span class="var-title">$request</span>
  615. </dt>
  616. <dd class="index-item-body">
  617. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#var$request">SloodleLSLHandler::$request</a> in sl_lsllib.php</div>
  618. <div class="index-item-description">A Sloodle request handling object.</div>
  619. </dd>
  620. <dt class="field">
  621. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  622. <span class="var-title">$request_data_processed</span>
  623. </dt>
  624. <dd class="index-item-body">
  625. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#var$request_data_processed">SloodleLSLRequest::$request_data_processed</a> in sl_iolib.php</div>
  626. <div class="index-item-description">Indicates whether or not the request data has been processed by the process_request_data() function.</div>
  627. </dd>
  628. <dt class="field">
  629. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  630. <span class="var-title">$request_descriptor</span>
  631. </dt>
  632. <dd class="index-item-body">
  633. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#var$request_descriptor">SloodleLSLResponse::$request_descriptor</a> in sl_iolib.php</div>
  634. <div class="index-item-description">Request descriptor.</div>
  635. </dd>
  636. <dt class="field">
  637. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  638. <span class="var-title">$request_timestamp</span>
  639. </dt>
  640. <dd class="index-item-body">
  641. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#var$request_timestamp">SloodleLSLResponse::$request_timestamp</a> in sl_iolib.php</div>
  642. <div class="index-item-description">Timestamp when the request was originally made by the LSL script.</div>
  643. </dd>
  644. <dt class="field">
  645. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  646. <span class="var-title">$response</span>
  647. </dt>
  648. <dd class="index-item-body">
  649. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#var$response">SloodleLSLHandler::$response</a> in sl_lsllib.php</div>
  650. <div class="index-item-description">A Sloodle response handling object.</div>
  651. </dd>
  652. <dt class="field">
  653. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  654. <span class="var-title">$response</span>
  655. </dt>
  656. <dd class="index-item-body">
  657. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#var$response">SloodleLSLRequest::$response</a> in sl_iolib.php</div>
  658. <div class="index-item-description">The object used to output response data.</div>
  659. </dd>
  660. <dt class="field">
  661. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  662. <span class="var-title">$response_timestamp</span>
  663. </dt>
  664. <dd class="index-item-body">
  665. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#var$response_timestamp">SloodleLSLResponse::$response_timestamp</a> in sl_iolib.php</div>
  666. <div class="index-item-description">Timestamp when the response was generated on the Moodle site.</div>
  667. </dd>
  668. <dt class="field">
  669. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  670. <span class="method-title">regenerate_login_security_token</span>
  671. </dt>
  672. <dd class="index-item-body">
  673. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodregenerate_login_security_token">SloodleUser::regenerate_login_security_token()</a> in sl_userlib.php</div>
  674. <div class="index-item-description">Generates a new login security token for the current Sloodle user</div>
  675. </dd>
  676. <dt class="field">
  677. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  678. <span class="method-title">render_to_output</span>
  679. </dt>
  680. <dd class="index-item-body">
  681. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodrender_to_output">SloodleLSLResponse::render_to_output()</a> in sl_iolib.php</div>
  682. <div class="index-item-description">Outputs the response directly to the HTTP response.</div>
  683. </dd>
  684. <dt class="field">
  685. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  686. <span class="method-title">render_to_string</span>
  687. </dt>
  688. <dd class="index-item-body">
  689. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodrender_to_string">SloodleLSLResponse::render_to_string()</a> in sl_iolib.php</div>
  690. <div class="index-item-description">Renders the response to a string.</div>
  691. </dd>
  692. <dt class="field">
  693. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  694. <span class="method-title">required_param</span>
  695. </dt>
  696. <dd class="index-item-body">
  697. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodrequired_param">SloodleLSLRequest::required_param()</a> in sl_iolib.php</div>
  698. <div class="index-item-description">Obtains a named HTTP request parameter, and terminate with an error message if it has not been provided.</div>
  699. </dd>
  700. </dl>
  701. <a name="s"></a>
  702. <div class="index-letter-section">
  703. <div style="float: left" class="index-letter-title">s</div>
  704. <div style="float: right"><a href="#top">top</a></div>
  705. <div style="clear: both"></div>
  706. </div>
  707. <dl>
  708. <dt class="field">
  709. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  710. <span class="var-title">$side_effects</span>
  711. </dt>
  712. <dd class="index-item-body">
  713. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#var$side_effects">SloodleLSLResponse::$side_effects</a> in sl_iolib.php</div>
  714. <div class="index-item-description">Integer side effect(s) codes.</div>
  715. </dd>
  716. <dt class="field">
  717. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  718. <span class="var-title">$sloodle_user_cache</span>
  719. </dt>
  720. <dd class="index-item-body">
  721. <div class="index-item-details"><a href="sloodle/SloodleUser.html#var$sloodle_user_cache">SloodleUser::$sloodle_user_cache</a> in sl_userlib.php</div>
  722. <div class="index-item-description">Sloodle user data cache.</div>
  723. </dd>
  724. <dt class="field">
  725. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  726. <span class="var-title">$sloodle_user_id</span>
  727. </dt>
  728. <dd class="index-item-body">
  729. <div class="index-item-details"><a href="sloodle/SloodleUser.html#var$sloodle_user_id">SloodleUser::$sloodle_user_id</a> in sl_userlib.php</div>
  730. <div class="index-item-description">Integer ID of a Sloodle user entry in the database.</div>
  731. </dd>
  732. <dt class="field">
  733. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  734. <span class="var-title">$status_code</span>
  735. </dt>
  736. <dd class="index-item-body">
  737. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#var$status_code">SloodleLSLResponse::$status_code</a> in sl_iolib.php</div>
  738. <div class="index-item-description">Integer status code of the response.</div>
  739. </dd>
  740. <dt class="field">
  741. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  742. <span class="var-title">$status_descriptor</span>
  743. </dt>
  744. <dd class="index-item-body">
  745. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#var$status_descriptor">SloodleLSLResponse::$status_descriptor</a> in sl_iolib.php</div>
  746. <div class="index-item-description">Status descriptor string.</div>
  747. </dd>
  748. <dt class="field">
  749. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  750. <span class="include-title">sl_classroomlib.php</span>
  751. </dt>
  752. <dd class="index-item-body">
  753. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html">sl_classroomlib.php</a> in sl_classroomlib.php</div>
  754. </dd>
  755. <dt class="field">
  756. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  757. <span class="include-title">sl_generallib.php</span>
  758. </dt>
  759. <dd class="index-item-body">
  760. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html">sl_generallib.php</a> in sl_generallib.php</div>
  761. </dd>
  762. <dt class="field">
  763. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  764. <span class="include-title">sl_iolib.php</span>
  765. </dt>
  766. <dd class="index-item-body">
  767. <div class="index-item-details"><a href="sloodle/_lib---sl_iolib.php.html">sl_iolib.php</a> in sl_iolib.php</div>
  768. </dd>
  769. <dt class="field">
  770. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  771. <span class="include-title">sl_lsllib.php</span>
  772. </dt>
  773. <dd class="index-item-body">
  774. <div class="index-item-details"><a href="sloodle/_lib---sl_lsllib.php.html">sl_lsllib.php</a> in sl_lsllib.php</div>
  775. </dd>
  776. <dt class="field">
  777. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  778. <span class="include-title">sl_userlib.php</span>
  779. </dt>
  780. <dd class="index-item-body">
  781. <div class="index-item-details"><a href="sloodle/_lib---sl_userlib.php.html">sl_userlib.php</a> in sl_userlib.php</div>
  782. </dd>
  783. <dt class="field">
  784. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  785. <span class="include-title">sl_avilister_linker.php</span>
  786. </dt>
  787. <dd class="index-item-body">
  788. <div class="index-item-details"><a href="sloodle/_mod---avilister---sl_avilister_linker.php.html">sl_avilister_linker.php</a> in sl_avilister_linker.php</div>
  789. </dd>
  790. <dt class="field">
  791. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  792. <span class="method-title">set_data</span>
  793. </dt>
  794. <dd class="index-item-body">
  795. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodset_data">SloodleLSLResponse::set_data()</a> in sl_iolib.php</div>
  796. <div class="index-item-description">Accessor function to set member value $data. <strong>Note: it is recommended that you use the add_data_line() and clear_data() functions instead of this.</strong></div>
  797. </dd>
  798. <dt class="field">
  799. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  800. <span class="method-title">set_moodle_user_id</span>
  801. </dt>
  802. <dd class="index-item-body">
  803. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodset_moodle_user_id">SloodleUser::set_moodle_user_id()</a> in sl_userlib.php</div>
  804. <div class="index-item-description">Accessor: sets the Moodle user ID member, {@link: $moodle_user_id}.</div>
  805. </dd>
  806. <dt class="field">
  807. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  808. <span class="method-title">set_page_number</span>
  809. </dt>
  810. <dd class="index-item-body">
  811. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodset_page_number">SloodleLSLResponse::set_page_number()</a> in sl_iolib.php</div>
  812. <div class="index-item-description">Accessor function to set member value $page_number</div>
  813. </dd>
  814. <dt class="field">
  815. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  816. <span class="method-title">set_page_total</span>
  817. </dt>
  818. <dd class="index-item-body">
  819. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodset_page_total">SloodleLSLResponse::set_page_total()</a> in sl_iolib.php</div>
  820. <div class="index-item-description">Accessor function to set member value $page_total</div>
  821. </dd>
  822. <dt class="field">
  823. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  824. <span class="method-title">set_request_descriptor</span>
  825. </dt>
  826. <dd class="index-item-body">
  827. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodset_request_descriptor">SloodleLSLResponse::set_request_descriptor()</a> in sl_iolib.php</div>
  828. <div class="index-item-description">Accessor function to set member value $request_descriptor</div>
  829. </dd>
  830. <dt class="field">
  831. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  832. <span class="method-title">set_request_timestamp</span>
  833. </dt>
  834. <dd class="index-item-body">
  835. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodset_request_timestamp">SloodleLSLResponse::set_request_timestamp()</a> in sl_iolib.php</div>
  836. <div class="index-item-description">Accessor function to set member value $request_timestamp</div>
  837. </dd>
  838. <dt class="field">
  839. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  840. <span class="method-title">set_response</span>
  841. </dt>
  842. <dd class="index-item-body">
  843. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodset_response">SloodleLSLRequest::set_response()</a> in sl_iolib.php</div>
  844. <div class="index-item-description">Sets the <a href="sloodle/SloodleLSLRequest.html#var$response">SloodleLSLRequest::$response</a> member.</div>
  845. </dd>
  846. <dt class="field">
  847. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  848. <span class="method-title">set_response_timestamp</span>
  849. </dt>
  850. <dd class="index-item-body">
  851. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodset_response_timestamp">SloodleLSLResponse::set_response_timestamp()</a> in sl_iolib.php</div>
  852. <div class="index-item-description">Accessor function to set member value $response_timestamp</div>
  853. </dd>
  854. <dt class="field">
  855. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  856. <span class="method-title">set_side_effects</span>
  857. </dt>
  858. <dd class="index-item-body">
  859. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodset_side_effects">SloodleLSLResponse::set_side_effects()</a> in sl_iolib.php</div>
  860. <div class="index-item-description">Accessor function to set member value $side_effects. <strong>Note:</strong> it is recommended that you use add_side_effect() or add_side_effects() instead.</div>
  861. </dd>
  862. <dt class="field">
  863. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  864. <span class="method-title">set_sloodle_user_id</span>
  865. </dt>
  866. <dd class="index-item-body">
  867. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodset_sloodle_user_id">SloodleUser::set_sloodle_user_id()</a> in sl_userlib.php</div>
  868. <div class="index-item-description">Accessor: sets the Sloodle user ID member, {@link: $sloodle_user_id}.</div>
  869. </dd>
  870. <dt class="field">
  871. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  872. <span class="method-title">set_status_code</span>
  873. </dt>
  874. <dd class="index-item-body">
  875. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodset_status_code">SloodleLSLResponse::set_status_code()</a> in sl_iolib.php</div>
  876. <div class="index-item-description">Accessor function to set member value $status_code</div>
  877. </dd>
  878. <dt class="field">
  879. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  880. <span class="method-title">set_status_descriptor</span>
  881. </dt>
  882. <dd class="index-item-body">
  883. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodset_status_descriptor">SloodleLSLResponse::set_status_descriptor()</a> in sl_iolib.php</div>
  884. <div class="index-item-description">Accessor function to set member value $status_descriptor</div>
  885. </dd>
  886. <dt class="field">
  887. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  888. <span class="method-title">set_tracking_code</span>
  889. </dt>
  890. <dd class="index-item-body">
  891. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodset_tracking_code">SloodleLSLResponse::set_tracking_code()</a> in sl_iolib.php</div>
  892. <div class="index-item-description">Accessor function to set member value $tracking_code</div>
  893. </dd>
  894. <dt class="field">
  895. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  896. <span class="method-title">set_user</span>
  897. </dt>
  898. <dd class="index-item-body">
  899. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodset_user">SloodleLSLRequest::set_user()</a> in sl_iolib.php</div>
  900. <div class="index-item-description">Sets the <a href="sloodle/SloodleLSLRequest.html#var$user">SloodleLSLRequest::$user</a> member.</div>
  901. </dd>
  902. <dt class="field">
  903. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  904. <span class="method-title">set_user_key</span>
  905. </dt>
  906. <dd class="index-item-body">
  907. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodset_user_key">SloodleLSLResponse::set_user_key()</a> in sl_iolib.php</div>
  908. <div class="index-item-description">Accessor function to set member value $user_key</div>
  909. </dd>
  910. <dt class="field">
  911. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  912. SloodleLSLHandler
  913. </dt>
  914. <dd class="index-item-body">
  915. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html">SloodleLSLHandler</a> in sl_lsllib.php</div>
  916. <div class="index-item-description">A helper class to automate many API features.</div>
  917. </dd>
  918. <dt class="field">
  919. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  920. <span class="method-title">SloodleLSLHandler</span>
  921. </dt>
  922. <dd class="index-item-body">
  923. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#methodSloodleLSLHandler">SloodleLSLHandler::SloodleLSLHandler()</a> in sl_lsllib.php</div>
  924. <div class="index-item-description">Class constructor.</div>
  925. </dd>
  926. <dt class="field">
  927. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  928. SloodleLSLRequest
  929. </dt>
  930. <dd class="index-item-body">
  931. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html">SloodleLSLRequest</a> in sl_iolib.php</div>
  932. <div class="index-item-description">Handles incoming HTTP requests, typically from LSL scripts.</div>
  933. </dd>
  934. <dt class="field">
  935. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  936. <span class="method-title">SloodleLSLRequest</span>
  937. </dt>
  938. <dd class="index-item-body">
  939. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#methodSloodleLSLRequest">SloodleLSLRequest::SloodleLSLRequest()</a> in sl_iolib.php</div>
  940. <div class="index-item-description"><em>Constructor</em><ul><li>initialises the user and response objects.</li></ul></div>
  941. </dd>
  942. <dt class="field">
  943. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  944. SloodleLSLResponse
  945. </dt>
  946. <dd class="index-item-body">
  947. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html">SloodleLSLResponse</a> in sl_iolib.php</div>
  948. <div class="index-item-description">A helper class to validate and structure data for output according to the <a href="http://slisweb.sjsu.edu/sl/index.php/Sloodle_communications_specification">Sloodle communications specification</a>.</div>
  949. </dd>
  950. <dt class="field">
  951. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  952. <span class="method-title">SloodleLSLResponse</span>
  953. </dt>
  954. <dd class="index-item-body">
  955. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#methodSloodleLSLResponse">SloodleLSLResponse::SloodleLSLResponse()</a> in sl_iolib.php</div>
  956. <div class="index-item-description"><em>Constructor</em><ul><li>can intialise some variables</li></ul></div>
  957. </dd>
  958. <dt class="field">
  959. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  960. SloodleUser
  961. </dt>
  962. <dd class="index-item-body">
  963. <div class="index-item-details"><a href="sloodle/SloodleUser.html">SloodleUser</a> in sl_userlib.php</div>
  964. <div class="index-item-description">A class to represent a single user, including Moodle and Sloodle data.</div>
  965. </dd>
  966. <dt class="field">
  967. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  968. <span class="method-title">SloodleUser</span>
  969. </dt>
  970. <dd class="index-item-body">
  971. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodSloodleUser">SloodleUser::SloodleUser()</a> in sl_userlib.php</div>
  972. <div class="index-item-description">Class constructor.</div>
  973. </dd>
  974. <dt class="field">
  975. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  976. <span class="method-title">sloodle_add_classroom_profile</span>
  977. </dt>
  978. <dd class="index-item-body">
  979. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html#functionsloodle_add_classroom_profile">sloodle_add_classroom_profile()</a> in sl_classroomlib.php</div>
  980. </dd>
  981. <dt class="field">
  982. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  983. <span class="method-title">sloodle_add_classroom_profile_entry</span>
  984. </dt>
  985. <dd class="index-item-body">
  986. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html#functionsloodle_add_classroom_profile_entry">sloodle_add_classroom_profile_entry()</a> in sl_classroomlib.php</div>
  987. </dd>
  988. <dt class="field">
  989. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  990. <span class="method-title">sloodle_add_instance</span>
  991. </dt>
  992. <dd class="index-item-body">
  993. <div class="index-item-details"><a href="sloodle/_lib.php.html#functionsloodle_add_instance">sloodle_add_instance()</a> in lib.php</div>
  994. <div class="index-item-description">Given an object containing all the necessary data, (defined by the form in mod.html) this function will create a new instance and return the id number of the new instance.</div>
  995. </dd>
  996. <dt class="field">
  997. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  998. <span class="method-title">sloodle_add_to_log</span>
  999. </dt>
  1000. <dd class="index-item-body">
  1001. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_add_to_log">sloodle_add_to_log()</a> in sl_generallib.php</div>
  1002. <div class="index-item-description">Old logging function</div>
  1003. </dd>
  1004. <dt class="field">
  1005. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1006. <span class="method-title">sloodle_array_to_vector</span>
  1007. </dt>
  1008. <dd class="index-item-body">
  1009. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_array_to_vector">sloodle_array_to_vector()</a> in sl_generallib.php</div>
  1010. <div class="index-item-description">Converts an array vector to a string vector.</div>
  1011. </dd>
  1012. <dt class="field">
  1013. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1014. <span class="method-title">sloodle_authorize_object</span>
  1015. </dt>
  1016. <dd class="index-item-body">
  1017. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html#functionsloodle_authorize_object">sloodle_authorize_object()</a> in sl_classroomlib.php</div>
  1018. </dd>
  1019. <dt class="field">
  1020. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  1021. <span class="const-title">SLOODLE_AUTH_FAILED</span>
  1022. </dt>
  1023. <dd class="index-item-body">
  1024. <div class="index-item-details"><a href="sloodle/_lib---sl_iolib.php.html#defineSLOODLE_AUTH_FAILED">SLOODLE_AUTH_FAILED</a> in sl_iolib.php</div>
  1025. <div class="index-item-description">Used to indicate that authentication has failed.</div>
  1026. </dd>
  1027. <dt class="field">
  1028. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  1029. <span class="const-title">SLOODLE_AUTH_OK</span>
  1030. </dt>
  1031. <dd class="index-item-body">
  1032. <div class="index-item-details"><a href="sloodle/_lib---sl_iolib.php.html#defineSLOODLE_AUTH_OK">SLOODLE_AUTH_OK</a> in sl_iolib.php</div>
  1033. <div class="index-item-description">Used to indicate that authentication has been successful.</div>
  1034. </dd>
  1035. <dt class="field">
  1036. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  1037. <span class="const-title">SLOODLE_AUTH_UNKNOWN</span>
  1038. </dt>
  1039. <dd class="index-item-body">
  1040. <div class="index-item-details"><a href="sloodle/_lib---sl_iolib.php.html#defineSLOODLE_AUTH_UNKNOWN">SLOODLE_AUTH_UNKNOWN</a> in sl_iolib.php</div>
  1041. <div class="index-item-description">Used to indicate that authentication has not yet been attempted.</div>
  1042. </dd>
  1043. <dt class="field">
  1044. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1045. <span class="method-title">sloodle_check_course_module_instance_type</span>
  1046. </dt>
  1047. <dd class="index-item-body">
  1048. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_check_course_module_instance_type">sloodle_check_course_module_instance_type()</a> in sl_generallib.php</div>
  1049. <div class="index-item-description">Determines if the specified course module instance is of the named type.</div>
  1050. </dd>
  1051. <dt class="field">
  1052. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1053. <span class="method-title">sloodle_classroom_profile_exists_by_name</span>
  1054. </dt>
  1055. <dd class="index-item-body">
  1056. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html#functionsloodle_classroom_profile_exists_by_name">sloodle_classroom_profile_exists_by_name()</a> in sl_classroomlib.php</div>
  1057. </dd>
  1058. <dt class="field">
  1059. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1060. <span class="method-title">sloodle_cron</span>
  1061. </dt>
  1062. <dd class="index-item-body">
  1063. <div class="index-item-details"><a href="sloodle/_lib.php.html#functionsloodle_cron">sloodle_cron()</a> in lib.php</div>
  1064. <div class="index-item-description">Function to be run periodically according to the moodle cron This function searches for things that need to be done, such as sending out mail, toggling flags etc ...</div>
  1065. </dd>
  1066. <dt class="field">
  1067. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  1068. <span class="const-title">SLOODLE_DEBUG</span>
  1069. </dt>
  1070. <dd class="index-item-body">
  1071. <div class="index-item-details"><a href="sloodle/_sl_debug.php.html#defineSLOODLE_DEBUG">SLOODLE_DEBUG</a> in sl_debug.php</div>
  1072. </dd>
  1073. <dt class="field">
  1074. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  1075. <span class="const-title">SLOODLE_DEBUG_MODE_PARAM_NAME</span>
  1076. </dt>
  1077. <dd class="index-item-body">
  1078. <div class="index-item-details"><a href="sloodle/_sl_debug.php.html#defineSLOODLE_DEBUG_MODE_PARAM_NAME">SLOODLE_DEBUG_MODE_PARAM_NAME</a> in sl_debug.php</div>
  1079. </dd>
  1080. <dt class="field">
  1081. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1082. <span class="method-title">sloodle_debug_output</span>
  1083. </dt>
  1084. <dd class="index-item-body">
  1085. <div class="index-item-details"><a href="sloodle/_sl_debug.php.html#functionsloodle_debug_output">sloodle_debug_output()</a> in sl_debug.php</div>
  1086. </dd>
  1087. <dt class="field">
  1088. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1089. <span class="method-title">sloodle_delete_instance</span>
  1090. </dt>
  1091. <dd class="index-item-body">
  1092. <div class="index-item-details"><a href="sloodle/_lib.php.html#functionsloodle_delete_instance">sloodle_delete_instance()</a> in lib.php</div>
  1093. <div class="index-item-description">Given an ID of an instance of this module, this function will permanently delete the instance and any data that depends on it.</div>
  1094. </dd>
  1095. <dt class="field">
  1096. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  1097. <span class="const-title">SLOODLE_DIRROOT</span>
  1098. </dt>
  1099. <dd class="index-item-body">
  1100. <div class="index-item-details"><a href="sloodle/_config.php.html#defineSLOODLE_DIRROOT">SLOODLE_DIRROOT</a> in config.php</div>
  1101. </dd>
  1102. <dt class="field">
  1103. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  1104. <span class="const-title">SLOODLE_FIELD_SEPARATOR</span>
  1105. </dt>
  1106. <dd class="index-item-body">
  1107. <div class="index-item-details"><a href="sloodle/_lib---sl_iolib.php.html#defineSLOODLE_FIELD_SEPARATOR">SLOODLE_FIELD_SEPARATOR</a> in sl_iolib.php</div>
  1108. <div class="index-item-description">Defines what character(s) will be used to separate individual fields in the Sloodle communications specification.</div>
  1109. </dd>
  1110. <dt class="field">
  1111. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1112. <span class="method-title">sloodle_finished_login_coordinates</span>
  1113. </dt>
  1114. <dd class="index-item-body">
  1115. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_finished_login_coordinates">sloodle_finished_login_coordinates()</a> in sl_generallib.php</div>
  1116. <div class="index-item-description">Generates teleport coordinates for a user who has already finished the LoginZone process.</div>
  1117. </dd>
  1118. <dt class="field">
  1119. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1120. <span class="method-title">sloodle_get_auth_method</span>
  1121. </dt>
  1122. <dd class="index-item-body">
  1123. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_get_auth_method">sloodle_get_auth_method()</a> in sl_generallib.php</div>
  1124. <div class="index-item-description">Gets the site-wide authentication from the configuration table.</div>
  1125. </dd>
  1126. <dt class="field">
  1127. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1128. <span class="method-title">sloodle_get_classroom_profile</span>
  1129. </dt>
  1130. <dd class="index-item-body">
  1131. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html#functionsloodle_get_classroom_profile">sloodle_get_classroom_profile()</a> in sl_classroomlib.php</div>
  1132. </dd>
  1133. <dt class="field">
  1134. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1135. <span class="method-title">sloodle_get_classroom_profiles</span>
  1136. </dt>
  1137. <dd class="index-item-body">
  1138. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html#functionsloodle_get_classroom_profiles">sloodle_get_classroom_profiles()</a> in sl_classroomlib.php</div>
  1139. </dd>
  1140. <dt class="field">
  1141. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1142. <span class="method-title">sloodle_get_classroom_profile_by_name</span>
  1143. </dt>
  1144. <dd class="index-item-body">
  1145. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html#functionsloodle_get_classroom_profile_by_name">sloodle_get_classroom_profile_by_name()</a> in sl_classroomlib.php</div>
  1146. </dd>
  1147. <dt class="field">
  1148. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1149. <span class="method-title">sloodle_get_classroom_profile_entries</span>
  1150. </dt>
  1151. <dd class="index-item-body">
  1152. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html#functionsloodle_get_classroom_profile_entries">sloodle_get_classroom_profile_entries()</a> in sl_classroomlib.php</div>
  1153. </dd>
  1154. <dt class="field">
  1155. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1156. <span class="method-title">sloodle_get_config</span>
  1157. </dt>
  1158. <dd class="index-item-body">
  1159. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_get_config">sloodle_get_config()</a> in sl_generallib.php</div>
  1160. <div class="index-item-description">Gets a Sloodle configuration value from Moodle's &quot;config&quot; table.</div>
  1161. </dd>
  1162. <dt class="field">
  1163. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1164. <span class="method-title">sloodle_get_course_module_instance</span>
  1165. </dt>
  1166. <dd class="index-item-body">
  1167. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_get_course_module_instance">sloodle_get_course_module_instance()</a> in sl_generallib.php</div>
  1168. <div class="index-item-description">Obtains the identified course module instance database record.</div>
  1169. </dd>
  1170. <dt class="field">
  1171. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1172. <span class="method-title">sloodle_get_distribution_list</span>
  1173. </dt>
  1174. <dd class="index-item-body">
  1175. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_get_distribution_list">sloodle_get_distribution_list()</a> in sl_generallib.php</div>
  1176. <div class="index-item-description">Gets an array of the names of all objects in the Object Distributor.</div>
  1177. </dd>
  1178. <dt class="field">
  1179. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1180. <span class="method-title">sloodle_get_loginzone_pos</span>
  1181. </dt>
  1182. <dd class="index-item-body">
  1183. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_get_loginzone_pos">sloodle_get_loginzone_pos()</a> in sl_generallib.php</div>
  1184. <div class="index-item-description">Gets the position of the site-wide LoginZone object.</div>
  1185. </dd>
  1186. <dt class="field">
  1187. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1188. <span class="method-title">sloodle_get_loginzone_region</span>
  1189. </dt>
  1190. <dd class="index-item-body">
  1191. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_get_loginzone_region">sloodle_get_loginzone_region()</a> in sl_generallib.php</div>
  1192. <div class="index-item-description">Gets the name of the region where the site-wide LoginZone object was most recently rezzed.</div>
  1193. </dd>
  1194. <dt class="field">
  1195. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1196. <span class="method-title">sloodle_get_loginzone_size</span>
  1197. </dt>
  1198. <dd class="index-item-body">
  1199. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_get_loginzone_size">sloodle_get_loginzone_size()</a> in sl_generallib.php</div>
  1200. <div class="index-item-description">Gets the size of the site-wide LoginZone object.</div>
  1201. </dd>
  1202. <dt class="field">
  1203. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1204. <span class="method-title">sloodle_get_module_id</span>
  1205. </dt>
  1206. <dd class="index-item-body">
  1207. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_get_module_id">sloodle_get_module_id()</a> in sl_generallib.php</div>
  1208. <div class="index-item-description">Obtains the ID number of the specified module (type not instance).</div>
  1209. </dd>
  1210. <dt class="field">
  1211. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1212. <span class="method-title">sloodle_get_participants</span>
  1213. </dt>
  1214. <dd class="index-item-body">
  1215. <div class="index-item-details"><a href="sloodle/_lib.php.html#functionsloodle_get_participants">sloodle_get_participants()</a> in lib.php</div>
  1216. <div class="index-item-description">Must return an array of user records (all data) who are participants for a given instance of sloodle. Must include every user involved in the instance, independient of his role (student, teacher, admin...) See other modules as example.</div>
  1217. </dd>
  1218. <dt class="field">
  1219. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1220. <span class="method-title">sloodle_get_prim_password</span>
  1221. </dt>
  1222. <dd class="index-item-body">
  1223. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_get_prim_password">sloodle_get_prim_password()</a> in sl_generallib.php</div>
  1224. <div class="index-item-description">Gets the site-wide Sloodle prim password from the configuration table.</div>
  1225. </dd>
  1226. <dt class="field">
  1227. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1228. <span class="method-title">sloodle_grades</span>
  1229. </dt>
  1230. <dd class="index-item-body">
  1231. <div class="index-item-details"><a href="sloodle/_lib.php.html#functionsloodle_grades">sloodle_grades()</a> in lib.php</div>
  1232. <div class="index-item-description">Must return an array of grades for a given instance of this module, indexed by user. It also returns a maximum allowed grade.</div>
  1233. </dd>
  1234. <dt class="field">
  1235. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1236. <span class="method-title">sloodle_is_automatic_registration_on</span>
  1237. </dt>
  1238. <dd class="index-item-body">
  1239. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_is_automatic_registration_on">sloodle_is_automatic_registration_on()</a> in sl_generallib.php</div>
  1240. <div class="index-item-description">Determines whether or not automatic registration is enabled.</div>
  1241. </dd>
  1242. <dt class="field">
  1243. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1244. <span class="method-title">sloodle_is_course_module_instance_visible</span>
  1245. </dt>
  1246. <dd class="index-item-body">
  1247. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_is_course_module_instance_visible">sloodle_is_course_module_instance_visible()</a> in sl_generallib.php</div>
  1248. <div class="index-item-description">Determines whether or not the specified course module instance is visible.</div>
  1249. </dd>
  1250. <dt class="field">
  1251. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1252. <span class="method-title">sloodle_is_installed</span>
  1253. </dt>
  1254. <dd class="index-item-body">
  1255. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_is_installed">sloodle_is_installed()</a> in sl_generallib.php</div>
  1256. <div class="index-item-description">Determines whether or not Sloodle is installed.</div>
  1257. </dd>
  1258. <dt class="field">
  1259. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  1260. <span class="const-title">SLOODLE_LINE_SEPARATOR</span>
  1261. </dt>
  1262. <dd class="index-item-body">
  1263. <div class="index-item-details"><a href="sloodle/_lib---sl_iolib.php.html#defineSLOODLE_LINE_SEPARATOR">SLOODLE_LINE_SEPARATOR</a> in sl_iolib.php</div>
  1264. <div class="index-item-description">Defines what character(s) will be used to separate lines in the Sloodle communications specification.</div>
  1265. </dd>
  1266. <dt class="field">
  1267. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1268. <span class="method-title">sloodle_login_zone_coordinates</span>
  1269. </dt>
  1270. <dd class="index-item-body">
  1271. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_login_zone_coordinates">sloodle_login_zone_coordinates()</a> in sl_generallib.php</div>
  1272. <div class="index-item-description">Calculates the maximum and minimum bounds of the site-wide LoginZone.</div>
  1273. </dd>
  1274. <dt class="field">
  1275. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1276. <span class="method-title">sloodle_position_is_in_login_zone</span>
  1277. </dt>
  1278. <dd class="index-item-body">
  1279. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_position_is_in_login_zone">sloodle_position_is_in_login_zone()</a> in sl_generallib.php</div>
  1280. <div class="index-item-description">Checks if the specified position is in the current (site-wide) loginzone.</div>
  1281. </dd>
  1282. <dt class="field">
  1283. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1284. <span class="method-title">sloodle_prim_password</span>
  1285. </dt>
  1286. <dd class="index-item-body">
  1287. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_prim_password">sloodle_prim_password()</a> in sl_generallib.php</div>
  1288. <div class="index-item-description">Old form of the {@link: sloodle_set_prim_password()} function.</div>
  1289. </dd>
  1290. <dt class="field">
  1291. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1292. <span class="method-title">sloodle_print_config_notecard</span>
  1293. </dt>
  1294. <dd class="index-item-body">
  1295. <div class="index-item-details"><a href="sloodle/_sl_setup_notecard.php.html#functionsloodle_print_config_notecard">sloodle_print_config_notecard()</a> in sl_setup_notecard.php</div>
  1296. </dd>
  1297. <dt class="field">
  1298. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1299. <span class="method-title">sloodle_print_recent_activity</span>
  1300. </dt>
  1301. <dd class="index-item-body">
  1302. <div class="index-item-details"><a href="sloodle/_lib.php.html#functionsloodle_print_recent_activity">sloodle_print_recent_activity()</a> in lib.php</div>
  1303. <div class="index-item-description">Given a course and a time, this module should find recent activity that has occurred in sloodle activities and print it out.</div>
  1304. </dd>
  1305. <dt class="field">
  1306. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1307. <span class="method-title">sloodle_process_options</span>
  1308. </dt>
  1309. <dd class="index-item-body">
  1310. <div class="index-item-details"><a href="sloodle/_lib.php.html#functionsloodle_process_options">sloodle_process_options()</a> in lib.php</div>
  1311. </dd>
  1312. <dt class="field">
  1313. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1314. <span class="method-title">sloodle_random_object_pwd</span>
  1315. </dt>
  1316. <dd class="index-item-body">
  1317. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html#functionsloodle_random_object_pwd">sloodle_random_object_pwd()</a> in sl_classroomlib.php</div>
  1318. </dd>
  1319. <dt class="field">
  1320. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1321. <span class="method-title">sloodle_random_position_in_zone</span>
  1322. </dt>
  1323. <dd class="index-item-body">
  1324. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_random_position_in_zone">sloodle_random_position_in_zone()</a> in sl_generallib.php</div>
  1325. <div class="index-item-description">Generates a random position within the specified cubic zone.</div>
  1326. </dd>
  1327. <dt class="field">
  1328. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1329. <span class="method-title">sloodle_random_security_token</span>
  1330. </dt>
  1331. <dd class="index-item-body">
  1332. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_random_security_token">sloodle_random_security_token()</a> in sl_generallib.php</div>
  1333. <div class="index-item-description">Generates a random login security token.</div>
  1334. </dd>
  1335. <dt class="field">
  1336. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1337. <span class="method-title">sloodle_random_web_password</span>
  1338. </dt>
  1339. <dd class="index-item-body">
  1340. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_random_web_password">sloodle_random_web_password()</a> in sl_generallib.php</div>
  1341. <div class="index-item-description">Generates a random web password Uses mixed-case letters and numbers to generate a random 8-character string.</div>
  1342. </dd>
  1343. <dt class="field">
  1344. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1345. <span class="method-title">sloodle_register_object</span>
  1346. </dt>
  1347. <dd class="index-item-body">
  1348. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html#functionsloodle_register_object">sloodle_register_object()</a> in sl_classroomlib.php</div>
  1349. </dd>
  1350. <dt class="field">
  1351. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1352. <span class="method-title">sloodle_required_param</span>
  1353. </dt>
  1354. <dd class="index-item-body">
  1355. <div class="index-item-details"><a href="sloodle/_lib---sl_iolib.php.html#functionsloodle_required_param">sloodle_required_param()</a> in sl_iolib.php</div>
  1356. <div class="index-item-description">Obtains a named HTTP request parameter, and terminates script with an error message if it was not provided.</div>
  1357. </dd>
  1358. <dt class="field">
  1359. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1360. <span class="method-title">sloodle_round_vector</span>
  1361. </dt>
  1362. <dd class="index-item-body">
  1363. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_round_vector">sloodle_round_vector()</a> in sl_generallib.php</div>
  1364. <div class="index-item-description">Rounds the specified 3d vector integer values.</div>
  1365. </dd>
  1366. <dt class="field">
  1367. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1368. <span class="method-title">sloodle_save_classroom_profile</span>
  1369. </dt>
  1370. <dd class="index-item-body">
  1371. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html#functionsloodle_save_classroom_profile">sloodle_save_classroom_profile()</a> in sl_classroomlib.php</div>
  1372. </dd>
  1373. <dt class="field">
  1374. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1375. <span class="method-title">sloodle_save_classroom_profile_entries</span>
  1376. </dt>
  1377. <dd class="index-item-body">
  1378. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html#functionsloodle_save_classroom_profile_entries">sloodle_save_classroom_profile_entries()</a> in sl_classroomlib.php</div>
  1379. </dd>
  1380. <dt class="field">
  1381. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1382. <span class="method-title">sloodle_scale_used</span>
  1383. </dt>
  1384. <dd class="index-item-body">
  1385. <div class="index-item-details"><a href="sloodle/_lib.php.html#functionsloodle_scale_used">sloodle_scale_used()</a> in lib.php</div>
  1386. <div class="index-item-description">This function returns if a scale is being used by one sloodle it it has support for grading and scales. Commented code should be modified if necessary. See forum, glossary or journal modules as reference.</div>
  1387. </dd>
  1388. <dt class="field">
  1389. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1390. <span class="method-title">sloodle_send_xmlrpc_message</span>
  1391. </dt>
  1392. <dd class="index-item-body">
  1393. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_send_xmlrpc_message">sloodle_send_xmlrpc_message()</a> in sl_generallib.php</div>
  1394. <div class="index-item-description">Sends an XMLRPC message into Second Life.</div>
  1395. </dd>
  1396. <dt class="field">
  1397. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1398. <span class="method-title">sloodle_set_auth_method</span>
  1399. </dt>
  1400. <dd class="index-item-body">
  1401. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_set_auth_method">sloodle_set_auth_method()</a> in sl_generallib.php</div>
  1402. <div class="index-item-description">Sets the site-wide authentication method in the Moodle configuration table.</div>
  1403. </dd>
  1404. <dt class="field">
  1405. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1406. <span class="method-title">sloodle_set_config</span>
  1407. </dt>
  1408. <dd class="index-item-body">
  1409. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_set_config">sloodle_set_config()</a> in sl_generallib.php</div>
  1410. <div class="index-item-description">Sets a Sloodle configuration value.</div>
  1411. </dd>
  1412. <dt class="field">
  1413. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1414. <span class="method-title">sloodle_set_loginzone_pos</span>
  1415. </dt>
  1416. <dd class="index-item-body">
  1417. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_set_loginzone_pos">sloodle_set_loginzone_pos()</a> in sl_generallib.php</div>
  1418. <div class="index-item-description">Sets the position of the site-wide LoginZone object (stored in the Moodle configuration table).</div>
  1419. </dd>
  1420. <dt class="field">
  1421. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1422. <span class="method-title">sloodle_set_loginzone_region</span>
  1423. </dt>
  1424. <dd class="index-item-body">
  1425. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_set_loginzone_region">sloodle_set_loginzone_region()</a> in sl_generallib.php</div>
  1426. <div class="index-item-description">Sets the name of the region where the site-wide LoginZone object was most recently rezzed.</div>
  1427. </dd>
  1428. <dt class="field">
  1429. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1430. <span class="method-title">sloodle_set_loginzone_size</span>
  1431. </dt>
  1432. <dd class="index-item-body">
  1433. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_set_loginzone_size">sloodle_set_loginzone_size()</a> in sl_generallib.php</div>
  1434. <div class="index-item-description">Sets the size of the site-wide LoginZone object (stored in the Moodle configuration table).</div>
  1435. </dd>
  1436. <dt class="field">
  1437. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1438. <span class="method-title">sloodle_set_prim_password</span>
  1439. </dt>
  1440. <dd class="index-item-body">
  1441. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_set_prim_password">sloodle_set_prim_password()</a> in sl_generallib.php</div>
  1442. <div class="index-item-description">Sets the site-wide Sloodle prim password from the configuration table.</div>
  1443. </dd>
  1444. <dt class="field">
  1445. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1446. <span class="method-title">sloodle_update_instance</span>
  1447. </dt>
  1448. <dd class="index-item-body">
  1449. <div class="index-item-details"><a href="sloodle/_lib.php.html#functionsloodle_update_instance">sloodle_update_instance()</a> in lib.php</div>
  1450. <div class="index-item-description">Given an object containing all the necessary data, (defined by the form in mod.html) this function will update an existing instance with new data.</div>
  1451. </dd>
  1452. <dt class="field">
  1453. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1454. <span class="method-title">sloodle_user_complete</span>
  1455. </dt>
  1456. <dd class="index-item-body">
  1457. <div class="index-item-details"><a href="sloodle/_lib.php.html#functionsloodle_user_complete">sloodle_user_complete()</a> in lib.php</div>
  1458. <div class="index-item-description">Print a detailed representation of what a user has done with a given particular instance of this module, for user activity reports.</div>
  1459. </dd>
  1460. <dt class="field">
  1461. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1462. <span class="method-title">sloodle_user_outline</span>
  1463. </dt>
  1464. <dd class="index-item-body">
  1465. <div class="index-item-details"><a href="sloodle/_lib.php.html#functionsloodle_user_outline">sloodle_user_outline()</a> in lib.php</div>
  1466. <div class="index-item-description">Return a small object with summary information about what a user has done with a given particular instance of this module Used for user activity reports.</div>
  1467. </dd>
  1468. <dt class="field">
  1469. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1470. <span class="method-title">sloodle_validate_object_for_pwd</span>
  1471. </dt>
  1472. <dd class="index-item-body">
  1473. <div class="index-item-details"><a href="sloodle/_lib---sl_classroomlib.php.html#functionsloodle_validate_object_for_pwd">sloodle_validate_object_for_pwd()</a> in sl_classroomlib.php</div>
  1474. </dd>
  1475. <dt class="field">
  1476. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  1477. <span class="method-title">sloodle_vector_to_array</span>
  1478. </dt>
  1479. <dd class="index-item-body">
  1480. <div class="index-item-details"><a href="sloodle/_lib---sl_generallib.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array()</a> in sl_generallib.php</div>
  1481. <div class="index-item-description">Converts a string vector to an array vector.</div>
  1482. </dd>
  1483. <dt class="field">
  1484. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  1485. <span class="const-title">SLOODLE_VERSION</span>
  1486. </dt>
  1487. <dd class="index-item-body">
  1488. <div class="index-item-details"><a href="sloodle/_config.php.html#defineSLOODLE_VERSION">SLOODLE_VERSION</a> in config.php</div>
  1489. </dd>
  1490. <dt class="field">
  1491. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  1492. <span class="const-title">SLOODLE_WWWROOT</span>
  1493. </dt>
  1494. <dd class="index-item-body">
  1495. <div class="index-item-details"><a href="sloodle/_config.php.html#defineSLOODLE_WWWROOT">SLOODLE_WWWROOT</a> in config.php</div>
  1496. </dd>
  1497. <dt class="field">
  1498. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1499. <span class="include-title">sl_debug.php</span>
  1500. </dt>
  1501. <dd class="index-item-body">
  1502. <div class="index-item-details"><a href="sloodle/_sl_debug.php.html">sl_debug.php</a> in sl_debug.php</div>
  1503. </dd>
  1504. <dt class="field">
  1505. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1506. <span class="include-title">sl_setup_notecard.php</span>
  1507. </dt>
  1508. <dd class="index-item-body">
  1509. <div class="index-item-details"><a href="sloodle/_sl_setup_notecard.php.html">sl_setup_notecard.php</a> in sl_setup_notecard.php</div>
  1510. </dd>
  1511. </dl>
  1512. <a name="t"></a>
  1513. <div class="index-letter-section">
  1514. <div style="float: left" class="index-letter-title">t</div>
  1515. <div style="float: right"><a href="#top">top</a></div>
  1516. <div style="clear: both"></div>
  1517. </div>
  1518. <dl>
  1519. <dt class="field">
  1520. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  1521. <span class="var-title">$tracking_code</span>
  1522. </dt>
  1523. <dd class="index-item-body">
  1524. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#var$tracking_code">SloodleLSLResponse::$tracking_code</a> in sl_iolib.php</div>
  1525. <div class="index-item-description">Tracking code of the request.</div>
  1526. </dd>
  1527. </dl>
  1528. <a name="u"></a>
  1529. <div class="index-letter-section">
  1530. <div style="float: left" class="index-letter-title">u</div>
  1531. <div style="float: right"><a href="#top">top</a></div>
  1532. <div style="clear: both"></div>
  1533. </div>
  1534. <dl>
  1535. <dt class="field">
  1536. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  1537. <span class="var-title">$user</span>
  1538. </dt>
  1539. <dd class="index-item-body">
  1540. <div class="index-item-details"><a href="sloodle/SloodleLSLRequest.html#var$user">SloodleLSLRequest::$user</a> in sl_iolib.php</div>
  1541. <div class="index-item-description">The object used to store and process incoming user data.</div>
  1542. </dd>
  1543. <dt class="field">
  1544. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1545. <span class="var-title">$user</span>
  1546. </dt>
  1547. <dd class="index-item-body">
  1548. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#var$user">SloodleLSLHandler::$user</a> in sl_lsllib.php</div>
  1549. <div class="index-item-description">A Sloodle user object.</div>
  1550. </dd>
  1551. <dt class="field">
  1552. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  1553. <span class="var-title">$user_key</span>
  1554. </dt>
  1555. <dd class="index-item-body">
  1556. <div class="index-item-details"><a href="sloodle/SloodleLSLResponse.html#var$user_key">SloodleLSLResponse::$user_key</a> in sl_iolib.php</div>
  1557. <div class="index-item-description">SL agent key.</div>
  1558. </dd>
  1559. <dt class="field">
  1560. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1561. <span class="method-title">unlink_sloodle_user</span>
  1562. </dt>
  1563. <dd class="index-item-body">
  1564. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodunlink_sloodle_user">SloodleUser::unlink_sloodle_user()</a> in sl_userlib.php</div>
  1565. <div class="index-item-description">Completely unlinks the Sloodle user from any Moodle account.</div>
  1566. </dd>
  1567. <dt class="field">
  1568. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1569. <span class="method-title">update_enrolled_courses_cache_from_db</span>
  1570. </dt>
  1571. <dd class="index-item-body">
  1572. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodupdate_enrolled_courses_cache_from_db">SloodleUser::update_enrolled_courses_cache_from_db()</a> in sl_userlib.php</div>
  1573. <div class="index-item-description">Use the database to update the cache of courses which the current Moodle user is enrolled in.</div>
  1574. </dd>
  1575. <dt class="field">
  1576. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1577. <span class="method-title">update_moodle_user_cache_from_db</span>
  1578. </dt>
  1579. <dd class="index-item-body">
  1580. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodupdate_moodle_user_cache_from_db">SloodleUser::update_moodle_user_cache_from_db()</a> in sl_userlib.php</div>
  1581. <div class="index-item-description">Update the Moodle user cache ({@link:$moodle_user_cache}) from the database</div>
  1582. </dd>
  1583. <dt class="field">
  1584. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1585. <span class="method-title">update_sloodle_user_cache_from_db</span>
  1586. </dt>
  1587. <dd class="index-item-body">
  1588. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodupdate_sloodle_user_cache_from_db">SloodleUser::update_sloodle_user_cache_from_db()</a> in sl_userlib.php</div>
  1589. <div class="index-item-description">Updates the Sloodle user cache ({@link:$sloodle_user_cache}) from the database</div>
  1590. </dd>
  1591. <dt class="field">
  1592. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1593. <span class="method-title">update_sloodle_user_cache_to_db</span>
  1594. </dt>
  1595. <dd class="index-item-body">
  1596. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodupdate_sloodle_user_cache_to_db">SloodleUser::update_sloodle_user_cache_to_db()</a> in sl_userlib.php</div>
  1597. <div class="index-item-description">Use the Sloodle user cache to update an entry in the Sloodle users database table.</div>
  1598. </dd>
  1599. <dt class="field">
  1600. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1601. <span class="method-title">users_linked</span>
  1602. </dt>
  1603. <dd class="index-item-body">
  1604. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodusers_linked">SloodleUser::users_linked()</a> in sl_userlib.php</div>
  1605. <div class="index-item-description">Determines whether or not the current Sloodle and Moodle users are linked.</div>
  1606. </dd>
  1607. </dl>
  1608. <a name="v"></a>
  1609. <div class="index-letter-section">
  1610. <div style="float: left" class="index-letter-title">v</div>
  1611. <div style="float: right"><a href="#top">top</a></div>
  1612. <div style="clear: both"></div>
  1613. </div>
  1614. <dl>
  1615. <dt class="field">
  1616. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1617. <span class="include-title">version.php</span>
  1618. </dt>
  1619. <dd class="index-item-body">
  1620. <div class="index-item-details"><a href="sloodle/_version.php.html">version.php</a> in version.php</div>
  1621. </dd>
  1622. <dt class="field">
  1623. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1624. <span class="include-title">version_linker.php</span>
  1625. </dt>
  1626. <dd class="index-item-body">
  1627. <div class="index-item-details"><a href="sloodle/_version_linker.php.html">version_linker.php</a> in version_linker.php</div>
  1628. </dd>
  1629. <dt class="field">
  1630. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1631. <span class="include-title">view_user.php</span>
  1632. </dt>
  1633. <dd class="index-item-body">
  1634. <div class="index-item-details"><a href="sloodle/_view_user.php.html">view_user.php</a> in view_user.php</div>
  1635. </dd>
  1636. <dt class="field">
  1637. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1638. <span class="include-title">view_users.php</span>
  1639. </dt>
  1640. <dd class="index-item-body">
  1641. <div class="index-item-details"><a href="sloodle/_view_users.php.html">view_users.php</a> in view_users.php</div>
  1642. </dd>
  1643. </dl>
  1644. <div class="index-letter-menu">
  1645. <a class="index-letter" href="elementindex_sloodle.html#a">a</a>
  1646. <a class="index-letter" href="elementindex_sloodle.html#c">c</a>
  1647. <a class="index-letter" href="elementindex_sloodle.html#d">d</a>
  1648. <a class="index-letter" href="elementindex_sloodle.html#e">e</a>
  1649. <a class="index-letter" href="elementindex_sloodle.html#f">f</a>
  1650. <a class="index-letter" href="elementindex_sloodle.html#g">g</a>
  1651. <a class="index-letter" href="elementindex_sloodle.html#h">h</a>
  1652. <a class="index-letter" href="elementindex_sloodle.html#i">i</a>
  1653. <a class="index-letter" href="elementindex_sloodle.html#l">l</a>
  1654. <a class="index-letter" href="elementindex_sloodle.html#m">m</a>
  1655. <a class="index-letter" href="elementindex_sloodle.html#p">p</a>
  1656. <a class="index-letter" href="elementindex_sloodle.html#q">q</a>
  1657. <a class="index-letter" href="elementindex_sloodle.html#r">r</a>
  1658. <a class="index-letter" href="elementindex_sloodle.html#s">s</a>
  1659. <a class="index-letter" href="elementindex_sloodle.html#t">t</a>
  1660. <a class="index-letter" href="elementindex_sloodle.html#u">u</a>
  1661. <a class="index-letter" href="elementindex_sloodle.html#v">v</a>
  1662. <a class="index-letter" href="elementindex_sloodle.html#_">_</a>
  1663. </div> </body>
  1664. </html>