elementindex_sloodle.html 212 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733
  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_sloodleclassroom.html">sloodleclassroom</a></li>
  15. <li><a href="elementindex_sloodlelang.html">sloodlelang</a></li>
  16. <li><a href="elementindex_sloodlelogin.html">sloodlelogin</a></li>
  17. <li><a href="elementindex_sloodlechat.html">sloodlechat</a></li>
  18. <li><a href="elementindex_sloodledistributor.html">sloodledistributor</a></li>
  19. <li><a href="elementindex_sloodleglossary.html">sloodleglossary</a></li>
  20. <li><a href="elementindex_sloodlepwreset.html">sloodlepwreset</a></li>
  21. <li><a href="elementindex_quiz.html">quiz</a></li>
  22. <li><a href="elementindex_sloodleblog.html">sloodleblog</a></li>
  23. </ul>
  24. <a href="elementindex.html">All elements</a>
  25. <br />
  26. <div class="index-letter-menu">
  27. <a class="index-letter" href="elementindex_sloodle.html#a">a</a>
  28. <a class="index-letter" href="elementindex_sloodle.html#b">b</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#n">n</a>
  39. <a class="index-letter" href="elementindex_sloodle.html#o">o</a>
  40. <a class="index-letter" href="elementindex_sloodle.html#p">p</a>
  41. <a class="index-letter" href="elementindex_sloodle.html#q">q</a>
  42. <a class="index-letter" href="elementindex_sloodle.html#r">r</a>
  43. <a class="index-letter" href="elementindex_sloodle.html#s">s</a>
  44. <a class="index-letter" href="elementindex_sloodle.html#t">t</a>
  45. <a class="index-letter" href="elementindex_sloodle.html#u">u</a>
  46. <a class="index-letter" href="elementindex_sloodle.html#v">v</a>
  47. <a class="index-letter" href="elementindex_sloodle.html#w">w</a>
  48. <a class="index-letter" href="elementindex_sloodle.html#_">_</a>
  49. </div>
  50. <a name="_"></a>
  51. <div class="index-letter-section">
  52. <div style="float: left" class="index-letter-title">_</div>
  53. <div style="float: right"><a href="#top">top</a></div>
  54. <div style="clear: both"></div>
  55. </div>
  56. <dl>
  57. <dt class="field">
  58. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  59. <span class="var-title">$_session</span>
  60. </dt>
  61. <dd class="index-item-body">
  62. <div class="index-item-details"><a href="sloodle/SloodleModule.html#var$_session">SloodleModule::$_session</a> in module_base.php</div>
  63. <div class="index-item-description">Reference to the containing <a href="sloodle/SloodleSession.html">SloodleSession</a> object.</div>
  64. </dd>
  65. <dt class="field">
  66. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  67. <span class="var-title">$_session</span>
  68. </dt>
  69. <dd class="index-item-body">
  70. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#var$_session">SloodleRequest::$_session</a> in io.php</div>
  71. <div class="index-item-description">Reference to the containing <a href="sloodle/SloodleSession.html">SloodleSession</a> object.</div>
  72. </dd>
  73. <dt class="field">
  74. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  75. <span class="var-title">$_session</span>
  76. </dt>
  77. <dd class="index-item-body">
  78. <div class="index-item-details"><a href="sloodle/SloodleUser.html#var$_session">SloodleUser::$_session</a> in user.php</div>
  79. <div class="index-item-description">Internal only - reference to the containing <a href="sloodle/SloodleSession.html">SloodleSession</a> object.</div>
  80. </dd>
  81. <dt class="field">
  82. <img src="media/images/PrivateMethod.png" alt="Method" title="Method" /></title>
  83. <span class="method-title">_internal_validation_error</span>
  84. </dt>
  85. <dd class="index-item-body">
  86. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#method_internal_validation_error">SloodleResponse::_internal_validation_error()</a> in io.php</div>
  87. <div class="index-item-description">Internal function to report a data validation error.</div>
  88. </dd>
  89. </dl>
  90. <a name="a"></a>
  91. <div class="index-letter-section">
  92. <div style="float: left" class="index-letter-title">a</div>
  93. <div style="float: right"><a href="#top">top</a></div>
  94. <div style="clear: both"></div>
  95. </div>
  96. <dl>
  97. <dt class="field">
  98. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  99. <span class="var-title">$assignment</span>
  100. </dt>
  101. <dd class="index-item-body">
  102. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#var$assignment">SloodleModuleSloodleObject::$assignment</a> in module_sloodleobject.php</div>
  103. <div class="index-item-description">Internal only - the Moodle assignment structure.</div>
  104. </dd>
  105. <dt class="field">
  106. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  107. <span class="var-title">$avatar_data</span>
  108. </dt>
  109. <dd class="index-item-body">
  110. <div class="index-item-details"><a href="sloodle/SloodleUser.html#var$avatar_data">SloodleUser::$avatar_data</a> in user.php</div>
  111. <div class="index-item-description">Internal only - avatar data.</div>
  112. </dd>
  113. <dt class="field">
  114. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  115. <span class="var-title">$avatar_uuid</span>
  116. </dt>
  117. <dd class="index-item-body">
  118. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#var$avatar_uuid">SloodleResponse::$avatar_uuid</a> in io.php</div>
  119. <div class="index-item-description">Avatar UUID.</div>
  120. </dd>
  121. <dt class="field">
  122. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  123. <span class="method-title">add_data_line</span>
  124. </dt>
  125. <dd class="index-item-body">
  126. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodadd_data_line">SloodleResponse::add_data_line()</a> in io.php</div>
  127. <div class="index-item-description">Adds one line of data to the $data member</div>
  128. </dd>
  129. <dt class="field">
  130. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  131. <span class="method-title">add_linked_avatar</span>
  132. </dt>
  133. <dd class="index-item-body">
  134. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodadd_linked_avatar">SloodleUser::add_linked_avatar()</a> in user.php</div>
  135. <div class="index-item-description">Adds a new avatar to the database, and link it to the specified user.</div>
  136. </dd>
  137. <dt class="field">
  138. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  139. <span class="method-title">add_message</span>
  140. </dt>
  141. <dd class="index-item-body">
  142. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html#methodadd_message">SloodleModuleChat::add_message()</a> in module_chat.php</div>
  143. <div class="index-item-description">Adds a new chat message.</div>
  144. </dd>
  145. <dt class="field">
  146. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  147. <span class="method-title">add_pending_avatar</span>
  148. </dt>
  149. <dd class="index-item-body">
  150. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodadd_pending_avatar">SloodleUser::add_pending_avatar()</a> in user.php</div>
  151. <div class="index-item-description">Adds a new unlinked avatar to the database (the entry is pending linking)</div>
  152. </dd>
  153. <dt class="field">
  154. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  155. <span class="method-title">add_side_effect</span>
  156. </dt>
  157. <dd class="index-item-body">
  158. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodadd_side_effect">SloodleResponse::add_side_effect()</a> in io.php</div>
  159. <div class="index-item-description">Adds a single side effect code to member $status_code</div>
  160. </dd>
  161. <dt class="field">
  162. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  163. <span class="method-title">add_side_effects</span>
  164. </dt>
  165. <dd class="index-item-body">
  166. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodadd_side_effects">SloodleResponse::add_side_effects()</a> in io.php</div>
  167. <div class="index-item-description">Adds one or more integer side effect codes to member $status_code.</div>
  168. </dd>
  169. <dt class="field">
  170. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  171. assignment_sloodleobject
  172. </dt>
  173. <dd class="index-item-body">
  174. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject.html">assignment_sloodleobject</a> in assignment.class.php</div>
  175. <div class="index-item-description">Extend the base assignment class for assignments where you submit an SL object in-world.</div>
  176. </dd>
  177. <dt class="field">
  178. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  179. <span class="method-title">assignment_sloodleobject</span>
  180. </dt>
  181. <dd class="index-item-body">
  182. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject.html#methodassignment_sloodleobject">assignment_sloodleobject::assignment_sloodleobject()</a> in assignment.class.php</div>
  183. </dd>
  184. <dt class="field">
  185. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  186. assignment_sloodleobject_submission
  187. </dt>
  188. <dd class="index-item-body">
  189. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html">assignment_sloodleobject_submission</a> in assignment.class.php</div>
  190. <div class="index-item-description">Defines a submission for a Sloodle assignment.</div>
  191. </dd>
  192. <dt class="field">
  193. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  194. <span class="method-title">authenticate_request</span>
  195. </dt>
  196. <dd class="index-item-body">
  197. <div class="index-item-details"><a href="sloodle/SloodleSession.html#methodauthenticate_request">SloodleSession::authenticate_request()</a> in sloodle_session.php</div>
  198. <div class="index-item-description">Verifies security for the incoming request (but does not check user access).</div>
  199. </dd>
  200. <dt class="field">
  201. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  202. <span class="method-title">authorise_object</span>
  203. </dt>
  204. <dd class="index-item-body">
  205. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodauthorise_object">SloodleController::authorise_object()</a> in controller.php</div>
  206. <div class="index-item-description">Authorises an otherwise unauthorised active object against the given user and the current controller.</div>
  207. </dd>
  208. <dt class="field">
  209. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  210. <span class="method-title">autoregister_avatar_user</span>
  211. </dt>
  212. <dd class="index-item-body">
  213. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodautoregister_avatar_user">SloodleUser::autoregister_avatar_user()</a> in user.php</div>
  214. <div class="index-item-description">Auto-register a new user account for the current avatar.</div>
  215. </dd>
  216. <dt class="field">
  217. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  218. <span class="include-title">access.php</span>
  219. </dt>
  220. <dd class="index-item-body">
  221. <div class="index-item-details"><a href="sloodle/_sloodle---db---access.php.html">access.php</a> in access.php</div>
  222. </dd>
  223. <dt class="field">
  224. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  225. <span class="include-title">active_object.php</span>
  226. </dt>
  227. <dd class="index-item-body">
  228. <div class="index-item-details"><a href="sloodle/_sloodle---lib---active_object.php.html">active_object.php</a> in active_object.php</div>
  229. </dd>
  230. <dt class="field">
  231. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  232. <span class="include-title">assignment.class.php</span>
  233. </dt>
  234. <dd class="index-item-body">
  235. <div class="index-item-details"><a href="sloodle/_sloodle---mod---primdrop-1.0---sloodleobject---assignment.class.php.html">assignment.class.php</a> in assignment.class.php</div>
  236. </dd>
  237. </dl>
  238. <a name="b"></a>
  239. <div class="index-letter-section">
  240. <div style="float: left" class="index-letter-title">b</div>
  241. <div style="float: right"><a href="#top">top</a></div>
  242. <div style="clear: both"></div>
  243. </div>
  244. <dl>
  245. <dt class="field">
  246. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  247. block_sloodle_menu
  248. </dt>
  249. <dd class="index-item-body">
  250. <div class="index-item-details"><a href="sloodle/block_sloodle_menu.html">block_sloodle_menu</a> in block_sloodle_menu.php</div>
  251. <div class="index-item-description">Defines the block class.</div>
  252. </dd>
  253. <dt class="field">
  254. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  255. <span class="include-title">block_sloodle_menu.php</span>
  256. </dt>
  257. <dd class="index-item-body">
  258. <div class="index-item-details"><a href="sloodle/_sloodle_menu---block_sloodle_menu.php.html">block_sloodle_menu.php</a> in block_sloodle_menu.php</div>
  259. </dd>
  260. <dt class="field">
  261. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  262. <span class="include-title">block_sloodle_menu.php</span>
  263. </dt>
  264. <dd class="index-item-body">
  265. <div class="index-item-details"><a href="sloodle/_sloodle_menu---lang---en_utf8---block_sloodle_menu.php.html">block_sloodle_menu.php</a> in block_sloodle_menu.php</div>
  266. </dd>
  267. </dl>
  268. <a name="c"></a>
  269. <div class="index-letter-section">
  270. <div style="float: left" class="index-letter-title">c</div>
  271. <div style="float: right"><a href="#top">top</a></div>
  272. <div style="clear: both"></div>
  273. </div>
  274. <dl>
  275. <dt class="field">
  276. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  277. <span class="var-title">$cm</span>
  278. </dt>
  279. <dd class="index-item-body">
  280. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html#var$cm">SloodleModuleChat::$cm</a> in module_chat.php</div>
  281. <div class="index-item-description">Internal for Moodle only - course module instance.</div>
  282. </dd>
  283. <dt class="field">
  284. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  285. <span class="var-title">$cm</span>
  286. </dt>
  287. <dd class="index-item-body">
  288. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#var$cm">SloodleModuleSloodleObject::$cm</a> in module_sloodleobject.php</div>
  289. <div class="index-item-description">Internal for Moodle only - course module instance.</div>
  290. </dd>
  291. <dt class="field">
  292. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  293. <span class="var-title">$cm</span>
  294. </dt>
  295. <dd class="index-item-body">
  296. <div class="index-item-details"><a href="sloodle/SloodleController.html#var$cm">SloodleController::$cm</a> in controller.php</div>
  297. <div class="index-item-description">Internal for Moodle only - course module instance.</div>
  298. </dd>
  299. <dt class="field">
  300. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  301. <span class="var-title">$cm</span>
  302. </dt>
  303. <dd class="index-item-body">
  304. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#var$cm">SloodleModuleDistributor::$cm</a> in module_distributor.php</div>
  305. <div class="index-item-description">Internal for Moodle only - course module instance.</div>
  306. </dd>
  307. <dt class="field">
  308. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  309. <span class="var-title">$cm</span>
  310. </dt>
  311. <dd class="index-item-body">
  312. <div class="index-item-details"><a href="sloodle/SloodleModuleGlossary.html#var$cm">SloodleModuleGlossary::$cm</a> in module_glossary.php</div>
  313. <div class="index-item-description">Internal for Moodle only - course module instance.</div>
  314. </dd>
  315. <dt class="field">
  316. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  317. <span class="var-title">$concept</span>
  318. </dt>
  319. <dd class="index-item-body">
  320. <div class="index-item-details"><a href="sloodle/SloodleGlossaryEntry.html#var$concept">SloodleGlossaryEntry::$concept</a> in module_glossary.php</div>
  321. <div class="index-item-description">The name of this entry.</div>
  322. </dd>
  323. <dt class="field">
  324. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  325. <span class="var-title">$controller</span>
  326. </dt>
  327. <dd class="index-item-body">
  328. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#var$controller">SloodleCourse::$controller</a> in course.php</div>
  329. <div class="index-item-description">The <a href="sloodle/SloodleController.html">SloodleController</a> object being used to access this course, if available.</div>
  330. </dd>
  331. <dt class="field">
  332. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  333. <span class="var-title">$course</span>
  334. </dt>
  335. <dd class="index-item-body">
  336. <div class="index-item-details"><a href="sloodle/SloodleActiveObject.html#var$course">SloodleActiveObject::$course</a> in active_object.php</div>
  337. <div class="index-item-description">The course/controller which this object is authorised for.</div>
  338. </dd>
  339. <dt class="field">
  340. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  341. <span class="var-title">$course</span>
  342. </dt>
  343. <dd class="index-item-body">
  344. <div class="index-item-details"><a href="sloodle/SloodleSession.html#var$course">SloodleSession::$course</a> in sloodle_session.php</div>
  345. <div class="index-item-description">The Sloodle course structure for the course this session is accessing</div>
  346. </dd>
  347. <dt class="field">
  348. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  349. <span class="var-title">$course_object</span>
  350. </dt>
  351. <dd class="index-item-body">
  352. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#var$course_object">SloodleCourse::$course_object</a> in course.php</div>
  353. <div class="index-item-description">The database object of the course to which this object relates.</div>
  354. </dd>
  355. <dt class="field">
  356. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  357. <span class="method-title">can_user_authorise_objects</span>
  358. </dt>
  359. <dd class="index-item-body">
  360. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodcan_user_authorise_objects">SloodleCourse::can_user_authorise_objects()</a> in course.php</div>
  361. <div class="index-item-description">Checks whether or not the CURRENTLY LOGGED-IN user can authorise objects on this course.</div>
  362. </dd>
  363. <dt class="field">
  364. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  365. <span class="method-title">check_authorisation</span>
  366. </dt>
  367. <dd class="index-item-body">
  368. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodcheck_authorisation">SloodleController::check_authorisation()</a> in controller.php</div>
  369. <div class="index-item-description">Checks if the specified object is authorised for this controller with the given password.</div>
  370. </dd>
  371. <dt class="field">
  372. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  373. <span class="method-title">check_autoenrol</span>
  374. </dt>
  375. <dd class="index-item-body">
  376. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodcheck_autoenrol">SloodleCourse::check_autoenrol()</a> in course.php</div>
  377. <div class="index-item-description">Is auto enrolment permitted on this site AND course? Takes into account the site-wide setting as well.</div>
  378. </dd>
  379. <dt class="field">
  380. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  381. <span class="method-title">check_autoreg</span>
  382. </dt>
  383. <dd class="index-item-body">
  384. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodcheck_autoreg">SloodleCourse::check_autoreg()</a> in course.php</div>
  385. <div class="index-item-description">Is auto registration permitted on this site AND course? Takes into account the site-wide setting as well.</div>
  386. </dd>
  387. <dt class="field">
  388. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  389. <span class="method-title">clear_data</span>
  390. </dt>
  391. <dd class="index-item-body">
  392. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodclear_data">SloodleResponse::clear_data()</a> in io.php</div>
  393. <div class="index-item-description">Clears all data from member $data</div>
  394. </dd>
  395. <dt class="field">
  396. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  397. <span class="method-title">confirm_by_login_security_token</span>
  398. </dt>
  399. <dd class="index-item-body">
  400. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#methodconfirm_by_login_security_token">SloodleLSLHandler::confirm_by_login_security_token()</a> in lsl.php</div>
  401. <div class="index-item-description">Authenticates the avatar identified in the request by the login security token.</div>
  402. </dd>
  403. <dt class="field">
  404. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  405. <span class="include-title">controller.php</span>
  406. </dt>
  407. <dd class="index-item-body">
  408. <div class="index-item-details"><a href="sloodle/_sloodle---lib---controller.php.html">controller.php</a> in controller.php</div>
  409. </dd>
  410. <dt class="field">
  411. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  412. <span class="include-title">course.php</span>
  413. </dt>
  414. <dd class="index-item-body">
  415. <div class="index-item-details"><a href="sloodle/_sloodle---lib---course.php.html">course.php</a> in course.php</div>
  416. </dd>
  417. </dl>
  418. <a name="d"></a>
  419. <div class="index-letter-section">
  420. <div style="float: left" class="index-letter-title">d</div>
  421. <div style="float: right"><a href="#top">top</a></div>
  422. <div style="clear: both"></div>
  423. </div>
  424. <dl>
  425. <dt class="field">
  426. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  427. <span class="var-title">$data</span>
  428. </dt>
  429. <dd class="index-item-body">
  430. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#var$data">SloodleResponse::$data</a> in io.php</div>
  431. <div class="index-item-description">Data to render following the status line in the response.</div>
  432. </dd>
  433. <dt class="field">
  434. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  435. <span class="var-title">$definition</span>
  436. </dt>
  437. <dd class="index-item-body">
  438. <div class="index-item-details"><a href="sloodle/SloodleGlossaryEntry.html#var$definition">SloodleGlossaryEntry::$definition</a> in module_glossary.php</div>
  439. <div class="index-item-description">The definition of this entry.</div>
  440. </dd>
  441. <dt class="field">
  442. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  443. <span class="method-title">data_preprocessing</span>
  444. </dt>
  445. <dd class="index-item-body">
  446. <div class="index-item-details"><a href="sloodle/mod_sloodle_mod_form.html#methoddata_preprocessing">mod_sloodle_mod_form::data_preprocessing()</a> in mod_form.php</div>
  447. <div class="index-item-description">Pre-processes form initial values.</div>
  448. </dd>
  449. <dt class="field">
  450. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  451. <span class="method-title">definition</span>
  452. </dt>
  453. <dd class="index-item-body">
  454. <div class="index-item-details"><a href="sloodle/mod_sloodle_mod_form.html#methoddefinition">mod_sloodle_mod_form::definition()</a> in mod_form.php</div>
  455. <div class="index-item-description">Defines the form</div>
  456. </dd>
  457. <dt class="field">
  458. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  459. <span class="method-title">definition_after_data</span>
  460. </dt>
  461. <dd class="index-item-body">
  462. <div class="index-item-details"><a href="sloodle/mod_sloodle_mod_form.html#methoddefinition_after_data">mod_sloodle_mod_form::definition_after_data()</a> in mod_form.php</div>
  463. <div class="index-item-description">Performs extra processing on the form after existing/default data has been specified.</div>
  464. </dd>
  465. <dt class="field">
  466. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  467. <span class="method-title">delete_avatar</span>
  468. </dt>
  469. <dd class="index-item-body">
  470. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methoddelete_avatar">SloodleUser::delete_avatar()</a> in user.php</div>
  471. <div class="index-item-description">Deletes the current avatar from the database.</div>
  472. </dd>
  473. <dt class="field">
  474. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  475. <span class="method-title">delete_layout</span>
  476. </dt>
  477. <dd class="index-item-body">
  478. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methoddelete_layout">SloodleCourse::delete_layout()</a> in course.php</div>
  479. <div class="index-item-description">Deletes the named layout.</div>
  480. </dd>
  481. <dt class="field">
  482. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  483. <span class="method-title">delete_loginzone_allocation</span>
  484. </dt>
  485. <dd class="index-item-body">
  486. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methoddelete_loginzone_allocation">SloodleCourse::delete_loginzone_allocation()</a> in course.php</div>
  487. <div class="index-item-description">Deletes any loginzone allocations for the given user If there are multiple for the same user (which there should never be) it will delete them all.</div>
  488. </dd>
  489. <dt class="field">
  490. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  491. <span class="method-title">disable</span>
  492. </dt>
  493. <dd class="index-item-body">
  494. <div class="index-item-details"><a href="sloodle/SloodleController.html#methoddisable">SloodleController::disable()</a> in controller.php</div>
  495. <div class="index-item-description">Disables this controller</div>
  496. </dd>
  497. <dt class="field">
  498. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  499. <span class="method-title">disable_autoenrol</span>
  500. </dt>
  501. <dd class="index-item-body">
  502. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methoddisable_autoenrol">SloodleCourse::disable_autoenrol()</a> in course.php</div>
  503. <div class="index-item-description">Disables auto-enrolment for this course.</div>
  504. </dd>
  505. <dt class="field">
  506. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  507. <span class="method-title">disable_autoreg</span>
  508. </dt>
  509. <dd class="index-item-body">
  510. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methoddisable_autoreg">SloodleCourse::disable_autoreg()</a> in course.php</div>
  511. <div class="index-item-description">Disables auto-registration for this course.</div>
  512. </dd>
  513. </dl>
  514. <a name="e"></a>
  515. <div class="index-letter-section">
  516. <div style="float: left" class="index-letter-title">e</div>
  517. <div style="float: right"><a href="#top">top</a></div>
  518. <div style="clear: both"></div>
  519. </div>
  520. <dl>
  521. <dt class="field">
  522. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  523. <span class="method-title">enable</span>
  524. </dt>
  525. <dd class="index-item-body">
  526. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodenable">SloodleController::enable()</a> in controller.php</div>
  527. <div class="index-item-description">Enables this controller</div>
  528. </dd>
  529. <dt class="field">
  530. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  531. <span class="method-title">enable_autoenrol</span>
  532. </dt>
  533. <dd class="index-item-body">
  534. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodenable_autoenrol">SloodleCourse::enable_autoenrol()</a> in course.php</div>
  535. <div class="index-item-description">Enables auto-enrolment for this course.</div>
  536. </dd>
  537. <dt class="field">
  538. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  539. <span class="method-title">enable_autoreg</span>
  540. </dt>
  541. <dd class="index-item-body">
  542. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodenable_autoreg">SloodleCourse::enable_autoreg()</a> in course.php</div>
  543. <div class="index-item-description">Enables auto-registration for this course.</div>
  544. </dd>
  545. <dt class="field">
  546. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  547. <span class="method-title">enrol</span>
  548. </dt>
  549. <dd class="index-item-body">
  550. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodenrol">SloodleUser::enrol()</a> in user.php</div>
  551. <div class="index-item-description">Enrols the current user in the specified course</div>
  552. </dd>
  553. </dl>
  554. <a name="f"></a>
  555. <div class="index-letter-section">
  556. <div style="float: left" class="index-letter-title">f</div>
  557. <div style="float: right"><a href="#top">top</a></div>
  558. <div style="clear: both"></div>
  559. </div>
  560. <dl>
  561. <dt class="field">
  562. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  563. <span class="var-title">$field_separator</span>
  564. </dt>
  565. <dd class="index-item-body">
  566. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#var$field_separator">SloodleResponse::$field_separator</a> in io.php</div>
  567. <div class="index-item-description">The separation string between fields of a response line (by default, a pipe character |).</div>
  568. </dd>
  569. <dt class="field">
  570. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  571. <span class="include-title">file.php</span>
  572. </dt>
  573. <dd class="index-item-body">
  574. <div class="index-item-details"><a href="sloodle/_sloodle---mod---primdrop-1.0---sloodleobject---file.php.html">file.php</a> in file.php</div>
  575. </dd>
  576. </dl>
  577. <a name="g"></a>
  578. <div class="index-letter-section">
  579. <div style="float: left" class="index-letter-title">g</div>
  580. <div style="float: right"><a href="#top">top</a></div>
  581. <div style="clear: both"></div>
  582. </div>
  583. <dl>
  584. <dt class="field">
  585. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  586. <span class="method-title">generate_loginzone_allocation</span>
  587. </dt>
  588. <dd class="index-item-body">
  589. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodgenerate_loginzone_allocation">SloodleCourse::generate_loginzone_allocation()</a> in course.php</div>
  590. <div class="index-item-description">Generates a new LoginZone allocation for the specified user.</div>
  591. </dd>
  592. <dt class="field">
  593. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  594. <span class="method-title">get_authorizing_user</span>
  595. </dt>
  596. <dd class="index-item-body">
  597. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodget_authorizing_user">SloodleController::get_authorizing_user()</a> in controller.php</div>
  598. <div class="index-item-description">Gets the ID of the user who authorised the specified object.</div>
  599. </dd>
  600. <dt class="field">
  601. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  602. <span class="method-title">get_autoenrol</span>
  603. </dt>
  604. <dd class="index-item-body">
  605. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodget_autoenrol">SloodleCourse::get_autoenrol()</a> in course.php</div>
  606. <div class="index-item-description">Gets the auto enrolment value for this course only.</div>
  607. </dd>
  608. <dt class="field">
  609. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  610. <span class="method-title">get_autoreg</span>
  611. </dt>
  612. <dd class="index-item-body">
  613. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodget_autoreg">SloodleCourse::get_autoreg()</a> in course.php</div>
  614. <div class="index-item-description">Gets the autoregistration value for this course only.</div>
  615. </dd>
  616. <dt class="field">
  617. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  618. <span class="method-title">get_avatar_id</span>
  619. </dt>
  620. <dd class="index-item-body">
  621. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodget_avatar_id">SloodleUser::get_avatar_id()</a> in user.php</div>
  622. <div class="index-item-description">Gets the unique ID of the avatar.</div>
  623. </dd>
  624. <dt class="field">
  625. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  626. <span class="method-title">get_avatar_last_active</span>
  627. </dt>
  628. <dd class="index-item-body">
  629. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodget_avatar_last_active">SloodleUser::get_avatar_last_active()</a> in user.php</div>
  630. <div class="index-item-description">Gets the timestamp of whenever the avatar was last active</div>
  631. </dd>
  632. <dt class="field">
  633. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  634. <span class="method-title">get_avatar_name</span>
  635. </dt>
  636. <dd class="index-item-body">
  637. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodget_avatar_name">SloodleRequest::get_avatar_name()</a> in io.php</div>
  638. <div class="index-item-description">Fetches the avatar name request parameter.</div>
  639. </dd>
  640. <dt class="field">
  641. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  642. <span class="method-title">get_avatar_name</span>
  643. </dt>
  644. <dd class="index-item-body">
  645. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodget_avatar_name">SloodleUser::get_avatar_name()</a> in user.php</div>
  646. <div class="index-item-description">Gets the name of the avatar</div>
  647. </dd>
  648. <dt class="field">
  649. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  650. <span class="method-title">get_avatar_uuid</span>
  651. </dt>
  652. <dd class="index-item-body">
  653. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodget_avatar_uuid">SloodleUser::get_avatar_uuid()</a> in user.php</div>
  654. <div class="index-item-description">Gets the UUID of the avatar</div>
  655. </dd>
  656. <dt class="field">
  657. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  658. <span class="method-title">get_avatar_uuid</span>
  659. </dt>
  660. <dd class="index-item-body">
  661. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodget_avatar_uuid">SloodleRequest::get_avatar_uuid()</a> in io.php</div>
  662. <div class="index-item-description">Fetches the avatar UUID request parameter.</div>
  663. </dd>
  664. <dt class="field">
  665. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  666. <span class="method-title">get_chat_history</span>
  667. </dt>
  668. <dd class="index-item-body">
  669. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html#methodget_chat_history">SloodleModuleChat::get_chat_history()</a> in module_chat.php</div>
  670. <div class="index-item-description">Gets a recent history of messages from the chatroom.</div>
  671. </dd>
  672. <dt class="field">
  673. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  674. <span class="method-title">get_content</span>
  675. </dt>
  676. <dd class="index-item-body">
  677. <div class="index-item-details"><a href="sloodle/block_sloodle_menu.html#methodget_content">block_sloodle_menu::get_content()</a> in block_sloodle_menu.php</div>
  678. <div class="index-item-description">Defines *and* returns the content of this block.</div>
  679. </dd>
  680. <dt class="field">
  681. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  682. <span class="method-title">get_controller_id</span>
  683. </dt>
  684. <dd class="index-item-body">
  685. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodget_controller_id">SloodleController::get_controller_id()</a> in controller.php</div>
  686. <div class="index-item-description">Gets the identifier for controller (unique among all Sloodle controlers - may be the same as get_id() in some environments</div>
  687. </dd>
  688. <dt class="field">
  689. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  690. <span class="method-title">get_controller_id</span>
  691. </dt>
  692. <dd class="index-item-body">
  693. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodget_controller_id">SloodleRequest::get_controller_id()</a> in io.php</div>
  694. <div class="index-item-description">Fetches the controller ID request parameter.</div>
  695. </dd>
  696. <dt class="field">
  697. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  698. <span class="method-title">get_course_id</span>
  699. </dt>
  700. <dd class="index-item-body">
  701. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodget_course_id">SloodleController::get_course_id()</a> in controller.php</div>
  702. <div class="index-item-description">Gets the identifier of the course this controller belongs to.</div>
  703. </dd>
  704. <dt class="field">
  705. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  706. <span class="method-title">get_course_id</span>
  707. </dt>
  708. <dd class="index-item-body">
  709. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html#methodget_course_id">SloodleModuleChat::get_course_id()</a> in module_chat.php</div>
  710. <div class="index-item-description">Gets the identifier of the course this controller belongs to.</div>
  711. </dd>
  712. <dt class="field">
  713. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  714. <span class="method-title">get_course_id</span>
  715. </dt>
  716. <dd class="index-item-body">
  717. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#methodget_course_id">SloodleModuleDistributor::get_course_id()</a> in module_distributor.php</div>
  718. <div class="index-item-description">Gets the identifier of the course this controller belongs to.</div>
  719. </dd>
  720. <dt class="field">
  721. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  722. <span class="method-title">get_course_id</span>
  723. </dt>
  724. <dd class="index-item-body">
  725. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methodget_course_id">SloodleModuleSloodleObject::get_course_id()</a> in module_sloodleobject.php</div>
  726. <div class="index-item-description">Gets the identifier of the course this controller belongs to.</div>
  727. </dd>
  728. <dt class="field">
  729. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  730. <span class="method-title">get_course_id</span>
  731. </dt>
  732. <dd class="index-item-body">
  733. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodget_course_id">SloodleCourse::get_course_id()</a> in course.php</div>
  734. <div class="index-item-description">Gets the identifier of the course in the VLE.</div>
  735. </dd>
  736. <dt class="field">
  737. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  738. <span class="method-title">get_course_id</span>
  739. </dt>
  740. <dd class="index-item-body">
  741. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodget_course_id">SloodleRequest::get_course_id()</a> in io.php</div>
  742. <div class="index-item-description">Fetches the course ID request parameter.</div>
  743. </dd>
  744. <dt class="field">
  745. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  746. <span class="method-title">get_course_id</span>
  747. </dt>
  748. <dd class="index-item-body">
  749. <div class="index-item-details"><a href="sloodle/SloodleModuleGlossary.html#methodget_course_id">SloodleModuleGlossary::get_course_id()</a> in module_glossary.php</div>
  750. <div class="index-item-description">Gets the identifier of the course this controller belongs to.</div>
  751. </dd>
  752. <dt class="field">
  753. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  754. <span class="method-title">get_course_id</span>
  755. </dt>
  756. <dd class="index-item-body">
  757. <div class="index-item-details"><a href="sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a> in module_base.php</div>
  758. <div class="index-item-description">Gets the identifier of the course this controller belongs to.</div>
  759. </dd>
  760. <dt class="field">
  761. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  762. <span class="method-title">get_course_module_instance</span>
  763. </dt>
  764. <dd class="index-item-body">
  765. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodget_course_module_instance">SloodleRequest::get_course_module_instance()</a> in io.php</div>
  766. <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>
  767. </dd>
  768. <dt class="field">
  769. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  770. <span class="method-title">get_course_object</span>
  771. </dt>
  772. <dd class="index-item-body">
  773. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodget_course_object">SloodleCourse::get_course_object()</a> in course.php</div>
  774. <div class="index-item-description">Gets the VLE course object.</div>
  775. </dd>
  776. <dt class="field">
  777. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  778. <span class="method-title">get_course_record</span>
  779. </dt>
  780. <dd class="index-item-body">
  781. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodget_course_record">SloodleRequest::get_course_record()</a> in io.php</div>
  782. <div class="index-item-description">Gets a database record for the course identified in the request.</div>
  783. </dd>
  784. <dt class="field">
  785. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  786. <span class="method-title">get_creation_time</span>
  787. </dt>
  788. <dd class="index-item-body">
  789. <div class="index-item-details"><a href="sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a> in module_base.php</div>
  790. <div class="index-item-description">Gets the time at which this instance was created, or 0 if unknown.</div>
  791. </dd>
  792. <dt class="field">
  793. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  794. <span class="method-title">get_creation_time</span>
  795. </dt>
  796. <dd class="index-item-body">
  797. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodget_creation_time">SloodleController::get_creation_time()</a> in controller.php</div>
  798. <div class="index-item-description">Gets the time at which this controller was created.</div>
  799. </dd>
  800. <dt class="field">
  801. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  802. <span class="method-title">get_creation_time</span>
  803. </dt>
  804. <dd class="index-item-body">
  805. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html#methodget_creation_time">SloodleModuleChat::get_creation_time()</a> in module_chat.php</div>
  806. <div class="index-item-description">Gets the time at which this instance was created, or 0 if unknown.</div>
  807. </dd>
  808. <dt class="field">
  809. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  810. <span class="method-title">get_creation_time</span>
  811. </dt>
  812. <dd class="index-item-body">
  813. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methodget_creation_time">SloodleModuleSloodleObject::get_creation_time()</a> in module_sloodleobject.php</div>
  814. <div class="index-item-description">Gets the time at which this instance was created, or 0 if unknown.</div>
  815. </dd>
  816. <dt class="field">
  817. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  818. <span class="method-title">get_creation_time</span>
  819. </dt>
  820. <dd class="index-item-body">
  821. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#methodget_creation_time">SloodleModuleDistributor::get_creation_time()</a> in module_distributor.php</div>
  822. <div class="index-item-description">Gets the time at which this instance was created, or 0 if unknown.</div>
  823. </dd>
  824. <dt class="field">
  825. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  826. <span class="method-title">get_creation_time</span>
  827. </dt>
  828. <dd class="index-item-body">
  829. <div class="index-item-details"><a href="sloodle/SloodleModuleGlossary.html#methodget_creation_time">SloodleModuleGlossary::get_creation_time()</a> in module_glossary.php</div>
  830. <div class="index-item-description">Gets the time at which this instance was created, or 0 if unknown.</div>
  831. </dd>
  832. <dt class="field">
  833. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  834. <span class="method-title">get_enrolled_courses</span>
  835. </dt>
  836. <dd class="index-item-body">
  837. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodget_enrolled_courses">SloodleUser::get_enrolled_courses()</a> in user.php</div>
  838. <div class="index-item-description">Gets a numeric array of <a href="sloodle/SloodleCourse.html">SloodleCourse</a> objects for courses the user is enrolled in.</div>
  839. </dd>
  840. <dt class="field">
  841. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  842. <span class="method-title">get_field_separator</span>
  843. </dt>
  844. <dd class="index-item-body">
  845. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodget_field_separator">SloodleResponse::get_field_separator()</a> in io.php</div>
  846. <div class="index-item-description">Gets the field separator.</div>
  847. </dd>
  848. <dt class="field">
  849. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  850. <span class="method-title">get_full_name</span>
  851. </dt>
  852. <dd class="index-item-body">
  853. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodget_full_name">SloodleCourse::get_full_name()</a> in course.php</div>
  854. <div class="index-item-description">Gets the full name of this course in the VLE.</div>
  855. </dd>
  856. <dt class="field">
  857. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  858. <span class="method-title">get_id</span>
  859. </dt>
  860. <dd class="index-item-body">
  861. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodget_id">SloodleController::get_id()</a> in controller.php</div>
  862. <div class="index-item-description">Gets the site-wide unique identifier for this module.</div>
  863. </dd>
  864. <dt class="field">
  865. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  866. <span class="method-title">get_intro</span>
  867. </dt>
  868. <dd class="index-item-body">
  869. <div class="index-item-details"><a href="sloodle/SloodleModuleGlossary.html#methodget_intro">SloodleModuleGlossary::get_intro()</a> in module_glossary.php</div>
  870. <div class="index-item-description">Gets the intro description of this module instance, if available.</div>
  871. </dd>
  872. <dt class="field">
  873. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  874. <span class="method-title">get_intro</span>
  875. </dt>
  876. <dd class="index-item-body">
  877. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html#methodget_intro">SloodleModuleChat::get_intro()</a> in module_chat.php</div>
  878. <div class="index-item-description">Gets the intro description of this module instance, if available.</div>
  879. </dd>
  880. <dt class="field">
  881. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  882. <span class="method-title">get_intro</span>
  883. </dt>
  884. <dd class="index-item-body">
  885. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#methodget_intro">SloodleModuleDistributor::get_intro()</a> in module_distributor.php</div>
  886. <div class="index-item-description">Gets the intro description of this module instance, if available.</div>
  887. </dd>
  888. <dt class="field">
  889. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  890. <span class="method-title">get_intro</span>
  891. </dt>
  892. <dd class="index-item-body">
  893. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methodget_intro">SloodleModuleSloodleObject::get_intro()</a> in module_sloodleobject.php</div>
  894. <div class="index-item-description">Gets the intro description of this module instance, if available.</div>
  895. </dd>
  896. <dt class="field">
  897. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  898. <span class="method-title">get_intro</span>
  899. </dt>
  900. <dd class="index-item-body">
  901. <div class="index-item-details"><a href="sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a> in module_base.php</div>
  902. <div class="index-item-description">Gets the intro description of this module instance, if available.</div>
  903. </dd>
  904. <dt class="field">
  905. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  906. <span class="method-title">get_intro</span>
  907. </dt>
  908. <dd class="index-item-body">
  909. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodget_intro">SloodleController::get_intro()</a> in controller.php</div>
  910. <div class="index-item-description">Gets the intro description of this controller.</div>
  911. </dd>
  912. <dt class="field">
  913. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  914. <span class="method-title">get_layout_entries</span>
  915. </dt>
  916. <dd class="index-item-body">
  917. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodget_layout_entries">SloodleCourse::get_layout_entries()</a> in course.php</div>
  918. <div class="index-item-description">Gets all the entries in the named layout.</div>
  919. </dd>
  920. <dt class="field">
  921. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  922. <span class="method-title">get_layout_names</span>
  923. </dt>
  924. <dd class="index-item-body">
  925. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodget_layout_names">SloodleCourse::get_layout_names()</a> in course.php</div>
  926. <div class="index-item-description">Gets an array associating layout ID's to names</div>
  927. </dd>
  928. <dt class="field">
  929. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  930. <span class="method-title">get_line_separator</span>
  931. </dt>
  932. <dd class="index-item-body">
  933. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodget_line_separator">SloodleResponse::get_line_separator()</a> in io.php</div>
  934. <div class="index-item-description">Gets the line separator.</div>
  935. </dd>
  936. <dt class="field">
  937. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  938. <span class="method-title">get_loginzone_allocation</span>
  939. </dt>
  940. <dd class="index-item-body">
  941. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodget_loginzone_allocation">SloodleCourse::get_loginzone_allocation()</a> in course.php</div>
  942. <div class="index-item-description">Gets the SLurl for the specified user's loginzone alloation</div>
  943. </dd>
  944. <dt class="field">
  945. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  946. <span class="method-title">get_loginzone_position</span>
  947. </dt>
  948. <dd class="index-item-body">
  949. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodget_loginzone_position">SloodleCourse::get_loginzone_position()</a> in course.php</div>
  950. <div class="index-item-description">Gets the position of the loginzone as a string vector &lt;x,y,z&gt;</div>
  951. </dd>
  952. <dt class="field">
  953. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  954. <span class="method-title">get_loginzone_region</span>
  955. </dt>
  956. <dd class="index-item-body">
  957. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodget_loginzone_region">SloodleCourse::get_loginzone_region()</a> in course.php</div>
  958. <div class="index-item-description">Gets the region of the loginzone</div>
  959. </dd>
  960. <dt class="field">
  961. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  962. <span class="method-title">get_loginzone_size</span>
  963. </dt>
  964. <dd class="index-item-body">
  965. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodget_loginzone_size">SloodleCourse::get_loginzone_size()</a> in course.php</div>
  966. <div class="index-item-description">Gets the size of the loginzone as a string vector &lt;x,y,z&gt;</div>
  967. </dd>
  968. <dt class="field">
  969. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  970. <span class="method-title">get_loginzone_time_updated</span>
  971. </dt>
  972. <dd class="index-item-body">
  973. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodget_loginzone_time_updated">SloodleCourse::get_loginzone_time_updated()</a> in course.php</div>
  974. <div class="index-item-description">Gets the timestamp of the last time the loginzone was updated</div>
  975. </dd>
  976. <dt class="field">
  977. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  978. <span class="method-title">get_modification_time</span>
  979. </dt>
  980. <dd class="index-item-body">
  981. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html#methodget_modification_time">SloodleModuleChat::get_modification_time()</a> in module_chat.php</div>
  982. <div class="index-item-description">Gets the time at which this instance was last modified, or 0 if unknown.</div>
  983. </dd>
  984. <dt class="field">
  985. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  986. <span class="method-title">get_modification_time</span>
  987. </dt>
  988. <dd class="index-item-body">
  989. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#methodget_modification_time">SloodleModuleDistributor::get_modification_time()</a> in module_distributor.php</div>
  990. <div class="index-item-description">Gets the time at which this instance was last modified, or 0 if unknown.</div>
  991. </dd>
  992. <dt class="field">
  993. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  994. <span class="method-title">get_modification_time</span>
  995. </dt>
  996. <dd class="index-item-body">
  997. <div class="index-item-details"><a href="sloodle/SloodleModuleGlossary.html#methodget_modification_time">SloodleModuleGlossary::get_modification_time()</a> in module_glossary.php</div>
  998. <div class="index-item-description">Gets the time at which this instance was last modified, or 0 if unknown.</div>
  999. </dd>
  1000. <dt class="field">
  1001. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1002. <span class="method-title">get_modification_time</span>
  1003. </dt>
  1004. <dd class="index-item-body">
  1005. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methodget_modification_time">SloodleModuleSloodleObject::get_modification_time()</a> in module_sloodleobject.php</div>
  1006. <div class="index-item-description">Gets the time at which this instance was last modified, or 0 if unknown.</div>
  1007. </dd>
  1008. <dt class="field">
  1009. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1010. <span class="method-title">get_modification_time</span>
  1011. </dt>
  1012. <dd class="index-item-body">
  1013. <div class="index-item-details"><a href="sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a> in module_base.php</div>
  1014. <div class="index-item-description">Gets the time at which this instance was last modified, or 0 if unknown.</div>
  1015. </dd>
  1016. <dt class="field">
  1017. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1018. <span class="method-title">get_modification_time</span>
  1019. </dt>
  1020. <dd class="index-item-body">
  1021. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodget_modification_time">SloodleController::get_modification_time()</a> in controller.php</div>
  1022. <div class="index-item-description">Gets the time at which this controller was last modified.</div>
  1023. </dd>
  1024. <dt class="field">
  1025. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1026. <span class="method-title">get_module_id</span>
  1027. </dt>
  1028. <dd class="index-item-body">
  1029. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodget_module_id">SloodleRequest::get_module_id()</a> in io.php</div>
  1030. <div class="index-item-description">Fetches the module ID request parameter.</div>
  1031. </dd>
  1032. <dt class="field">
  1033. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1034. <span class="method-title">get_name</span>
  1035. </dt>
  1036. <dd class="index-item-body">
  1037. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methodget_name">SloodleModuleSloodleObject::get_name()</a> in module_sloodleobject.php</div>
  1038. <div class="index-item-description">Gets the name of this module instance.</div>
  1039. </dd>
  1040. <dt class="field">
  1041. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1042. <span class="method-title">get_name</span>
  1043. </dt>
  1044. <dd class="index-item-body">
  1045. <div class="index-item-details"><a href="sloodle/SloodleModuleGlossary.html#methodget_name">SloodleModuleGlossary::get_name()</a> in module_glossary.php</div>
  1046. <div class="index-item-description">Gets the name of this module instance.</div>
  1047. </dd>
  1048. <dt class="field">
  1049. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1050. <span class="method-title">get_name</span>
  1051. </dt>
  1052. <dd class="index-item-body">
  1053. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#methodget_name">SloodleModuleDistributor::get_name()</a> in module_distributor.php</div>
  1054. <div class="index-item-description">Gets the name of this module instance.</div>
  1055. </dd>
  1056. <dt class="field">
  1057. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1058. <span class="method-title">get_name</span>
  1059. </dt>
  1060. <dd class="index-item-body">
  1061. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodget_name">SloodleController::get_name()</a> in controller.php</div>
  1062. <div class="index-item-description">Gets the name of this controller.</div>
  1063. </dd>
  1064. <dt class="field">
  1065. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1066. <span class="method-title">get_name</span>
  1067. </dt>
  1068. <dd class="index-item-body">
  1069. <div class="index-item-details"><a href="sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a> in module_base.php</div>
  1070. <div class="index-item-description">Gets the name of this module instance.</div>
  1071. </dd>
  1072. <dt class="field">
  1073. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1074. <span class="method-title">get_name</span>
  1075. </dt>
  1076. <dd class="index-item-body">
  1077. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html#methodget_name">SloodleModuleChat::get_name()</a> in module_chat.php</div>
  1078. <div class="index-item-description">Gets the name of this module instance.</div>
  1079. </dd>
  1080. <dt class="field">
  1081. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1082. <span class="method-title">get_object</span>
  1083. </dt>
  1084. <dd class="index-item-body">
  1085. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodget_object">SloodleController::get_object()</a> in controller.php</div>
  1086. <div class="index-item-description">Gets data about an active object.</div>
  1087. </dd>
  1088. <dt class="field">
  1089. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1090. <span class="method-title">get_objects</span>
  1091. </dt>
  1092. <dd class="index-item-body">
  1093. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#methodget_objects">SloodleModuleDistributor::get_objects()</a> in module_distributor.php</div>
  1094. <div class="index-item-description">Gets a list of all objects for this Distributor.</div>
  1095. </dd>
  1096. <dt class="field">
  1097. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1098. <span class="method-title">get_object_configuration</span>
  1099. </dt>
  1100. <dd class="index-item-body">
  1101. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodget_object_configuration">SloodleController::get_object_configuration()</a> in controller.php</div>
  1102. <div class="index-item-description">Gets an array of object configuration settings.</div>
  1103. </dd>
  1104. <dt class="field">
  1105. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1106. <span class="method-title">get_param</span>
  1107. </dt>
  1108. <dd class="index-item-body">
  1109. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodget_param">SloodleRequest::get_param()</a> in io.php</div>
  1110. <div class="index-item-description">Obtains a named HTTP request parameter, optionally requiring it or not</div>
  1111. </dd>
  1112. <dt class="field">
  1113. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1114. <span class="method-title">get_password</span>
  1115. </dt>
  1116. <dd class="index-item-body">
  1117. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodget_password">SloodleRequest::get_password()</a> in io.php</div>
  1118. <div class="index-item-description">Fetches the password request parameter.</div>
  1119. </dd>
  1120. <dt class="field">
  1121. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1122. <span class="method-title">get_password</span>
  1123. </dt>
  1124. <dd class="index-item-body">
  1125. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodget_password">SloodleController::get_password()</a> in controller.php</div>
  1126. <div class="index-item-description">Gets the prim password of this controller.</div>
  1127. </dd>
  1128. <dt class="field">
  1129. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1130. <span class="method-title">get_request_descriptor</span>
  1131. </dt>
  1132. <dd class="index-item-body">
  1133. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodget_request_descriptor">SloodleRequest::get_request_descriptor()</a> in io.php</div>
  1134. <div class="index-item-description">Fetches the request descriptor request parameter.</div>
  1135. </dd>
  1136. <dt class="field">
  1137. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1138. <span class="method-title">get_server_access_level</span>
  1139. </dt>
  1140. <dd class="index-item-body">
  1141. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodget_server_access_level">SloodleRequest::get_server_access_level()</a> in io.php</div>
  1142. <div class="index-item-description">Fetches the server access level parameter, if specified.</div>
  1143. </dd>
  1144. <dt class="field">
  1145. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1146. <span class="method-title">get_short_name</span>
  1147. </dt>
  1148. <dd class="index-item-body">
  1149. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodget_short_name">SloodleCourse::get_short_name()</a> in course.php</div>
  1150. <div class="index-item-description">Gets the short name of this course in the VLE.</div>
  1151. </dd>
  1152. <dt class="field">
  1153. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1154. <span class="method-title">get_staff_courses</span>
  1155. </dt>
  1156. <dd class="index-item-body">
  1157. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodget_staff_courses">SloodleUser::get_staff_courses()</a> in user.php</div>
  1158. <div class="index-item-description">Gets a numeric array of <a href="sloodle/SloodleCourse.html">SloodleCourse</a> objects for courses the user is Sloodle staff.</div>
  1159. </dd>
  1160. <dt class="field">
  1161. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1162. <span class="method-title">get_type</span>
  1163. </dt>
  1164. <dd class="index-item-body">
  1165. <div class="index-item-details"><a href="sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a> in module_base.php</div>
  1166. <div class="index-item-description">Gets the short type name of this instance.</div>
  1167. </dd>
  1168. <dt class="field">
  1169. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1170. <span class="method-title">get_type</span>
  1171. </dt>
  1172. <dd class="index-item-body">
  1173. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#methodget_type">SloodleModuleDistributor::get_type()</a> in module_distributor.php</div>
  1174. <div class="index-item-description">Gets the short type name of this instance.</div>
  1175. </dd>
  1176. <dt class="field">
  1177. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1178. <span class="method-title">get_type</span>
  1179. </dt>
  1180. <dd class="index-item-body">
  1181. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html#methodget_type">SloodleModuleChat::get_type()</a> in module_chat.php</div>
  1182. <div class="index-item-description">Gets the short type name of this instance.</div>
  1183. </dd>
  1184. <dt class="field">
  1185. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1186. <span class="method-title">get_type</span>
  1187. </dt>
  1188. <dd class="index-item-body">
  1189. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methodget_type">SloodleModuleSloodleObject::get_type()</a> in module_sloodleobject.php</div>
  1190. <div class="index-item-description">Gets the short type name of this instance.</div>
  1191. </dd>
  1192. <dt class="field">
  1193. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1194. <span class="method-title">get_type</span>
  1195. </dt>
  1196. <dd class="index-item-body">
  1197. <div class="index-item-details"><a href="sloodle/SloodleModuleGlossary.html#methodget_type">SloodleModuleGlossary::get_type()</a> in module_glossary.php</div>
  1198. <div class="index-item-description">Gets the short type name of this instance.</div>
  1199. </dd>
  1200. <dt class="field">
  1201. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1202. <span class="method-title">get_type_full</span>
  1203. </dt>
  1204. <dd class="index-item-body">
  1205. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methodget_type_full">SloodleModuleSloodleObject::get_type_full()</a> in module_sloodleobject.php</div>
  1206. <div class="index-item-description">Gets the full type name of this instance, according to the current language pack, if available.</div>
  1207. </dd>
  1208. <dt class="field">
  1209. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1210. <span class="method-title">get_type_full</span>
  1211. </dt>
  1212. <dd class="index-item-body">
  1213. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#methodget_type_full">SloodleModuleDistributor::get_type_full()</a> in module_distributor.php</div>
  1214. <div class="index-item-description">Gets the full type name of this instance, according to the current language pack, if available.</div>
  1215. </dd>
  1216. <dt class="field">
  1217. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1218. <span class="method-title">get_type_full</span>
  1219. </dt>
  1220. <dd class="index-item-body">
  1221. <div class="index-item-details"><a href="sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a> in module_base.php</div>
  1222. <div class="index-item-description">Gets the full type name of this instance, according to the current language pack, if available.</div>
  1223. </dd>
  1224. <dt class="field">
  1225. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1226. <span class="method-title">get_type_full</span>
  1227. </dt>
  1228. <dd class="index-item-body">
  1229. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html#methodget_type_full">SloodleModuleChat::get_type_full()</a> in module_chat.php</div>
  1230. <div class="index-item-description">Gets the full type name of this instance, according to the current language pack, if available.</div>
  1231. </dd>
  1232. <dt class="field">
  1233. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1234. <span class="method-title">get_type_full</span>
  1235. </dt>
  1236. <dd class="index-item-body">
  1237. <div class="index-item-details"><a href="sloodle/SloodleModuleGlossary.html#methodget_type_full">SloodleModuleGlossary::get_type_full()</a> in module_glossary.php</div>
  1238. <div class="index-item-description">Gets the full type name of this instance, according to the current language pack, if available.</div>
  1239. </dd>
  1240. <dt class="field">
  1241. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1242. <span class="method-title">get_username</span>
  1243. </dt>
  1244. <dd class="index-item-body">
  1245. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodget_username">SloodleUser::get_username()</a> in user.php</div>
  1246. <div class="index-item-description">Gets the user's username</div>
  1247. </dd>
  1248. <dt class="field">
  1249. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1250. <span class="method-title">get_user_email</span>
  1251. </dt>
  1252. <dd class="index-item-body">
  1253. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodget_user_email">SloodleUser::get_user_email()</a> in user.php</div>
  1254. <div class="index-item-description">Gets the user's email address.</div>
  1255. </dd>
  1256. <dt class="field">
  1257. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1258. <span class="method-title">get_user_firstname</span>
  1259. </dt>
  1260. <dd class="index-item-body">
  1261. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodget_user_firstname">SloodleUser::get_user_firstname()</a> in user.php</div>
  1262. <div class="index-item-description">Gets the first name of the user</div>
  1263. </dd>
  1264. <dt class="field">
  1265. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1266. <span class="method-title">get_user_id</span>
  1267. </dt>
  1268. <dd class="index-item-body">
  1269. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodget_user_id">SloodleUser::get_user_id()</a> in user.php</div>
  1270. <div class="index-item-description">Gets the unique ID of the VLE user.</div>
  1271. </dd>
  1272. <dt class="field">
  1273. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1274. <span class="method-title">get_user_lastname</span>
  1275. </dt>
  1276. <dd class="index-item-body">
  1277. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodget_user_lastname">SloodleUser::get_user_lastname()</a> in user.php</div>
  1278. <div class="index-item-description">Gets the last name of the user</div>
  1279. </dd>
  1280. <dt class="field">
  1281. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1282. <span class="method-title">get_x</span>
  1283. </dt>
  1284. <dd class="index-item-body">
  1285. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html#methodget_x">assignment_sloodleobject_submission::get_x()</a> in assignment.class.php</div>
  1286. <div class="index-item-description">Gets the X coordinate of the position</div>
  1287. </dd>
  1288. <dt class="field">
  1289. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1290. <span class="method-title">get_y</span>
  1291. </dt>
  1292. <dd class="index-item-body">
  1293. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html#methodget_y">assignment_sloodleobject_submission::get_y()</a> in assignment.class.php</div>
  1294. <div class="index-item-description">Gets the Y coordinate of the position</div>
  1295. </dd>
  1296. <dt class="field">
  1297. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1298. <span class="method-title">get_z</span>
  1299. </dt>
  1300. <dd class="index-item-body">
  1301. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html#methodget_z">assignment_sloodleobject_submission::get_z()</a> in assignment.class.php</div>
  1302. <div class="index-item-description">Gets the Z coordinate of the position</div>
  1303. </dd>
  1304. <dt class="field">
  1305. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1306. <span class="include-title">general.php</span>
  1307. </dt>
  1308. <dd class="index-item-body">
  1309. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html">general.php</a> in general.php</div>
  1310. </dd>
  1311. </dl>
  1312. <a name="h"></a>
  1313. <div class="index-letter-section">
  1314. <div style="float: left" class="index-letter-title">h</div>
  1315. <div style="float: right"><a href="#top">top</a></div>
  1316. <div style="clear: both"></div>
  1317. </div>
  1318. <dl>
  1319. <dt class="field">
  1320. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1321. <span class="method-title">has_config</span>
  1322. </dt>
  1323. <dd class="index-item-body">
  1324. <div class="index-item-details"><a href="sloodle/block_sloodle_menu.html#methodhas_config">block_sloodle_menu::has_config()</a> in block_sloodle_menu.php</div>
  1325. <div class="index-item-description">Indicates whether or not this module has a global configuration page.</div>
  1326. </dd>
  1327. <dt class="field">
  1328. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1329. <span class="method-title">has_loginzone_data</span>
  1330. </dt>
  1331. <dd class="index-item-body">
  1332. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodhas_loginzone_data">SloodleCourse::has_loginzone_data()</a> in course.php</div>
  1333. <div class="index-item-description">Determines whether or not LoginZone data exists for this course.</div>
  1334. </dd>
  1335. <dt class="field">
  1336. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1337. <span class="method-title">hide_header</span>
  1338. </dt>
  1339. <dd class="index-item-body">
  1340. <div class="index-item-details"><a href="sloodle/block_sloodle_menu.html#methodhide_header">block_sloodle_menu::hide_header()</a> in block_sloodle_menu.php</div>
  1341. <div class="index-item-description">Indicates whether or not to hide the header of this block.</div>
  1342. </dd>
  1343. </dl>
  1344. <a name="i"></a>
  1345. <div class="index-letter-section">
  1346. <div style="float: left" class="index-letter-title">i</div>
  1347. <div style="float: right"><a href="#top">top</a></div>
  1348. <div style="clear: both"></div>
  1349. </div>
  1350. <dl>
  1351. <dt class="field">
  1352. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1353. <span class="var-title">$id</span>
  1354. </dt>
  1355. <dd class="index-item-body">
  1356. <div class="index-item-details"><a href="sloodle/SloodleGlossaryEntry.html#var$id">SloodleGlossaryEntry::$id</a> in module_glossary.php</div>
  1357. <div class="index-item-description">The ID of the entry.</div>
  1358. </dd>
  1359. <dt class="field">
  1360. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1361. <span class="var-title">$id</span>
  1362. </dt>
  1363. <dd class="index-item-body">
  1364. <div class="index-item-details"><a href="sloodle/SloodleChatMessage.html#var$id">SloodleChatMessage::$id</a> in module_chat.php</div>
  1365. <div class="index-item-description">The ID of the message.</div>
  1366. </dd>
  1367. <dt class="field">
  1368. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1369. <span class="var-title">$is_loaded</span>
  1370. </dt>
  1371. <dd class="index-item-body">
  1372. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html#var$is_loaded">assignment_sloodleobject_submission::$is_loaded</a> in assignment.class.php</div>
  1373. <div class="index-item-description">Indicates whether or not a submission is loaded</div>
  1374. </dd>
  1375. <dt class="field">
  1376. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1377. <span class="method-title">init</span>
  1378. </dt>
  1379. <dd class="index-item-body">
  1380. <div class="index-item-details"><a href="sloodle/block_sloodle_menu.html#methodinit">block_sloodle_menu::init()</a> in block_sloodle_menu.php</div>
  1381. <div class="index-item-description">Perform block initialisation.</div>
  1382. </dd>
  1383. <dt class="field">
  1384. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1385. <span class="method-title">is_available</span>
  1386. </dt>
  1387. <dd class="index-item-body">
  1388. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodis_available">SloodleCourse::is_available()</a> in course.php</div>
  1389. <div class="index-item-description">Determines whether or not the course is available.</div>
  1390. </dd>
  1391. <dt class="field">
  1392. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1393. <span class="method-title">is_available</span>
  1394. </dt>
  1395. <dd class="index-item-body">
  1396. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodis_available">SloodleController::is_available()</a> in controller.php</div>
  1397. <div class="index-item-description">Determines whether or not this controller is available (i.e. not hidden).</div>
  1398. </dd>
  1399. <dt class="field">
  1400. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1401. <span class="method-title">is_avatar_linked</span>
  1402. </dt>
  1403. <dd class="index-item-body">
  1404. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodis_avatar_linked">SloodleUser::is_avatar_linked()</a> in user.php</div>
  1405. <div class="index-item-description">Determines whether or not the current user and avatar are linked.</div>
  1406. </dd>
  1407. <dt class="field">
  1408. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1409. <span class="method-title">is_avatar_loaded</span>
  1410. </dt>
  1411. <dd class="index-item-body">
  1412. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodis_avatar_loaded">SloodleUser::is_avatar_loaded()</a> in user.php</div>
  1413. <div class="index-item-description">Determines whether or not an avatar is loaded.</div>
  1414. </dd>
  1415. <dt class="field">
  1416. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1417. <span class="method-title">is_enabled</span>
  1418. </dt>
  1419. <dd class="index-item-body">
  1420. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodis_enabled">SloodleController::is_enabled()</a> in controller.php</div>
  1421. <div class="index-item-description">Determines if this controller is enabled or not.</div>
  1422. </dd>
  1423. <dt class="field">
  1424. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1425. <span class="method-title">is_enrolled</span>
  1426. </dt>
  1427. <dd class="index-item-body">
  1428. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodis_enrolled">SloodleUser::is_enrolled()</a> in user.php</div>
  1429. <div class="index-item-description">Is the current user enrolled in the specified course?</div>
  1430. </dd>
  1431. <dt class="field">
  1432. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1433. <span class="method-title">is_loaded</span>
  1434. </dt>
  1435. <dd class="index-item-body">
  1436. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodis_loaded">SloodleCourse::is_loaded()</a> in course.php</div>
  1437. <div class="index-item-description">Determines whether or not course data has been loaded.</div>
  1438. </dd>
  1439. <dt class="field">
  1440. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1441. <span class="method-title">is_loaded</span>
  1442. </dt>
  1443. <dd class="index-item-body">
  1444. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodis_loaded">SloodleController::is_loaded()</a> in controller.php</div>
  1445. <div class="index-item-description">Determines whether or not this controller is loaded.</div>
  1446. </dd>
  1447. <dt class="field">
  1448. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1449. <span class="method-title">is_object_request</span>
  1450. </dt>
  1451. <dd class="index-item-body">
  1452. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodis_object_request">SloodleRequest::is_object_request()</a> in io.php</div>
  1453. <div class="index-item-description">Checks the parameters to determine if the request relates to an object rather than a user</div>
  1454. </dd>
  1455. <dt class="field">
  1456. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1457. <span class="method-title">is_request_data_processed</span>
  1458. </dt>
  1459. <dd class="index-item-body">
  1460. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodis_request_data_processed">SloodleRequest::is_request_data_processed()</a> in io.php</div>
  1461. <div class="index-item-description">Checks whether or not the request data has already been processed.</div>
  1462. </dd>
  1463. <dt class="field">
  1464. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1465. <span class="method-title">is_staff</span>
  1466. </dt>
  1467. <dd class="index-item-body">
  1468. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodis_staff">SloodleUser::is_staff()</a> in user.php</div>
  1469. <div class="index-item-description">Is the current user Sloodle staff in the specified course?</div>
  1470. </dd>
  1471. <dt class="field">
  1472. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1473. <span class="method-title">is_too_early</span>
  1474. </dt>
  1475. <dd class="index-item-body">
  1476. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methodis_too_early">SloodleModuleSloodleObject::is_too_early()</a> in module_sloodleobject.php</div>
  1477. <div class="index-item-description">Checks if an assignment submitted at the specified time would be too early for submission.</div>
  1478. </dd>
  1479. <dt class="field">
  1480. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1481. <span class="method-title">is_too_late</span>
  1482. </dt>
  1483. <dd class="index-item-body">
  1484. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methodis_too_late">SloodleModuleSloodleObject::is_too_late()</a> in module_sloodleobject.php</div>
  1485. <div class="index-item-description">Checks if an assignment submitted at the specified time would be too late for submission.</div>
  1486. </dd>
  1487. <dt class="field">
  1488. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1489. <span class="method-title">is_user_enrolled_by_request</span>
  1490. </dt>
  1491. <dd class="index-item-body">
  1492. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#methodis_user_enrolled_by_request">SloodleLSLHandler::is_user_enrolled_by_request()</a> in lsl.php</div>
  1493. <div class="index-item-description">Checks that a user is enrolled in a course, based on request data.</div>
  1494. </dd>
  1495. <dt class="field">
  1496. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1497. <span class="method-title">is_user_loaded</span>
  1498. </dt>
  1499. <dd class="index-item-body">
  1500. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodis_user_loaded">SloodleUser::is_user_loaded()</a> in user.php</div>
  1501. <div class="index-item-description">Determines whether or not a VLE user is loaded.</div>
  1502. </dd>
  1503. <dt class="field">
  1504. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1505. <span class="include-title">index.php</span>
  1506. </dt>
  1507. <dd class="index-item-body">
  1508. <div class="index-item-details"><a href="sloodle/_sloodle---index.php.html">index.php</a> in index.php</div>
  1509. </dd>
  1510. <dt class="field">
  1511. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1512. <span class="include-title">io.php</span>
  1513. </dt>
  1514. <dd class="index-item-body">
  1515. <div class="index-item-details"><a href="sloodle/_sloodle---lib---io.php.html">io.php</a> in io.php</div>
  1516. </dd>
  1517. </dl>
  1518. <a name="l"></a>
  1519. <div class="index-letter-section">
  1520. <div style="float: left" class="index-letter-title">l</div>
  1521. <div style="float: right"><a href="#top">top</a></div>
  1522. <div style="clear: both"></div>
  1523. </div>
  1524. <dl>
  1525. <dt class="field">
  1526. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  1527. <span class="var-title">$line_separator</span>
  1528. </dt>
  1529. <dd class="index-item-body">
  1530. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#var$line_separator">SloodleResponse::$line_separator</a> in io.php</div>
  1531. <div class="index-item-description">The separation string between lines of the response (typically just a newline).</div>
  1532. </dd>
  1533. <dt class="field">
  1534. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1535. <span class="method-title">link_avatar</span>
  1536. </dt>
  1537. <dd class="index-item-body">
  1538. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodlink_avatar">SloodleUser::link_avatar()</a> in user.php</div>
  1539. <div class="index-item-description">Links the current avatar to the current user.</div>
  1540. </dd>
  1541. <dt class="field">
  1542. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1543. <span class="method-title">load</span>
  1544. </dt>
  1545. <dd class="index-item-body">
  1546. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#methodload">SloodleModuleDistributor::load()</a> in module_distributor.php</div>
  1547. <div class="index-item-description">Loads data from the database.</div>
  1548. </dd>
  1549. <dt class="field">
  1550. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1551. <span class="method-title">load</span>
  1552. </dt>
  1553. <dd class="index-item-body">
  1554. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html#methodload">SloodleModuleChat::load()</a> in module_chat.php</div>
  1555. <div class="index-item-description">Loads data from the database.</div>
  1556. </dd>
  1557. <dt class="field">
  1558. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1559. <span class="method-title">load</span>
  1560. </dt>
  1561. <dd class="index-item-body">
  1562. <div class="index-item-details"><a href="sloodle/SloodleModule.html#methodload">SloodleModule::load()</a> in module_base.php</div>
  1563. <div class="index-item-description">Loads data from the database.</div>
  1564. </dd>
  1565. <dt class="field">
  1566. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1567. <span class="method-title">load</span>
  1568. </dt>
  1569. <dd class="index-item-body">
  1570. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodload">SloodleController::load()</a> in controller.php</div>
  1571. <div class="index-item-description">Loads data from the database.</div>
  1572. </dd>
  1573. <dt class="field">
  1574. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1575. <span class="method-title">load</span>
  1576. </dt>
  1577. <dd class="index-item-body">
  1578. <div class="index-item-details"><a href="sloodle/SloodleModuleGlossary.html#methodload">SloodleModuleGlossary::load()</a> in module_glossary.php</div>
  1579. <div class="index-item-description">Loads data from the database.</div>
  1580. </dd>
  1581. <dt class="field">
  1582. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1583. <span class="method-title">load</span>
  1584. </dt>
  1585. <dd class="index-item-body">
  1586. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methodload">SloodleModuleSloodleObject::load()</a> in module_sloodleobject.php</div>
  1587. <div class="index-item-description">Loads data from the database.</div>
  1588. </dd>
  1589. <dt class="field">
  1590. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1591. <span class="method-title">load</span>
  1592. </dt>
  1593. <dd class="index-item-body">
  1594. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodload">SloodleCourse::load()</a> in course.php</div>
  1595. <div class="index-item-description">Reads fresh data into the structure from the database.</div>
  1596. </dd>
  1597. <dt class="field">
  1598. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1599. <span class="method-title">load_avatar</span>
  1600. </dt>
  1601. <dd class="index-item-body">
  1602. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodload_avatar">SloodleUser::load_avatar()</a> in user.php</div>
  1603. <div class="index-item-description">Finds an avatar with the given UUID and/or name, and loads its data.</div>
  1604. </dd>
  1605. <dt class="field">
  1606. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1607. <span class="method-title">load_avatar_by_id</span>
  1608. </dt>
  1609. <dd class="index-item-body">
  1610. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodload_avatar_by_id">SloodleUser::load_avatar_by_id()</a> in user.php</div>
  1611. <div class="index-item-description">Loads the specified avatar from the database.</div>
  1612. </dd>
  1613. <dt class="field">
  1614. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1615. <span class="method-title">load_by_controller</span>
  1616. </dt>
  1617. <dd class="index-item-body">
  1618. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodload_by_controller">SloodleCourse::load_by_controller()</a> in course.php</div>
  1619. <div class="index-item-description">Loads course and controller data by the unqiue site-wide identifier of a Sloodle controller.</div>
  1620. </dd>
  1621. <dt class="field">
  1622. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1623. <span class="method-title">load_linked_avatar</span>
  1624. </dt>
  1625. <dd class="index-item-body">
  1626. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodload_linked_avatar">SloodleUser::load_linked_avatar()</a> in user.php</div>
  1627. <div class="index-item-description">Load the avatar linked to the current user.</div>
  1628. </dd>
  1629. <dt class="field">
  1630. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1631. <span class="method-title">load_linked_user</span>
  1632. </dt>
  1633. <dd class="index-item-body">
  1634. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodload_linked_user">SloodleUser::load_linked_user()</a> in user.php</div>
  1635. <div class="index-item-description">Find the VLE user linked to the current avatar.</div>
  1636. </dd>
  1637. <dt class="field">
  1638. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1639. <span class="method-title">load_module</span>
  1640. </dt>
  1641. <dd class="index-item-body">
  1642. <div class="index-item-details"><a href="sloodle/SloodleSession.html#methodload_module">SloodleSession::load_module()</a> in sloodle_session.php</div>
  1643. <div class="index-item-description">Constructs and loads the appropriate module part of the session.</div>
  1644. </dd>
  1645. <dt class="field">
  1646. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1647. <span class="method-title">load_submission</span>
  1648. </dt>
  1649. <dd class="index-item-body">
  1650. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html#methodload_submission">assignment_sloodleobject_submission::load_submission()</a> in assignment.class.php</div>
  1651. <div class="index-item-description">Parses the data from a Submission database record object.</div>
  1652. </dd>
  1653. <dt class="field">
  1654. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1655. <span class="method-title">load_user</span>
  1656. </dt>
  1657. <dd class="index-item-body">
  1658. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodload_user">SloodleUser::load_user()</a> in user.php</div>
  1659. <div class="index-item-description">Load the specified user from the database</div>
  1660. </dd>
  1661. <dt class="field">
  1662. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1663. <span class="method-title">load_user_by_loginzone</span>
  1664. </dt>
  1665. <dd class="index-item-body">
  1666. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodload_user_by_loginzone">SloodleCourse::load_user_by_loginzone()</a> in course.php</div>
  1667. <div class="index-item-description">Finds the user identified by LoginZone allocation, and loads it into the given user object.</div>
  1668. </dd>
  1669. <dt class="field">
  1670. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1671. <span class="method-title">login</span>
  1672. </dt>
  1673. <dd class="index-item-body">
  1674. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodlogin">SloodleUser::login()</a> in user.php</div>
  1675. <div class="index-item-description">Internally 'log-in' the current user.</div>
  1676. </dd>
  1677. <dt class="field">
  1678. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1679. <span class="method-title">login_by_request</span>
  1680. </dt>
  1681. <dd class="index-item-body">
  1682. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#methodlogin_by_request">SloodleLSLHandler::login_by_request()</a> in lsl.php</div>
  1683. <div class="index-item-description">Performs an internal 'login' based on user identified in request.</div>
  1684. </dd>
  1685. <dt class="field">
  1686. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1687. <span class="include-title">loginzone.php</span>
  1688. </dt>
  1689. <dd class="index-item-body">
  1690. <div class="index-item-details"><a href="sloodle/_sloodle---classroom---loginzone.php.html">loginzone.php</a> in loginzone.php</div>
  1691. </dd>
  1692. <dt class="field">
  1693. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1694. <span class="include-title">layout_profile.php</span>
  1695. </dt>
  1696. <dd class="index-item-body">
  1697. <div class="index-item-details"><a href="sloodle/_sloodle---lib---layout_profile.php.html">layout_profile.php</a> in layout_profile.php</div>
  1698. </dd>
  1699. <dt class="field">
  1700. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1701. <span class="include-title">lsl.php</span>
  1702. </dt>
  1703. <dd class="index-item-body">
  1704. <div class="index-item-details"><a href="sloodle/_sloodle---lib---lsl.php.html">lsl.php</a> in lsl.php</div>
  1705. </dd>
  1706. <dt class="field">
  1707. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1708. <span class="include-title">lib.php</span>
  1709. </dt>
  1710. <dd class="index-item-body">
  1711. <div class="index-item-details"><a href="sloodle/_sloodle---lib.php.html">lib.php</a> in lib.php</div>
  1712. </dd>
  1713. <dt class="field">
  1714. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1715. <span class="include-title">linker.php</span>
  1716. </dt>
  1717. <dd class="index-item-body">
  1718. <div class="index-item-details"><a href="sloodle/_sloodle---mod---distributor-1.0---linker.php.html">linker.php</a> in linker.php</div>
  1719. </dd>
  1720. <dt class="field">
  1721. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1722. <span class="include-title">linker.php</span>
  1723. </dt>
  1724. <dd class="index-item-body">
  1725. <div class="index-item-details"><a href="sloodle/_sloodle---mod---quiz-1.0---linker.php.html">linker.php</a> in linker.php</div>
  1726. </dd>
  1727. <dt class="field">
  1728. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1729. <span class="include-title">layout_linker.php</span>
  1730. </dt>
  1731. <dd class="index-item-body">
  1732. <div class="index-item-details"><a href="sloodle/_sloodle---mod---set-1.0---layout_linker.php.html">layout_linker.php</a> in layout_linker.php</div>
  1733. </dd>
  1734. </dl>
  1735. <a name="m"></a>
  1736. <div class="index-letter-section">
  1737. <div style="float: left" class="index-letter-title">m</div>
  1738. <div style="float: right"><a href="#top">top</a></div>
  1739. <div style="clear: both"></div>
  1740. </div>
  1741. <dl>
  1742. <dt class="field">
  1743. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1744. <span class="var-title">$message</span>
  1745. </dt>
  1746. <dd class="index-item-body">
  1747. <div class="index-item-details"><a href="sloodle/SloodleChatMessage.html#var$message">SloodleChatMessage::$message</a> in module_chat.php</div>
  1748. <div class="index-item-description">The text of the message.</div>
  1749. </dd>
  1750. <dt class="field">
  1751. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1752. <span class="var-title">$module</span>
  1753. </dt>
  1754. <dd class="index-item-body">
  1755. <div class="index-item-details"><a href="sloodle/SloodleSession.html#var$module">SloodleSession::$module</a> in sloodle_session.php</div>
  1756. <div class="index-item-description">The Sloodle module this session relates to, if any.</div>
  1757. </dd>
  1758. <dt class="field">
  1759. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  1760. <span class="var-title">$moodle_assignment_instance</span>
  1761. </dt>
  1762. <dd class="index-item-body">
  1763. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#var$moodle_assignment_instance">SloodleModuleSloodleObject::$moodle_assignment_instance</a> in module_sloodleobject.php</div>
  1764. <div class="index-item-description">Internal only - Moodle assignment module instance database object.</div>
  1765. </dd>
  1766. <dt class="field">
  1767. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  1768. <span class="var-title">$moodle_chat_instance</span>
  1769. </dt>
  1770. <dd class="index-item-body">
  1771. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html#var$moodle_chat_instance">SloodleModuleChat::$moodle_chat_instance</a> in module_chat.php</div>
  1772. <div class="index-item-description">Internal only - Moodle chat module instance database object.</div>
  1773. </dd>
  1774. <dt class="field">
  1775. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  1776. <span class="var-title">$moodle_glossary_instance</span>
  1777. </dt>
  1778. <dd class="index-item-body">
  1779. <div class="index-item-details"><a href="sloodle/SloodleModuleGlossary.html#var$moodle_glossary_instance">SloodleModuleGlossary::$moodle_glossary_instance</a> in module_glossary.php</div>
  1780. <div class="index-item-description">Internal only - Moodle glossary module instance database object.</div>
  1781. </dd>
  1782. <dt class="field">
  1783. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  1784. mod_sloodle_mod_form
  1785. </dt>
  1786. <dd class="index-item-body">
  1787. <div class="index-item-details"><a href="sloodle/mod_sloodle_mod_form.html">mod_sloodle_mod_form</a> in mod_form.php</div>
  1788. <div class="index-item-description">Used to define the Sloodle module instance add/edit form.</div>
  1789. </dd>
  1790. <dt class="field">
  1791. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1792. <span class="include-title">mail.php</span>
  1793. </dt>
  1794. <dd class="index-item-body">
  1795. <div class="index-item-details"><a href="sloodle/_sloodle---lib---mail.php.html">mail.php</a> in mail.php</div>
  1796. </dd>
  1797. <dt class="field">
  1798. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1799. <span class="include-title">module_base.php</span>
  1800. </dt>
  1801. <dd class="index-item-body">
  1802. <div class="index-item-details"><a href="sloodle/_sloodle---lib---modules---module_base.php.html">module_base.php</a> in module_base.php</div>
  1803. </dd>
  1804. <dt class="field">
  1805. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1806. <span class="include-title">module_chat.php</span>
  1807. </dt>
  1808. <dd class="index-item-body">
  1809. <div class="index-item-details"><a href="sloodle/_sloodle---lib---modules---module_chat.php.html">module_chat.php</a> in module_chat.php</div>
  1810. </dd>
  1811. <dt class="field">
  1812. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1813. <span class="include-title">module_distributor.php</span>
  1814. </dt>
  1815. <dd class="index-item-body">
  1816. <div class="index-item-details"><a href="sloodle/_sloodle---lib---modules---module_distributor.php.html">module_distributor.php</a> in module_distributor.php</div>
  1817. </dd>
  1818. <dt class="field">
  1819. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1820. <span class="include-title">module_glossary.php</span>
  1821. </dt>
  1822. <dd class="index-item-body">
  1823. <div class="index-item-details"><a href="sloodle/_sloodle---lib---modules---module_glossary.php.html">module_glossary.php</a> in module_glossary.php</div>
  1824. </dd>
  1825. <dt class="field">
  1826. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1827. <span class="include-title">module_sloodleobject.php</span>
  1828. </dt>
  1829. <dd class="index-item-body">
  1830. <div class="index-item-details"><a href="sloodle/_sloodle---lib---modules---module_sloodleobject.php.html">module_sloodleobject.php</a> in module_sloodleobject.php</div>
  1831. </dd>
  1832. <dt class="field">
  1833. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1834. <span class="include-title">modules.php</span>
  1835. </dt>
  1836. <dd class="index-item-body">
  1837. <div class="index-item-details"><a href="sloodle/_sloodle---lib---modules.php.html">modules.php</a> in modules.php</div>
  1838. </dd>
  1839. <dt class="field">
  1840. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1841. <span class="include-title">mod_form.php</span>
  1842. </dt>
  1843. <dd class="index-item-body">
  1844. <div class="index-item-details"><a href="sloodle/_sloodle---mod_form.php.html">mod_form.php</a> in mod_form.php</div>
  1845. </dd>
  1846. </dl>
  1847. <a name="n"></a>
  1848. <div class="index-letter-section">
  1849. <div style="float: left" class="index-letter-title">n</div>
  1850. <div style="float: right"><a href="#top">top</a></div>
  1851. <div style="clear: both"></div>
  1852. </div>
  1853. <dl>
  1854. <dt class="field">
  1855. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1856. <span class="var-title">$name</span>
  1857. </dt>
  1858. <dd class="index-item-body">
  1859. <div class="index-item-details"><a href="sloodle/SloodleActiveObject.html#var$name">SloodleActiveObject::$name</a> in active_object.php</div>
  1860. <div class="index-item-description">The name of this object.</div>
  1861. </dd>
  1862. <dt class="field">
  1863. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1864. <span class="var-title">$name</span>
  1865. </dt>
  1866. <dd class="index-item-body">
  1867. <div class="index-item-details"><a href="sloodle/SloodleLayoutEntry.html#var$name">SloodleLayoutEntry::$name</a> in layout_profile.php</div>
  1868. <div class="index-item-description">The name of the object this entry represents.</div>
  1869. </dd>
  1870. <dt class="field">
  1871. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1872. <span class="var-title">$num_prims</span>
  1873. </dt>
  1874. <dd class="index-item-body">
  1875. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html#var$num_prims">assignment_sloodleobject_submission::$num_prims</a> in assignment.class.php</div>
  1876. <div class="index-item-description">Number of prims in the object which has been submitted</div>
  1877. </dd>
  1878. </dl>
  1879. <a name="o"></a>
  1880. <div class="index-letter-section">
  1881. <div style="float: left" class="index-letter-title">o</div>
  1882. <div style="float: right"><a href="#top">top</a></div>
  1883. <div style="clear: both"></div>
  1884. </div>
  1885. <dl>
  1886. <dt class="field">
  1887. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1888. <span class="var-title">$obj_name</span>
  1889. </dt>
  1890. <dd class="index-item-body">
  1891. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html#var$obj_name">assignment_sloodleobject_submission::$obj_name</a> in assignment.class.php</div>
  1892. <div class="index-item-description">Name of the object which has been submitted.</div>
  1893. </dd>
  1894. <dt class="field">
  1895. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  1896. <span class="method-title">optional_param</span>
  1897. </dt>
  1898. <dd class="index-item-body">
  1899. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodoptional_param">SloodleRequest::optional_param()</a> in io.php</div>
  1900. <div class="index-item-description">Obtains a named HTTP request parameter, or NULL if it has not been provided.</div>
  1901. </dd>
  1902. <dt class="field">
  1903. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1904. <span class="include-title">object_config.php</span>
  1905. </dt>
  1906. <dd class="index-item-body">
  1907. <div class="index-item-details"><a href="sloodle/_sloodle---mod---accesschecker-1.0---object_config.php.html">object_config.php</a> in object_config.php</div>
  1908. </dd>
  1909. <dt class="field">
  1910. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1911. <span class="include-title">object_config.php</span>
  1912. </dt>
  1913. <dd class="index-item-body">
  1914. <div class="index-item-details"><a href="sloodle/_sloodle---mod---accesscheckerdoor-1.0---object_config.php.html">object_config.php</a> in object_config.php</div>
  1915. </dd>
  1916. <dt class="field">
  1917. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1918. <span class="include-title">object_config.php</span>
  1919. </dt>
  1920. <dd class="index-item-body">
  1921. <div class="index-item-details"><a href="sloodle/_sloodle---mod---primdrop-1.0---object_config.php.html">object_config.php</a> in object_config.php</div>
  1922. </dd>
  1923. <dt class="field">
  1924. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  1925. <span class="include-title">object_config.php</span>
  1926. </dt>
  1927. <dd class="index-item-body">
  1928. <div class="index-item-details"><a href="sloodle/_sloodle---mod---quiz-1.0---object_config.php.html">object_config.php</a> in object_config.php</div>
  1929. </dd>
  1930. </dl>
  1931. <a name="p"></a>
  1932. <div class="index-letter-section">
  1933. <div style="float: left" class="index-letter-title">p</div>
  1934. <div style="float: right"><a href="#top">top</a></div>
  1935. <div style="clear: both"></div>
  1936. </div>
  1937. <dl>
  1938. <dt class="field">
  1939. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  1940. <span class="var-title">$page_number</span>
  1941. </dt>
  1942. <dd class="index-item-body">
  1943. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#var$page_number">SloodleResponse::$page_number</a> in io.php</div>
  1944. <div class="index-item-description">Current page number.</div>
  1945. </dd>
  1946. <dt class="field">
  1947. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  1948. <span class="var-title">$page_total</span>
  1949. </dt>
  1950. <dd class="index-item-body">
  1951. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#var$page_total">SloodleResponse::$page_total</a> in io.php</div>
  1952. <div class="index-item-description">Total number of pages.</div>
  1953. </dd>
  1954. <dt class="field">
  1955. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1956. <span class="var-title">$password</span>
  1957. </dt>
  1958. <dd class="index-item-body">
  1959. <div class="index-item-details"><a href="sloodle/SloodleActiveObject.html#var$password">SloodleActiveObject::$password</a> in active_object.php</div>
  1960. <div class="index-item-description">The password of this object.</div>
  1961. </dd>
  1962. <dt class="field">
  1963. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1964. <span class="var-title">$position</span>
  1965. </dt>
  1966. <dd class="index-item-body">
  1967. <div class="index-item-details"><a href="sloodle/SloodleLayoutEntry.html#var$position">SloodleLayoutEntry::$position</a> in layout_profile.php</div>
  1968. <div class="index-item-description">The position of the object, as a 3d vector, in string format &quot;&lt;x,y,z&gt;&quot;</div>
  1969. </dd>
  1970. <dt class="field">
  1971. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1972. <span class="var-title">$primdrop_name</span>
  1973. </dt>
  1974. <dd class="index-item-body">
  1975. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html#var$primdrop_name">assignment_sloodleobject_submission::$primdrop_name</a> in assignment.class.php</div>
  1976. <div class="index-item-description">Name of the PrimDrop object into which this object was submitted.</div>
  1977. </dd>
  1978. <dt class="field">
  1979. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1980. <span class="var-title">$primdrop_pos</span>
  1981. </dt>
  1982. <dd class="index-item-body">
  1983. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html#var$primdrop_pos">assignment_sloodleobject_submission::$primdrop_pos</a> in assignment.class.php</div>
  1984. <div class="index-item-description">Position where this object was submitted (as a vector, &quot;&lt;x,y,z&gt;&quot;)</div>
  1985. </dd>
  1986. <dt class="field">
  1987. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1988. <span class="var-title">$primdrop_region</span>
  1989. </dt>
  1990. <dd class="index-item-body">
  1991. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html#var$primdrop_region">assignment_sloodleobject_submission::$primdrop_region</a> in assignment.class.php</div>
  1992. <div class="index-item-description">Name of the region where this object was submitted</div>
  1993. </dd>
  1994. <dt class="field">
  1995. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  1996. <span class="var-title">$primdrop_uuid</span>
  1997. </dt>
  1998. <dd class="index-item-body">
  1999. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html#var$primdrop_uuid">assignment_sloodleobject_submission::$primdrop_uuid</a> in assignment.class.php</div>
  2000. <div class="index-item-description">UUID of the PrimDrop object into which this object was submitted.</div>
  2001. </dd>
  2002. <dt class="field">
  2003. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2004. <span class="method-title">ping_object</span>
  2005. </dt>
  2006. <dd class="index-item-body">
  2007. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodping_object">SloodleController::ping_object()</a> in controller.php</div>
  2008. <div class="index-item-description">Updates the last active timer on an object.</div>
  2009. </dd>
  2010. <dt class="field">
  2011. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2012. <span class="method-title">preprocess_submission</span>
  2013. </dt>
  2014. <dd class="index-item-body">
  2015. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject.html#methodpreprocess_submission">assignment_sloodleobject::preprocess_submission()</a> in assignment.class.php</div>
  2016. </dd>
  2017. <dt class="field">
  2018. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2019. <span class="method-title">print_student_answer</span>
  2020. </dt>
  2021. <dd class="index-item-body">
  2022. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject.html#methodprint_student_answer">assignment_sloodleobject::print_student_answer()</a> in assignment.class.php</div>
  2023. </dd>
  2024. <dt class="field">
  2025. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2026. <span class="method-title">print_user_files</span>
  2027. </dt>
  2028. <dd class="index-item-body">
  2029. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject.html#methodprint_user_files">assignment_sloodleobject::print_user_files()</a> in assignment.class.php</div>
  2030. </dd>
  2031. <dt class="field">
  2032. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2033. <span class="method-title">process_request_data</span>
  2034. </dt>
  2035. <dd class="index-item-body">
  2036. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodprocess_request_data">SloodleRequest::process_request_data()</a> in io.php</div>
  2037. <div class="index-item-description">Process all of the standard data provided by the HTTP request, and write it into our <a href="sloodle/SloodleSession.html">SloodleSession</a> object.</div>
  2038. </dd>
  2039. <dt class="field">
  2040. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2041. <span class="method-title">purge_password_notifications</span>
  2042. </dt>
  2043. <dd class="index-item-body">
  2044. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodpurge_password_notifications">SloodleUser::purge_password_notifications()</a> in user.php</div>
  2045. <div class="index-item-description">If the system is waiting to send a password notification to this user, then remove it</div>
  2046. </dd>
  2047. </dl>
  2048. <a name="q"></a>
  2049. <div class="index-letter-section">
  2050. <div style="float: left" class="index-letter-title">q</div>
  2051. <div style="float: right"><a href="#top">top</a></div>
  2052. <div style="clear: both"></div>
  2053. </div>
  2054. <dl>
  2055. <dt class="field">
  2056. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2057. <span class="method-title">quick_output</span>
  2058. </dt>
  2059. <dd class="index-item-body">
  2060. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodquick_output">SloodleResponse::quick_output()</a> in io.php</div>
  2061. <div class="index-item-description">Quick output of data to avoid several accessor calls if the response is very basic.</div>
  2062. </dd>
  2063. </dl>
  2064. <a name="r"></a>
  2065. <div class="index-letter-section">
  2066. <div style="float: left" class="index-letter-title">r</div>
  2067. <div style="float: right"><a href="#top">top</a></div>
  2068. <div style="clear: both"></div>
  2069. </div>
  2070. <dl>
  2071. <dt class="field">
  2072. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  2073. <span class="var-title">$request</span>
  2074. </dt>
  2075. <dd class="index-item-body">
  2076. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#var$request">SloodleLSLHandler::$request</a> in lsl.php</div>
  2077. <div class="index-item-description">A Sloodle request handling object.</div>
  2078. </dd>
  2079. <dt class="field">
  2080. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  2081. <span class="var-title">$request</span>
  2082. </dt>
  2083. <dd class="index-item-body">
  2084. <div class="index-item-details"><a href="sloodle/SloodleSession.html#var$request">SloodleSession::$request</a> in sloodle_session.php</div>
  2085. <div class="index-item-description">Incoming HTTP request.</div>
  2086. </dd>
  2087. <dt class="field">
  2088. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  2089. <span class="var-title">$request_data_processed</span>
  2090. </dt>
  2091. <dd class="index-item-body">
  2092. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#var$request_data_processed">SloodleRequest::$request_data_processed</a> in io.php</div>
  2093. <div class="index-item-description">Indicates whether or not the basic request data has already been processed.</div>
  2094. </dd>
  2095. <dt class="field">
  2096. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  2097. <span class="var-title">$request_descriptor</span>
  2098. </dt>
  2099. <dd class="index-item-body">
  2100. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#var$request_descriptor">SloodleResponse::$request_descriptor</a> in io.php</div>
  2101. <div class="index-item-description">Request descriptor.</div>
  2102. </dd>
  2103. <dt class="field">
  2104. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  2105. <span class="var-title">$request_timestamp</span>
  2106. </dt>
  2107. <dd class="index-item-body">
  2108. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#var$request_timestamp">SloodleResponse::$request_timestamp</a> in io.php</div>
  2109. <div class="index-item-description">Timestamp when the request was originally made by the LSL script.</div>
  2110. </dd>
  2111. <dt class="field">
  2112. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  2113. <span class="var-title">$response</span>
  2114. </dt>
  2115. <dd class="index-item-body">
  2116. <div class="index-item-details"><a href="sloodle/SloodleSession.html#var$response">SloodleSession::$response</a> in sloodle_session.php</div>
  2117. <div class="index-item-description">Outgoing response - can be rendered to HTTP or as a string.</div>
  2118. </dd>
  2119. <dt class="field">
  2120. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  2121. <span class="var-title">$response</span>
  2122. </dt>
  2123. <dd class="index-item-body">
  2124. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#var$response">SloodleLSLHandler::$response</a> in lsl.php</div>
  2125. <div class="index-item-description">A Sloodle response handling object.</div>
  2126. </dd>
  2127. <dt class="field">
  2128. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  2129. <span class="var-title">$response_timestamp</span>
  2130. </dt>
  2131. <dd class="index-item-body">
  2132. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#var$response_timestamp">SloodleResponse::$response_timestamp</a> in io.php</div>
  2133. <div class="index-item-description">Timestamp when the response was generated on the Moodle site.</div>
  2134. </dd>
  2135. <dt class="field">
  2136. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  2137. <span class="var-title">$rotation</span>
  2138. </dt>
  2139. <dd class="index-item-body">
  2140. <div class="index-item-details"><a href="sloodle/SloodleLayoutEntry.html#var$rotation">SloodleLayoutEntry::$rotation</a> in layout_profile.php</div>
  2141. <div class="index-item-description">The rotation of the object, as a 3d vector of Euler angles, in string format &quot;&lt;x,y,z&gt;&quot;</div>
  2142. </dd>
  2143. <dt class="field">
  2144. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2145. <span class="method-title">register_object</span>
  2146. </dt>
  2147. <dd class="index-item-body">
  2148. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodregister_object">SloodleController::register_object()</a> in controller.php</div>
  2149. <div class="index-item-description">Registers a new active object (or renew an existing authorisation) with this controller.</div>
  2150. </dd>
  2151. <dt class="field">
  2152. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2153. <span class="method-title">register_unauth_object</span>
  2154. </dt>
  2155. <dd class="index-item-body">
  2156. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodregister_unauth_object">SloodleController::register_unauth_object()</a> in controller.php</div>
  2157. <div class="index-item-description">Registers a new unauthorised object.</div>
  2158. </dd>
  2159. <dt class="field">
  2160. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2161. <span class="method-title">remove_object</span>
  2162. </dt>
  2163. <dd class="index-item-body">
  2164. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodremove_object">SloodleController::remove_object()</a> in controller.php</div>
  2165. <div class="index-item-description">Removes an active object and all its related items.</div>
  2166. </dd>
  2167. <dt class="field">
  2168. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2169. <span class="method-title">render_to_output</span>
  2170. </dt>
  2171. <dd class="index-item-body">
  2172. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodrender_to_output">SloodleResponse::render_to_output()</a> in io.php</div>
  2173. <div class="index-item-description">Outputs the response directly to the HTTP response.</div>
  2174. </dd>
  2175. <dt class="field">
  2176. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2177. <span class="method-title">render_to_string</span>
  2178. </dt>
  2179. <dd class="index-item-body">
  2180. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodrender_to_string">SloodleResponse::render_to_string()</a> in io.php</div>
  2181. <div class="index-item-description">Renders the response to a string.</div>
  2182. </dd>
  2183. <dt class="field">
  2184. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2185. <span class="method-title">required_param</span>
  2186. </dt>
  2187. <dd class="index-item-body">
  2188. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodrequired_param">SloodleRequest::required_param()</a> in io.php</div>
  2189. <div class="index-item-description">Obtains a named HTTP request parameter, or terminates with an error message if it has not been provided.</div>
  2190. </dd>
  2191. <dt class="field">
  2192. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2193. <span class="method-title">reset_password</span>
  2194. </dt>
  2195. <dd class="index-item-body">
  2196. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodreset_password">SloodleUser::reset_password()</a> in user.php</div>
  2197. <div class="index-item-description">Resets the user's password</div>
  2198. </dd>
  2199. <dt class="field">
  2200. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2201. <span class="method-title">resubmit_allowed</span>
  2202. </dt>
  2203. <dd class="index-item-body">
  2204. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methodresubmit_allowed">SloodleModuleSloodleObject::resubmit_allowed()</a> in module_sloodleobject.php</div>
  2205. <div class="index-item-description">Checks if re-submissions are permitted.</div>
  2206. </dd>
  2207. <dt class="field">
  2208. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  2209. <span class="include-title">regenrol_linker.php</span>
  2210. </dt>
  2211. <dd class="index-item-body">
  2212. <div class="index-item-details"><a href="sloodle/_sloodle---login---regenrol_linker.php.html">regenrol_linker.php</a> in regenrol_linker.php</div>
  2213. </dd>
  2214. </dl>
  2215. <a name="s"></a>
  2216. <div class="index-letter-section">
  2217. <div style="float: left" class="index-letter-title">s</div>
  2218. <div style="float: right"><a href="#top">top</a></div>
  2219. <div style="clear: both"></div>
  2220. </div>
  2221. <dl>
  2222. <dt class="field">
  2223. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  2224. <span class="var-title">$side_effects</span>
  2225. </dt>
  2226. <dd class="index-item-body">
  2227. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#var$side_effects">SloodleResponse::$side_effects</a> in io.php</div>
  2228. <div class="index-item-description">Integer side effect(s) codes.</div>
  2229. </dd>
  2230. <dt class="field">
  2231. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  2232. <span class="var-title">$sloodle_controller_instance</span>
  2233. </dt>
  2234. <dd class="index-item-body">
  2235. <div class="index-item-details"><a href="sloodle/SloodleController.html#var$sloodle_controller_instance">SloodleController::$sloodle_controller_instance</a> in controller.php</div>
  2236. <div class="index-item-description">Internal only - Sloodle Controller instance database object.</div>
  2237. </dd>
  2238. <dt class="field">
  2239. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  2240. <span class="var-title">$sloodle_course_data</span>
  2241. </dt>
  2242. <dd class="index-item-body">
  2243. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#var$sloodle_course_data">SloodleCourse::$sloodle_course_data</a> in course.php</div>
  2244. <div class="index-item-description">The Sloodle course data object, if it exists.</div>
  2245. </dd>
  2246. <dt class="field">
  2247. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  2248. <span class="var-title">$sloodle_distributor_instance</span>
  2249. </dt>
  2250. <dd class="index-item-body">
  2251. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#var$sloodle_distributor_instance">SloodleModuleDistributor::$sloodle_distributor_instance</a> in module_distributor.php</div>
  2252. <div class="index-item-description">Internal only - Sloodle Distributor instance database object.</div>
  2253. </dd>
  2254. <dt class="field">
  2255. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  2256. <span class="var-title">$sloodle_module_instance</span>
  2257. </dt>
  2258. <dd class="index-item-body">
  2259. <div class="index-item-details"><a href="sloodle/SloodleController.html#var$sloodle_module_instance">SloodleController::$sloodle_module_instance</a> in controller.php</div>
  2260. <div class="index-item-description">Internal only - Sloodle module instance database object.</div>
  2261. </dd>
  2262. <dt class="field">
  2263. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  2264. <span class="var-title">$sloodle_module_instance</span>
  2265. </dt>
  2266. <dd class="index-item-body">
  2267. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#var$sloodle_module_instance">SloodleModuleDistributor::$sloodle_module_instance</a> in module_distributor.php</div>
  2268. <div class="index-item-description">Internal only - Sloodle module instance database object.</div>
  2269. </dd>
  2270. <dt class="field">
  2271. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  2272. <span class="var-title">$status_code</span>
  2273. </dt>
  2274. <dd class="index-item-body">
  2275. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#var$status_code">SloodleResponse::$status_code</a> in io.php</div>
  2276. <div class="index-item-description">Integer status code of the response.</div>
  2277. </dd>
  2278. <dt class="field">
  2279. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  2280. <span class="var-title">$status_descriptor</span>
  2281. </dt>
  2282. <dd class="index-item-body">
  2283. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#var$status_descriptor">SloodleResponse::$status_descriptor</a> in io.php</div>
  2284. <div class="index-item-description">Status descriptor string.</div>
  2285. </dd>
  2286. <dt class="field">
  2287. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2288. <span class="method-title">save_layout</span>
  2289. </dt>
  2290. <dd class="index-item-body">
  2291. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodsave_layout">SloodleCourse::save_layout()</a> in course.php</div>
  2292. <div class="index-item-description">Save the given entries in the named profile.</div>
  2293. </dd>
  2294. <dt class="field">
  2295. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2296. <span class="method-title">search</span>
  2297. </dt>
  2298. <dd class="index-item-body">
  2299. <div class="index-item-details"><a href="sloodle/SloodleModuleGlossary.html#methodsearch">SloodleModuleGlossary::search()</a> in module_glossary.php</div>
  2300. <div class="index-item-description">Searches all entries in the current glossary for the given term.</div>
  2301. </dd>
  2302. <dt class="field">
  2303. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2304. <span class="method-title">send_object</span>
  2305. </dt>
  2306. <dd class="index-item-body">
  2307. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#methodsend_object">SloodleModuleDistributor::send_object()</a> in module_distributor.php</div>
  2308. <div class="index-item-description">Request that the specified object be sent to the specified avatar.</div>
  2309. </dd>
  2310. <dt class="field">
  2311. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2312. <span class="method-title">set</span>
  2313. </dt>
  2314. <dd class="index-item-body">
  2315. <div class="index-item-details"><a href="sloodle/SloodleChatMessage.html#methodset">SloodleChatMessage::set()</a> in module_chat.php</div>
  2316. <div class="index-item-description">Accessor - set all members in a single call.</div>
  2317. </dd>
  2318. <dt class="field">
  2319. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2320. <span class="method-title">set</span>
  2321. </dt>
  2322. <dd class="index-item-body">
  2323. <div class="index-item-details"><a href="sloodle/SloodleGlossaryEntry.html#methodset">SloodleGlossaryEntry::set()</a> in module_glossary.php</div>
  2324. <div class="index-item-description">Accessor - set all members in a single call.</div>
  2325. </dd>
  2326. <dt class="field">
  2327. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2328. <span class="method-title">setup_elements</span>
  2329. </dt>
  2330. <dd class="index-item-body">
  2331. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject.html#methodsetup_elements">assignment_sloodleobject::setup_elements()</a> in assignment.class.php</div>
  2332. </dd>
  2333. <dt class="field">
  2334. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2335. <span class="method-title">set_avatar_last_active</span>
  2336. </dt>
  2337. <dd class="index-item-body">
  2338. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodset_avatar_last_active">SloodleUser::set_avatar_last_active()</a> in user.php</div>
  2339. <div class="index-item-description">Sets the timestamp of when the user was last active</div>
  2340. </dd>
  2341. <dt class="field">
  2342. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2343. <span class="method-title">set_avatar_name</span>
  2344. </dt>
  2345. <dd class="index-item-body">
  2346. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodset_avatar_name">SloodleUser::set_avatar_name()</a> in user.php</div>
  2347. <div class="index-item-description">Sets the name of the avatar</div>
  2348. </dd>
  2349. <dt class="field">
  2350. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2351. <span class="method-title">set_avatar_uuid</span>
  2352. </dt>
  2353. <dd class="index-item-body">
  2354. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodset_avatar_uuid">SloodleUser::set_avatar_uuid()</a> in user.php</div>
  2355. <div class="index-item-description">Sets the UUID of the avatar</div>
  2356. </dd>
  2357. <dt class="field">
  2358. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2359. <span class="method-title">set_avatar_uuid</span>
  2360. </dt>
  2361. <dd class="index-item-body">
  2362. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodset_avatar_uuid">SloodleResponse::set_avatar_uuid()</a> in io.php</div>
  2363. <div class="index-item-description">Accessor function to set member value $avatar_uuid</div>
  2364. </dd>
  2365. <dt class="field">
  2366. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2367. <span class="method-title">set_channel</span>
  2368. </dt>
  2369. <dd class="index-item-body">
  2370. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#methodset_channel">SloodleModuleDistributor::set_channel()</a> in module_distributor.php</div>
  2371. <div class="index-item-description">Sets the UUID of the XMLRPC channel used for requests.</div>
  2372. </dd>
  2373. <dt class="field">
  2374. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2375. <span class="method-title">set_data</span>
  2376. </dt>
  2377. <dd class="index-item-body">
  2378. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodset_data">SloodleResponse::set_data()</a> in io.php</div>
  2379. <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>
  2380. </dd>
  2381. <dt class="field">
  2382. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2383. <span class="method-title">set_field_separator</span>
  2384. </dt>
  2385. <dd class="index-item-body">
  2386. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodset_field_separator">SloodleResponse::set_field_separator()</a> in io.php</div>
  2387. <div class="index-item-description">Sets the field separator.</div>
  2388. </dd>
  2389. <dt class="field">
  2390. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2391. <span class="method-title">set_intro</span>
  2392. </dt>
  2393. <dd class="index-item-body">
  2394. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodset_intro">SloodleController::set_intro()</a> in controller.php</div>
  2395. <div class="index-item-description">Sets the intro description of this controller.</div>
  2396. </dd>
  2397. <dt class="field">
  2398. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2399. <span class="method-title">set_line_separator</span>
  2400. </dt>
  2401. <dd class="index-item-body">
  2402. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodset_line_separator">SloodleResponse::set_line_separator()</a> in io.php</div>
  2403. <div class="index-item-description">Sets the line separator.</div>
  2404. </dd>
  2405. <dt class="field">
  2406. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2407. <span class="method-title">set_loginzone_position</span>
  2408. </dt>
  2409. <dd class="index-item-body">
  2410. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodset_loginzone_position">SloodleCourse::set_loginzone_position()</a> in course.php</div>
  2411. <div class="index-item-description">Sets the position of the loginzone as a string vector &lt;x,y,z&gt;</div>
  2412. </dd>
  2413. <dt class="field">
  2414. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2415. <span class="method-title">set_loginzone_position_xyz</span>
  2416. </dt>
  2417. <dd class="index-item-body">
  2418. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodset_loginzone_position_xyz">SloodleCourse::set_loginzone_position_xyz()</a> in course.php</div>
  2419. <div class="index-item-description">Sets the position of the loginzone as a set of components</div>
  2420. </dd>
  2421. <dt class="field">
  2422. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2423. <span class="method-title">set_loginzone_region</span>
  2424. </dt>
  2425. <dd class="index-item-body">
  2426. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodset_loginzone_region">SloodleCourse::set_loginzone_region()</a> in course.php</div>
  2427. <div class="index-item-description">Sets the region of the loginzone</div>
  2428. </dd>
  2429. <dt class="field">
  2430. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2431. <span class="method-title">set_loginzone_size</span>
  2432. </dt>
  2433. <dd class="index-item-body">
  2434. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodset_loginzone_size">SloodleCourse::set_loginzone_size()</a> in course.php</div>
  2435. <div class="index-item-description">Sets the size of the loginzone as a string vector &lt;x,y,z&gt;</div>
  2436. </dd>
  2437. <dt class="field">
  2438. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2439. <span class="method-title">set_loginzone_size_xyz</span>
  2440. </dt>
  2441. <dd class="index-item-body">
  2442. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodset_loginzone_size_xyz">SloodleCourse::set_loginzone_size_xyz()</a> in course.php</div>
  2443. <div class="index-item-description">Sets the size of the loginzone as a set of components</div>
  2444. </dd>
  2445. <dt class="field">
  2446. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2447. <span class="method-title">set_loginzone_time_updated</span>
  2448. </dt>
  2449. <dd class="index-item-body">
  2450. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodset_loginzone_time_updated">SloodleCourse::set_loginzone_time_updated()</a> in course.php</div>
  2451. <div class="index-item-description">Sets the timestamp of the last time the loginzone was updated</div>
  2452. </dd>
  2453. <dt class="field">
  2454. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2455. <span class="method-title">set_name</span>
  2456. </dt>
  2457. <dd class="index-item-body">
  2458. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodset_name">SloodleController::set_name()</a> in controller.php</div>
  2459. <div class="index-item-description">Sets the name of this controller.</div>
  2460. </dd>
  2461. <dt class="field">
  2462. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2463. <span class="method-title">set_objects</span>
  2464. </dt>
  2465. <dd class="index-item-body">
  2466. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#methodset_objects">SloodleModuleDistributor::set_objects()</a> in module_distributor.php</div>
  2467. <div class="index-item-description">Sets the list of objects in this Distributor</div>
  2468. </dd>
  2469. <dt class="field">
  2470. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2471. <span class="method-title">set_page_number</span>
  2472. </dt>
  2473. <dd class="index-item-body">
  2474. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodset_page_number">SloodleResponse::set_page_number()</a> in io.php</div>
  2475. <div class="index-item-description">Accessor function to set member value $page_number</div>
  2476. </dd>
  2477. <dt class="field">
  2478. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2479. <span class="method-title">set_page_total</span>
  2480. </dt>
  2481. <dd class="index-item-body">
  2482. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodset_page_total">SloodleResponse::set_page_total()</a> in io.php</div>
  2483. <div class="index-item-description">Accessor function to set member value $page_total</div>
  2484. </dd>
  2485. <dt class="field">
  2486. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2487. <span class="method-title">set_password</span>
  2488. </dt>
  2489. <dd class="index-item-body">
  2490. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodset_password">SloodleController::set_password()</a> in controller.php</div>
  2491. <div class="index-item-description">Sets the prim password of this controller.</div>
  2492. </dd>
  2493. <dt class="field">
  2494. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2495. <span class="method-title">set_pos</span>
  2496. </dt>
  2497. <dd class="index-item-body">
  2498. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html#methodset_pos">assignment_sloodleobject_submission::set_pos()</a> in assignment.class.php</div>
  2499. <div class="index-item-description">Sets the position as 3 components.</div>
  2500. </dd>
  2501. <dt class="field">
  2502. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2503. <span class="method-title">set_position_xyz</span>
  2504. </dt>
  2505. <dd class="index-item-body">
  2506. <div class="index-item-details"><a href="sloodle/SloodleLayoutEntry.html#methodset_position_xyz">SloodleLayoutEntry::set_position_xyz()</a> in layout_profile.php</div>
  2507. <div class="index-item-description">Sets the position as separate X,Y,Z components</div>
  2508. </dd>
  2509. <dt class="field">
  2510. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2511. <span class="method-title">set_request_descriptor</span>
  2512. </dt>
  2513. <dd class="index-item-body">
  2514. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodset_request_descriptor">SloodleResponse::set_request_descriptor()</a> in io.php</div>
  2515. <div class="index-item-description">Accessor function to set member value $request_descriptor</div>
  2516. </dd>
  2517. <dt class="field">
  2518. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2519. <span class="method-title">set_request_timestamp</span>
  2520. </dt>
  2521. <dd class="index-item-body">
  2522. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodset_request_timestamp">SloodleResponse::set_request_timestamp()</a> in io.php</div>
  2523. <div class="index-item-description">Accessor function to set member value $request_timestamp</div>
  2524. </dd>
  2525. <dt class="field">
  2526. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2527. <span class="method-title">set_response_timestamp</span>
  2528. </dt>
  2529. <dd class="index-item-body">
  2530. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodset_response_timestamp">SloodleResponse::set_response_timestamp()</a> in io.php</div>
  2531. <div class="index-item-description">Accessor function to set member value $response_timestamp</div>
  2532. </dd>
  2533. <dt class="field">
  2534. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2535. <span class="method-title">set_rotation_xyz</span>
  2536. </dt>
  2537. <dd class="index-item-body">
  2538. <div class="index-item-details"><a href="sloodle/SloodleLayoutEntry.html#methodset_rotation_xyz">SloodleLayoutEntry::set_rotation_xyz()</a> in layout_profile.php</div>
  2539. <div class="index-item-description">Sets the rotation as separate X,Y,Z components</div>
  2540. </dd>
  2541. <dt class="field">
  2542. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2543. <span class="method-title">set_side_effects</span>
  2544. </dt>
  2545. <dd class="index-item-body">
  2546. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodset_side_effects">SloodleResponse::set_side_effects()</a> in io.php</div>
  2547. <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>
  2548. </dd>
  2549. <dt class="field">
  2550. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2551. <span class="method-title">set_status_code</span>
  2552. </dt>
  2553. <dd class="index-item-body">
  2554. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodset_status_code">SloodleResponse::set_status_code()</a> in io.php</div>
  2555. <div class="index-item-description">Accessor function to set member value $status_code</div>
  2556. </dd>
  2557. <dt class="field">
  2558. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2559. <span class="method-title">set_status_descriptor</span>
  2560. </dt>
  2561. <dd class="index-item-body">
  2562. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodset_status_descriptor">SloodleResponse::set_status_descriptor()</a> in io.php</div>
  2563. <div class="index-item-description">Accessor function to set member value $status_descriptor</div>
  2564. </dd>
  2565. <dt class="field">
  2566. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  2567. <span class="method-title">set_tracking_code</span>
  2568. </dt>
  2569. <dd class="index-item-body">
  2570. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodset_tracking_code">SloodleResponse::set_tracking_code()</a> in io.php</div>
  2571. <div class="index-item-description">Accessor function to set member value $tracking_code</div>
  2572. </dd>
  2573. <dt class="field">
  2574. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  2575. <span class="include-title">sloodle_session.php</span>
  2576. </dt>
  2577. <dd class="index-item-body">
  2578. <div class="index-item-details"><a href="sloodle/_sloodle---lib---sloodle_session.php.html">sloodle_session.php</a> in sloodle_session.php</div>
  2579. </dd>
  2580. <dt class="field">
  2581. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  2582. <span class="include-title">settings.php</span>
  2583. </dt>
  2584. <dd class="index-item-body">
  2585. <div class="index-item-details"><a href="sloodle/_sloodle---settings.php.html">settings.php</a> in settings.php</div>
  2586. </dd>
  2587. <dt class="field">
  2588. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  2589. <span class="include-title">sl_config.php</span>
  2590. </dt>
  2591. <dd class="index-item-body">
  2592. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html">sl_config.php</a> in sl_config.php</div>
  2593. </dd>
  2594. <dt class="field">
  2595. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2596. SloodleActiveObject
  2597. </dt>
  2598. <dd class="index-item-body">
  2599. <div class="index-item-details"><a href="sloodle/SloodleActiveObject.html">SloodleActiveObject</a> in active_object.php</div>
  2600. <div class="index-item-description">An active object, relating to the Sloodle active objects DB table.</div>
  2601. </dd>
  2602. <dt class="field">
  2603. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2604. SloodleChatMessage
  2605. </dt>
  2606. <dd class="index-item-body">
  2607. <div class="index-item-details"><a href="sloodle/SloodleChatMessage.html">SloodleChatMessage</a> in module_chat.php</div>
  2608. <div class="index-item-description">Represents a single chat message</div>
  2609. </dd>
  2610. <dt class="field">
  2611. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2612. <span class="method-title">SloodleChatMessage</span>
  2613. </dt>
  2614. <dd class="index-item-body">
  2615. <div class="index-item-details"><a href="sloodle/SloodleChatMessage.html#methodSloodleChatMessage">SloodleChatMessage::SloodleChatMessage()</a> in module_chat.php</div>
  2616. <div class="index-item-description">Constructor - initialises members.</div>
  2617. </dd>
  2618. <dt class="field">
  2619. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2620. <span class="method-title">SloodleController</span>
  2621. </dt>
  2622. <dd class="index-item-body">
  2623. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodSloodleController">SloodleController::SloodleController()</a> in controller.php</div>
  2624. <div class="index-item-description">Constructor</div>
  2625. </dd>
  2626. <dt class="field">
  2627. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2628. SloodleController
  2629. </dt>
  2630. <dd class="index-item-body">
  2631. <div class="index-item-details"><a href="sloodle/SloodleController.html">SloodleController</a> in controller.php</div>
  2632. <div class="index-item-description">Represents a Sloodle Controller, including data such as prim password.</div>
  2633. </dd>
  2634. <dt class="field">
  2635. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2636. <span class="method-title">SloodleCourse</span>
  2637. </dt>
  2638. <dd class="index-item-body">
  2639. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodSloodleCourse">SloodleCourse::SloodleCourse()</a> in course.php</div>
  2640. <div class="index-item-description">Constructor</div>
  2641. </dd>
  2642. <dt class="field">
  2643. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2644. SloodleCourse
  2645. </dt>
  2646. <dd class="index-item-body">
  2647. <div class="index-item-details"><a href="sloodle/SloodleCourse.html">SloodleCourse</a> in course.php</div>
  2648. <div class="index-item-description">The Sloodle course data class</div>
  2649. </dd>
  2650. <dt class="field">
  2651. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2652. <span class="method-title">SloodleGlossaryEntry</span>
  2653. </dt>
  2654. <dd class="index-item-body">
  2655. <div class="index-item-details"><a href="sloodle/SloodleGlossaryEntry.html#methodSloodleGlossaryEntry">SloodleGlossaryEntry::SloodleGlossaryEntry()</a> in module_glossary.php</div>
  2656. <div class="index-item-description">Constructor - initialises members.</div>
  2657. </dd>
  2658. <dt class="field">
  2659. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2660. SloodleGlossaryEntry
  2661. </dt>
  2662. <dd class="index-item-body">
  2663. <div class="index-item-details"><a href="sloodle/SloodleGlossaryEntry.html">SloodleGlossaryEntry</a> in module_glossary.php</div>
  2664. <div class="index-item-description">Represents a single glossary entry</div>
  2665. </dd>
  2666. <dt class="field">
  2667. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2668. SloodleLayoutEntry
  2669. </dt>
  2670. <dd class="index-item-body">
  2671. <div class="index-item-details"><a href="sloodle/SloodleLayoutEntry.html">SloodleLayoutEntry</a> in layout_profile.php</div>
  2672. <div class="index-item-description">Stores data for a single entry in a layout profile.</div>
  2673. </dd>
  2674. <dt class="field">
  2675. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2676. SloodleLSLHandler
  2677. </dt>
  2678. <dd class="index-item-body">
  2679. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html">SloodleLSLHandler</a> in lsl.php</div>
  2680. <div class="index-item-description">A helper class to automate many API features.</div>
  2681. </dd>
  2682. <dt class="field">
  2683. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2684. <span class="method-title">SloodleLSLHandler</span>
  2685. </dt>
  2686. <dd class="index-item-body">
  2687. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#methodSloodleLSLHandler">SloodleLSLHandler::SloodleLSLHandler()</a> in lsl.php</div>
  2688. <div class="index-item-description">Class constructor.</div>
  2689. </dd>
  2690. <dt class="field">
  2691. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2692. <span class="method-title">SloodleModule</span>
  2693. </dt>
  2694. <dd class="index-item-body">
  2695. <div class="index-item-details"><a href="sloodle/SloodleModule.html#methodSloodleModule">SloodleModule::SloodleModule()</a> in module_base.php</div>
  2696. <div class="index-item-description">Constructor - initialises the session variable</div>
  2697. </dd>
  2698. <dt class="field">
  2699. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2700. SloodleModule
  2701. </dt>
  2702. <dd class="index-item-body">
  2703. <div class="index-item-details"><a href="sloodle/SloodleModule.html">SloodleModule</a> in module_base.php</div>
  2704. <div class="index-item-description">Sloodle module base class.</div>
  2705. </dd>
  2706. <dt class="field">
  2707. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2708. <span class="method-title">SloodleModuleChat</span>
  2709. </dt>
  2710. <dd class="index-item-body">
  2711. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html#methodSloodleModuleChat">SloodleModuleChat::SloodleModuleChat()</a> in module_chat.php</div>
  2712. <div class="index-item-description">Constructor</div>
  2713. </dd>
  2714. <dt class="field">
  2715. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2716. SloodleModuleChat
  2717. </dt>
  2718. <dd class="index-item-body">
  2719. <div class="index-item-details"><a href="sloodle/SloodleModuleChat.html">SloodleModuleChat</a> in module_chat.php</div>
  2720. <div class="index-item-description">The Sloodle chat module class.</div>
  2721. </dd>
  2722. <dt class="field">
  2723. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2724. <span class="method-title">SloodleModuleDistributor</span>
  2725. </dt>
  2726. <dd class="index-item-body">
  2727. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html#methodSloodleModuleDistributor">SloodleModuleDistributor::SloodleModuleDistributor()</a> in module_distributor.php</div>
  2728. <div class="index-item-description">Constructor</div>
  2729. </dd>
  2730. <dt class="field">
  2731. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2732. SloodleModuleDistributor
  2733. </dt>
  2734. <dd class="index-item-body">
  2735. <div class="index-item-details"><a href="sloodle/SloodleModuleDistributor.html">SloodleModuleDistributor</a> in module_distributor.php</div>
  2736. <div class="index-item-description">The Sloodle Distributor module class.</div>
  2737. </dd>
  2738. <dt class="field">
  2739. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2740. SloodleModuleGlossary
  2741. </dt>
  2742. <dd class="index-item-body">
  2743. <div class="index-item-details"><a href="sloodle/SloodleModuleGlossary.html">SloodleModuleGlossary</a> in module_glossary.php</div>
  2744. <div class="index-item-description">The Sloodle glossary module class.</div>
  2745. </dd>
  2746. <dt class="field">
  2747. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2748. <span class="method-title">SloodleModuleGlossary</span>
  2749. </dt>
  2750. <dd class="index-item-body">
  2751. <div class="index-item-details"><a href="sloodle/SloodleModuleGlossary.html#methodSloodleModuleGlossary">SloodleModuleGlossary::SloodleModuleGlossary()</a> in module_glossary.php</div>
  2752. <div class="index-item-description">Constructor</div>
  2753. </dd>
  2754. <dt class="field">
  2755. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2756. <span class="method-title">SloodleModuleSloodleObject</span>
  2757. </dt>
  2758. <dd class="index-item-body">
  2759. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methodSloodleModuleSloodleObject">SloodleModuleSloodleObject::SloodleModuleSloodleObject()</a> in module_sloodleobject.php</div>
  2760. <div class="index-item-description">Constructor</div>
  2761. </dd>
  2762. <dt class="field">
  2763. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2764. SloodleModuleSloodleObject
  2765. </dt>
  2766. <dd class="index-item-body">
  2767. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html">SloodleModuleSloodleObject</a> in module_sloodleobject.php</div>
  2768. <div class="index-item-description">The Sloodle Object assignment module class.</div>
  2769. </dd>
  2770. <dt class="field">
  2771. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2772. <span class="method-title">SloodleRequest</span>
  2773. </dt>
  2774. <dd class="index-item-body">
  2775. <div class="index-item-details"><a href="sloodle/SloodleRequest.html#methodSloodleRequest">SloodleRequest::SloodleRequest()</a> in io.php</div>
  2776. <div class="index-item-description"><em>Constructor</em><ul><li>initialises the <a href="sloodle/SloodleSession.html">SloodleSession</a> object.</li></ul></div>
  2777. </dd>
  2778. <dt class="field">
  2779. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2780. SloodleRequest
  2781. </dt>
  2782. <dd class="index-item-body">
  2783. <div class="index-item-details"><a href="sloodle/SloodleRequest.html">SloodleRequest</a> in io.php</div>
  2784. <div class="index-item-description">Handles incoming HTTP requests, typically from LSL if dealing with Second Life.</div>
  2785. </dd>
  2786. <dt class="field">
  2787. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2788. <span class="method-title">SloodleResponse</span>
  2789. </dt>
  2790. <dd class="index-item-body">
  2791. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#methodSloodleResponse">SloodleResponse::SloodleResponse()</a> in io.php</div>
  2792. <div class="index-item-description"><em>Constructor</em><ul><li>can intialise some variables</li></ul></div>
  2793. </dd>
  2794. <dt class="field">
  2795. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2796. SloodleResponse
  2797. </dt>
  2798. <dd class="index-item-body">
  2799. <div class="index-item-details"><a href="sloodle/SloodleResponse.html">SloodleResponse</a> in io.php</div>
  2800. <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>
  2801. </dd>
  2802. <dt class="field">
  2803. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2804. <span class="method-title">SloodleSession</span>
  2805. </dt>
  2806. <dd class="index-item-body">
  2807. <div class="index-item-details"><a href="sloodle/SloodleSession.html#methodSloodleSession">SloodleSession::SloodleSession()</a> in sloodle_session.php</div>
  2808. <div class="index-item-description">Constructor - initialises members</div>
  2809. </dd>
  2810. <dt class="field">
  2811. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2812. SloodleSession
  2813. </dt>
  2814. <dd class="index-item-body">
  2815. <div class="index-item-details"><a href="sloodle/SloodleSession.html">SloodleSession</a> in sloodle_session.php</div>
  2816. <div class="index-item-description">The primary API class, which manages all other parts.</div>
  2817. </dd>
  2818. <dt class="field">
  2819. <img src="media/images/Class.png" alt="Class" title="Class" /></title>
  2820. SloodleUser
  2821. </dt>
  2822. <dd class="index-item-body">
  2823. <div class="index-item-details"><a href="sloodle/SloodleUser.html">SloodleUser</a> in user.php</div>
  2824. <div class="index-item-description">A class to represent a single user, including Moodle and Sloodle data.</div>
  2825. </dd>
  2826. <dt class="field">
  2827. <img src="media/images/Constructor.png" alt="Method" title="Method" /></title>
  2828. <span class="method-title">SloodleUser</span>
  2829. </dt>
  2830. <dd class="index-item-body">
  2831. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodSloodleUser">SloodleUser::SloodleUser()</a> in user.php</div>
  2832. <div class="index-item-description">Class constructor.</div>
  2833. </dd>
  2834. <dt class="field">
  2835. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2836. <span class="method-title">sloodle_add_instance</span>
  2837. </dt>
  2838. <dd class="index-item-body">
  2839. <div class="index-item-details"><a href="sloodle/_sloodle---lib.php.html#functionsloodle_add_instance">sloodle_add_instance()</a> in lib.php</div>
  2840. <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>
  2841. </dd>
  2842. <dt class="field">
  2843. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2844. <span class="method-title">sloodle_add_to_log</span>
  2845. </dt>
  2846. <dd class="index-item-body">
  2847. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_add_to_log">sloodle_add_to_log()</a> in general.php</div>
  2848. <div class="index-item-description">Old logging function</div>
  2849. </dd>
  2850. <dt class="field">
  2851. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2852. <span class="method-title">sloodle_array_to_vector</span>
  2853. </dt>
  2854. <dd class="index-item-body">
  2855. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_array_to_vector">sloodle_array_to_vector()</a> in general.php</div>
  2856. <div class="index-item-description">Converts an array vector to a string vector.</div>
  2857. </dd>
  2858. <dt class="field">
  2859. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2860. <span class="method-title">sloodle_autoenrol_enabled_site</span>
  2861. </dt>
  2862. <dd class="index-item-body">
  2863. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_autoenrol_enabled_site">sloodle_autoenrol_enabled_site()</a> in general.php</div>
  2864. <div class="index-item-description">Determines whether or not auto-enrolment is allowed for the site.</div>
  2865. </dd>
  2866. <dt class="field">
  2867. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2868. <span class="method-title">sloodle_autoreg_enabled_site</span>
  2869. </dt>
  2870. <dd class="index-item-body">
  2871. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_autoreg_enabled_site">sloodle_autoreg_enabled_site()</a> in general.php</div>
  2872. <div class="index-item-description">Determines whether or not auto-registration is allowed for the site.</div>
  2873. </dd>
  2874. <dt class="field">
  2875. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2876. <span class="method-title">sloodle_check_course_module_instance_type</span>
  2877. </dt>
  2878. <dd class="index-item-body">
  2879. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_check_course_module_instance_type">sloodle_check_course_module_instance_type()</a> in general.php</div>
  2880. <div class="index-item-description">Determines if the specified course module instance is of the named type.</div>
  2881. </dd>
  2882. <dt class="field">
  2883. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2884. <span class="method-title">sloodle_cron</span>
  2885. </dt>
  2886. <dd class="index-item-body">
  2887. <div class="index-item-details"><a href="sloodle/_sloodle---lib.php.html#functionsloodle_cron">sloodle_cron()</a> in lib.php</div>
  2888. <div class="index-item-description">Function to be run periodically according to the Moodle cron.</div>
  2889. </dd>
  2890. <dt class="field">
  2891. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2892. <span class="method-title">sloodle_debug</span>
  2893. </dt>
  2894. <dd class="index-item-body">
  2895. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#functionsloodle_debug">sloodle_debug()</a> in sl_config.php</div>
  2896. <div class="index-item-description">Outputs messages if in debug mode.</div>
  2897. </dd>
  2898. <dt class="field">
  2899. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  2900. <span class="const-title">SLOODLE_DEBUG</span>
  2901. </dt>
  2902. <dd class="index-item-body">
  2903. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_DEBUG">SLOODLE_DEBUG</a> in sl_config.php</div>
  2904. </dd>
  2905. <dt class="field">
  2906. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  2907. <span class="const-title">SLOODLE_DEBUG_MODE_PARAM_NAME</span>
  2908. </dt>
  2909. <dd class="index-item-body">
  2910. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_DEBUG_MODE_PARAM_NAME">SLOODLE_DEBUG_MODE_PARAM_NAME</a> in sl_config.php</div>
  2911. <div class="index-item-description">The name of the HTTP parameter which can be used to activate Sloodle debug mode.</div>
  2912. </dd>
  2913. <dt class="field">
  2914. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2915. <span class="method-title">sloodle_delete_instance</span>
  2916. </dt>
  2917. <dd class="index-item-body">
  2918. <div class="index-item-details"><a href="sloodle/_sloodle---lib.php.html#functionsloodle_delete_instance">sloodle_delete_instance()</a> in lib.php</div>
  2919. <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>
  2920. </dd>
  2921. <dt class="field">
  2922. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  2923. <span class="const-title">SLOODLE_DIRROOT</span>
  2924. </dt>
  2925. <dd class="index-item-body">
  2926. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_DIRROOT">SLOODLE_DIRROOT</a> in sl_config.php</div>
  2927. <div class="index-item-description">The data path for the root of the Sloodle folder.</div>
  2928. </dd>
  2929. <dt class="field">
  2930. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2931. <span class="method-title">sloodle_display_config_form</span>
  2932. </dt>
  2933. <dd class="index-item-body">
  2934. <div class="index-item-details"><a href="sloodle/_sloodle---mod---accesschecker-1.0---object_config.php.html#functionsloodle_display_config_form">sloodle_display_config_form()</a> in object_config.php</div>
  2935. </dd>
  2936. <dt class="field">
  2937. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2938. <span class="method-title">sloodle_finished_login_coordinates</span>
  2939. </dt>
  2940. <dd class="index-item-body">
  2941. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_finished_login_coordinates">sloodle_finished_login_coordinates()</a> in general.php</div>
  2942. <div class="index-item-description">Generates teleport coordinates for a user who has already finished the LoginZone process.</div>
  2943. </dd>
  2944. <dt class="field">
  2945. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2946. <span class="method-title">sloodle_get_config</span>
  2947. </dt>
  2948. <dd class="index-item-body">
  2949. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_get_config">sloodle_get_config()</a> in general.php</div>
  2950. <div class="index-item-description">Gets a Sloodle configuration value from Moodle's &quot;config&quot; table.</div>
  2951. </dd>
  2952. <dt class="field">
  2953. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2954. <span class="method-title">sloodle_get_course_module_instance</span>
  2955. </dt>
  2956. <dd class="index-item-body">
  2957. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_get_course_module_instance">sloodle_get_course_module_instance()</a> in general.php</div>
  2958. <div class="index-item-description">Obtains the identified course module instance database record.</div>
  2959. </dd>
  2960. <dt class="field">
  2961. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2962. <span class="method-title">sloodle_get_module_id</span>
  2963. </dt>
  2964. <dd class="index-item-body">
  2965. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_get_module_id">sloodle_get_module_id()</a> in general.php</div>
  2966. <div class="index-item-description">Obtains the ID number of the specified module (type not instance).</div>
  2967. </dd>
  2968. <dt class="field">
  2969. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2970. <span class="method-title">sloodle_get_participants</span>
  2971. </dt>
  2972. <dd class="index-item-body">
  2973. <div class="index-item-details"><a href="sloodle/_sloodle---lib.php.html#functionsloodle_get_participants">sloodle_get_participants()</a> in lib.php</div>
  2974. <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>
  2975. </dd>
  2976. <dt class="field">
  2977. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2978. <span class="method-title">sloodle_get_types</span>
  2979. </dt>
  2980. <dd class="index-item-body">
  2981. <div class="index-item-details"><a href="sloodle/_sloodle---lib.php.html#functionsloodle_get_types">sloodle_get_types()</a> in lib.php</div>
  2982. <div class="index-item-description">Gets the different sub-types of Sloodle module available as a list for the &quot;Add Activity...&quot; menu.</div>
  2983. </dd>
  2984. <dt class="field">
  2985. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2986. <span class="method-title">sloodle_get_value</span>
  2987. </dt>
  2988. <dd class="index-item-body">
  2989. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_get_value">sloodle_get_value()</a> in general.php</div>
  2990. <div class="index-item-description">Extracts a value from a name-value associative array if it is set.</div>
  2991. </dd>
  2992. <dt class="field">
  2993. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  2994. <span class="method-title">sloodle_grades</span>
  2995. </dt>
  2996. <dd class="index-item-body">
  2997. <div class="index-item-details"><a href="sloodle/_sloodle---lib.php.html#functionsloodle_grades">sloodle_grades()</a> in lib.php</div>
  2998. <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>
  2999. </dd>
  3000. <dt class="field">
  3001. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3002. <span class="method-title">sloodle_is_course_module_instance_visible</span>
  3003. </dt>
  3004. <dd class="index-item-body">
  3005. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_is_course_module_instance_visible">sloodle_is_course_module_instance_visible()</a> in general.php</div>
  3006. <div class="index-item-description">Determines whether or not the specified course module instance is visible.</div>
  3007. </dd>
  3008. <dt class="field">
  3009. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3010. <span class="method-title">sloodle_is_installed</span>
  3011. </dt>
  3012. <dd class="index-item-body">
  3013. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_is_installed">sloodle_is_installed()</a> in general.php</div>
  3014. <div class="index-item-description">Determines whether or not Sloodle is installed.</div>
  3015. </dd>
  3016. <dt class="field">
  3017. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3018. <span class="const-title">SLOODLE_LIBROOT</span>
  3019. </dt>
  3020. <dd class="index-item-body">
  3021. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_LIBROOT">SLOODLE_LIBROOT</a> in sl_config.php</div>
  3022. <div class="index-item-description">The data path for the root of the Sloodle library folder.</div>
  3023. </dd>
  3024. <dt class="field">
  3025. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3026. <span class="const-title">SLOODLE_LINKER_SCRIPT</span>
  3027. </dt>
  3028. <dd class="index-item-body">
  3029. <div class="index-item-details"><a href="sloodle/_sloodle---login---regenrol_linker.php.html#defineSLOODLE_LINKER_SCRIPT">SLOODLE_LINKER_SCRIPT</a> in regenrol_linker.php</div>
  3030. <div class="index-item-description">Lets Sloodle know we are in a linker script.</div>
  3031. </dd>
  3032. <dt class="field">
  3033. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3034. <span class="method-title">sloodle_load_module</span>
  3035. </dt>
  3036. <dd class="index-item-body">
  3037. <div class="index-item-details"><a href="sloodle/_sloodle---lib---modules.php.html#functionsloodle_load_module">sloodle_load_module()</a> in modules.php</div>
  3038. <div class="index-item-description">Constructs a appropriate Sloodle module object based on the named type.</div>
  3039. </dd>
  3040. <dt class="field">
  3041. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3042. <span class="method-title">sloodle_login_notification</span>
  3043. </dt>
  3044. <dd class="index-item-body">
  3045. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_login_notification">sloodle_login_notification()</a> in general.php</div>
  3046. <div class="index-item-description">Stores a pending login notification for an auto-registered user.</div>
  3047. </dd>
  3048. <dt class="field">
  3049. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3050. <span class="method-title">sloodle_login_zone_bounds</span>
  3051. </dt>
  3052. <dd class="index-item-body">
  3053. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_login_zone_bounds">sloodle_login_zone_bounds()</a> in general.php</div>
  3054. <div class="index-item-description">Calculates the maximum and minimum bounds of the specified LoginZone Returns the bounds as a numeric array of two associate array vectors: ($max, $min).</div>
  3055. </dd>
  3056. <dt class="field">
  3057. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3058. <span class="const-title">SLOODLE_MENU_VERSION</span>
  3059. </dt>
  3060. <dd class="index-item-body">
  3061. <div class="index-item-details"><a href="sloodle/_sloodle_menu---block_sloodle_menu.php.html#defineSLOODLE_MENU_VERSION">SLOODLE_MENU_VERSION</a> in block_sloodle_menu.php</div>
  3062. <div class="index-item-description">Define the Sloodle Menu Block version.</div>
  3063. </dd>
  3064. <dt class="field">
  3065. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3066. <span class="const-title">SLOODLE_OBJECT_ACCESS_LEVEL_GROUP</span>
  3067. </dt>
  3068. <dd class="index-item-body">
  3069. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_OBJECT_ACCESS_LEVEL_GROUP">SLOODLE_OBJECT_ACCESS_LEVEL_GROUP</a> in sl_config.php</div>
  3070. <div class="index-item-description">Indicates that only in-world group-members may access an object in-world.</div>
  3071. </dd>
  3072. <dt class="field">
  3073. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3074. <span class="const-title">SLOODLE_OBJECT_ACCESS_LEVEL_OWNER</span>
  3075. </dt>
  3076. <dd class="index-item-body">
  3077. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_OBJECT_ACCESS_LEVEL_OWNER">SLOODLE_OBJECT_ACCESS_LEVEL_OWNER</a> in sl_config.php</div>
  3078. <div class="index-item-description">Indicates that only the owner may access an object in-world.</div>
  3079. </dd>
  3080. <dt class="field">
  3081. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3082. <span class="const-title">SLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC</span>
  3083. </dt>
  3084. <dd class="index-item-body">
  3085. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC">SLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC</a> in sl_config.php</div>
  3086. <div class="index-item-description">Indicates that anybody may access an object in-world.</div>
  3087. </dd>
  3088. <dt class="field">
  3089. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3090. <span class="const-title">SLOODLE_PARAM_AVATAR_NAME</span>
  3091. </dt>
  3092. <dd class="index-item-body">
  3093. <div class="index-item-details"><a href="sloodle/_sloodle---lib---io.php.html#defineSLOODLE_PARAM_AVATAR_NAME">SLOODLE_PARAM_AVATAR_NAME</a> in io.php</div>
  3094. <div class="index-item-description">Defines the HTTP parameter name for an avatar name.</div>
  3095. </dd>
  3096. <dt class="field">
  3097. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3098. <span class="const-title">SLOODLE_PARAM_AVATAR_UUID</span>
  3099. </dt>
  3100. <dd class="index-item-body">
  3101. <div class="index-item-details"><a href="sloodle/_sloodle---lib---io.php.html#defineSLOODLE_PARAM_AVATAR_UUID">SLOODLE_PARAM_AVATAR_UUID</a> in io.php</div>
  3102. <div class="index-item-description">Defines the HTTP parameter name for an avatar UUID.</div>
  3103. </dd>
  3104. <dt class="field">
  3105. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3106. <span class="const-title">SLOODLE_PARAM_CONTROLLER_ID</span>
  3107. </dt>
  3108. <dd class="index-item-body">
  3109. <div class="index-item-details"><a href="sloodle/_sloodle---lib---io.php.html#defineSLOODLE_PARAM_CONTROLLER_ID">SLOODLE_PARAM_CONTROLLER_ID</a> in io.php</div>
  3110. <div class="index-item-description">Defines the HTTP parameter name for a Sloodle controller ID.</div>
  3111. </dd>
  3112. <dt class="field">
  3113. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3114. <span class="const-title">SLOODLE_PARAM_COURSE_ID</span>
  3115. </dt>
  3116. <dd class="index-item-body">
  3117. <div class="index-item-details"><a href="sloodle/_sloodle---lib---io.php.html#defineSLOODLE_PARAM_COURSE_ID">SLOODLE_PARAM_COURSE_ID</a> in io.php</div>
  3118. <div class="index-item-description">Defines the HTTP parameter name for a course ID.</div>
  3119. </dd>
  3120. <dt class="field">
  3121. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3122. <span class="const-title">SLOODLE_PARAM_IS_OBJECT</span>
  3123. </dt>
  3124. <dd class="index-item-body">
  3125. <div class="index-item-details"><a href="sloodle/_sloodle---lib---io.php.html#defineSLOODLE_PARAM_IS_OBJECT">SLOODLE_PARAM_IS_OBJECT</a> in io.php</div>
  3126. <div class="index-item-description">Defines the HTTP parameter name for indicating a request which relates to an object instead of a user.</div>
  3127. </dd>
  3128. <dt class="field">
  3129. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3130. <span class="const-title">SLOODLE_PARAM_MODULE_ID</span>
  3131. </dt>
  3132. <dd class="index-item-body">
  3133. <div class="index-item-details"><a href="sloodle/_sloodle---lib---io.php.html#defineSLOODLE_PARAM_MODULE_ID">SLOODLE_PARAM_MODULE_ID</a> in io.php</div>
  3134. <div class="index-item-description">Defines the HTTP parameter name for a module ID.</div>
  3135. </dd>
  3136. <dt class="field">
  3137. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3138. <span class="const-title">SLOODLE_PARAM_PASSWORD</span>
  3139. </dt>
  3140. <dd class="index-item-body">
  3141. <div class="index-item-details"><a href="sloodle/_sloodle---lib---io.php.html#defineSLOODLE_PARAM_PASSWORD">SLOODLE_PARAM_PASSWORD</a> in io.php</div>
  3142. <div class="index-item-description">Defines the HTTP parameter name for a Sloodle password.</div>
  3143. </dd>
  3144. <dt class="field">
  3145. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3146. <span class="const-title">SLOODLE_PARAM_REQUEST_DESC</span>
  3147. </dt>
  3148. <dd class="index-item-body">
  3149. <div class="index-item-details"><a href="sloodle/_sloodle---lib---io.php.html#defineSLOODLE_PARAM_REQUEST_DESC">SLOODLE_PARAM_REQUEST_DESC</a> in io.php</div>
  3150. <div class="index-item-description">Defines the HTTP parameter name for a request descriptor.</div>
  3151. </dd>
  3152. <dt class="field">
  3153. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3154. <span class="const-title">SLOODLE_PARAM_SERVER_ACCESS_LEVEL</span>
  3155. </dt>
  3156. <dd class="index-item-body">
  3157. <div class="index-item-details"><a href="sloodle/_sloodle---lib---io.php.html#defineSLOODLE_PARAM_SERVER_ACCESS_LEVEL">SLOODLE_PARAM_SERVER_ACCESS_LEVEL</a> in io.php</div>
  3158. <div class="index-item-description">Defines the HTTP parameter name for specifying server access level.</div>
  3159. </dd>
  3160. <dt class="field">
  3161. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3162. <span class="method-title">sloodle_position_is_in_login_zone</span>
  3163. </dt>
  3164. <dd class="index-item-body">
  3165. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_position_is_in_login_zone">sloodle_position_is_in_login_zone()</a> in general.php</div>
  3166. <div class="index-item-description">Checks if the specified position is in the current (site-wide) loginzone.</div>
  3167. </dd>
  3168. <dt class="field">
  3169. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3170. <span class="method-title">sloodle_print_access_level_options</span>
  3171. </dt>
  3172. <dd class="index-item-body">
  3173. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_print_access_level_options">sloodle_print_access_level_options()</a> in general.php</div>
  3174. <div class="index-item-description">Outputs the standard form elements for access levels in object configuration.</div>
  3175. </dd>
  3176. <dt class="field">
  3177. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3178. <span class="method-title">sloodle_print_recent_activity</span>
  3179. </dt>
  3180. <dd class="index-item-body">
  3181. <div class="index-item-details"><a href="sloodle/_sloodle---lib.php.html#functionsloodle_print_recent_activity">sloodle_print_recent_activity()</a> in lib.php</div>
  3182. <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>
  3183. </dd>
  3184. <dt class="field">
  3185. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3186. <span class="method-title">sloodle_process_login_notifications</span>
  3187. </dt>
  3188. <dd class="index-item-body">
  3189. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_process_login_notifications">sloodle_process_login_notifications()</a> in general.php</div>
  3190. <div class="index-item-description">Processes pending login notifications, up to a certain limit.</div>
  3191. </dd>
  3192. <dt class="field">
  3193. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3194. <span class="method-title">sloodle_process_options</span>
  3195. </dt>
  3196. <dd class="index-item-body">
  3197. <div class="index-item-details"><a href="sloodle/_sloodle---lib.php.html#functionsloodle_process_options">sloodle_process_options()</a> in lib.php</div>
  3198. <div class="index-item-description">Processes the module configuration options prior to saving them.</div>
  3199. </dd>
  3200. <dt class="field">
  3201. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3202. <span class="method-title">sloodle_random_position_in_zone</span>
  3203. </dt>
  3204. <dd class="index-item-body">
  3205. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_random_position_in_zone">sloodle_random_position_in_zone()</a> in general.php</div>
  3206. <div class="index-item-description">Generates a random position within a cuboid zone of the specified size.</div>
  3207. </dd>
  3208. <dt class="field">
  3209. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3210. <span class="method-title">sloodle_random_prim_password</span>
  3211. </dt>
  3212. <dd class="index-item-body">
  3213. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_random_prim_password">sloodle_random_prim_password()</a> in general.php</div>
  3214. <div class="index-item-description">Generates a random prim password (7 to 9 digit number).</div>
  3215. </dd>
  3216. <dt class="field">
  3217. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3218. <span class="method-title">sloodle_random_security_token</span>
  3219. </dt>
  3220. <dd class="index-item-body">
  3221. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_random_security_token">sloodle_random_security_token()</a> in general.php</div>
  3222. <div class="index-item-description">Generates a random login security token.</div>
  3223. </dd>
  3224. <dt class="field">
  3225. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3226. <span class="method-title">sloodle_random_web_password</span>
  3227. </dt>
  3228. <dd class="index-item-body">
  3229. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_random_web_password">sloodle_random_web_password()</a> in general.php</div>
  3230. <div class="index-item-description">Generates a random web password Uses mixed-case letters and numbers to generate a random 8-character string.</div>
  3231. </dd>
  3232. <dt class="field">
  3233. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3234. <span class="method-title">sloodle_required_param</span>
  3235. </dt>
  3236. <dd class="index-item-body">
  3237. <div class="index-item-details"><a href="sloodle/_sloodle---lib---io.php.html#functionsloodle_required_param">sloodle_required_param()</a> in io.php</div>
  3238. <div class="index-item-description">Obtains a named HTTP request parameter, and terminates script with an error message if it was not provided.</div>
  3239. </dd>
  3240. <dt class="field">
  3241. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3242. <span class="method-title">sloodle_round_vector</span>
  3243. </dt>
  3244. <dd class="index-item-body">
  3245. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_round_vector">sloodle_round_vector()</a> in general.php</div>
  3246. <div class="index-item-description">Rounds the specified 3d vector integer values.</div>
  3247. </dd>
  3248. <dt class="field">
  3249. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3250. <span class="method-title">sloodle_scale_used</span>
  3251. </dt>
  3252. <dd class="index-item-body">
  3253. <div class="index-item-details"><a href="sloodle/_sloodle---lib.php.html#functionsloodle_scale_used">sloodle_scale_used()</a> in lib.php</div>
  3254. <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>
  3255. </dd>
  3256. <dt class="field">
  3257. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3258. <span class="method-title">sloodle_send_login_notification</span>
  3259. </dt>
  3260. <dd class="index-item-body">
  3261. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_send_login_notification">sloodle_send_login_notification()</a> in general.php</div>
  3262. <div class="index-item-description">Send a login notification.</div>
  3263. </dd>
  3264. <dt class="field">
  3265. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3266. <span class="method-title">sloodle_send_xmlrpc_message</span>
  3267. </dt>
  3268. <dd class="index-item-body">
  3269. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_send_xmlrpc_message">sloodle_send_xmlrpc_message()</a> in general.php</div>
  3270. <div class="index-item-description">Sends an XMLRPC message into Second Life.</div>
  3271. </dd>
  3272. <dt class="field">
  3273. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3274. <span class="const-title">SLOODLE_SERVER_ACCESS_LEVEL_COURSE</span>
  3275. </dt>
  3276. <dd class="index-item-body">
  3277. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_SERVER_ACCESS_LEVEL_COURSE">SLOODLE_SERVER_ACCESS_LEVEL_COURSE</a> in sl_config.php</div>
  3278. <div class="index-item-description">Indicates that only those registered and enrolled in a specific course may access a server resource.</div>
  3279. </dd>
  3280. <dt class="field">
  3281. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3282. <span class="const-title">SLOODLE_SERVER_ACCESS_LEVEL_PUBLIC</span>
  3283. </dt>
  3284. <dd class="index-item-body">
  3285. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_SERVER_ACCESS_LEVEL_PUBLIC">SLOODLE_SERVER_ACCESS_LEVEL_PUBLIC</a> in sl_config.php</div>
  3286. <div class="index-item-description">Indicates that anybody may access a server resource (still requires an authenticated request).</div>
  3287. </dd>
  3288. <dt class="field">
  3289. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3290. <span class="const-title">SLOODLE_SERVER_ACCESS_LEVEL_SITE</span>
  3291. </dt>
  3292. <dd class="index-item-body">
  3293. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_SERVER_ACCESS_LEVEL_SITE">SLOODLE_SERVER_ACCESS_LEVEL_SITE</a> in sl_config.php</div>
  3294. <div class="index-item-description">Indicates that only those registered on the site may access a server resource.</div>
  3295. </dd>
  3296. <dt class="field">
  3297. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3298. <span class="const-title">SLOODLE_SERVER_ACCESS_LEVEL_STAFF</span>
  3299. </dt>
  3300. <dd class="index-item-body">
  3301. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_SERVER_ACCESS_LEVEL_STAFF">SLOODLE_SERVER_ACCESS_LEVEL_STAFF</a> in sl_config.php</div>
  3302. <div class="index-item-description">Indicates that only those with Sloodle staff status on a course may access a server resource.</div>
  3303. </dd>
  3304. <dt class="field">
  3305. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3306. <span class="method-title">sloodle_set_config</span>
  3307. </dt>
  3308. <dd class="index-item-body">
  3309. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_set_config">sloodle_set_config()</a> in general.php</div>
  3310. <div class="index-item-description">Sets a Sloodle configuration value.</div>
  3311. </dd>
  3312. <dt class="field">
  3313. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3314. <span class="method-title">sloodle_text_email</span>
  3315. </dt>
  3316. <dd class="index-item-body">
  3317. <div class="index-item-details"><a href="sloodle/_sloodle---lib---mail.php.html#functionsloodle_text_email">sloodle_text_email()</a> in mail.php</div>
  3318. <div class="index-item-description">Send an email to a specific address, using the Moodle system.</div>
  3319. </dd>
  3320. <dt class="field">
  3321. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3322. <span class="method-title">sloodle_text_email_sl</span>
  3323. </dt>
  3324. <dd class="index-item-body">
  3325. <div class="index-item-details"><a href="sloodle/_sloodle---lib---mail.php.html#functionsloodle_text_email_sl">sloodle_text_email_sl()</a> in mail.php</div>
  3326. <div class="index-item-description">Send an email to an object in SL.</div>
  3327. </dd>
  3328. <dt class="field">
  3329. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3330. <span class="const-title">SLOODLE_TYPE_CTRL</span>
  3331. </dt>
  3332. <dd class="index-item-body">
  3333. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_TYPE_CTRL">SLOODLE_TYPE_CTRL</a> in sl_config.php</div>
  3334. </dd>
  3335. <dt class="field">
  3336. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3337. <span class="const-title">SLOODLE_TYPE_DISTRIB</span>
  3338. </dt>
  3339. <dd class="index-item-body">
  3340. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_TYPE_DISTRIB">SLOODLE_TYPE_DISTRIB</a> in sl_config.php</div>
  3341. </dd>
  3342. <dt class="field">
  3343. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3344. <span class="method-title">sloodle_update_instance</span>
  3345. </dt>
  3346. <dd class="index-item-body">
  3347. <div class="index-item-details"><a href="sloodle/_sloodle---lib.php.html#functionsloodle_update_instance">sloodle_update_instance()</a> in lib.php</div>
  3348. <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>
  3349. </dd>
  3350. <dt class="field">
  3351. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3352. <span class="method-title">sloodle_user_complete</span>
  3353. </dt>
  3354. <dd class="index-item-body">
  3355. <div class="index-item-details"><a href="sloodle/_sloodle---lib.php.html#functionsloodle_user_complete">sloodle_user_complete()</a> in lib.php</div>
  3356. <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>
  3357. </dd>
  3358. <dt class="field">
  3359. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3360. <span class="method-title">sloodle_user_outline</span>
  3361. </dt>
  3362. <dd class="index-item-body">
  3363. <div class="index-item-details"><a href="sloodle/_sloodle---lib.php.html#functionsloodle_user_outline">sloodle_user_outline()</a> in lib.php</div>
  3364. <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>
  3365. </dd>
  3366. <dt class="field">
  3367. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3368. <span class="method-title">sloodle_validate_prim_password</span>
  3369. </dt>
  3370. <dd class="index-item-body">
  3371. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_validate_prim_password">sloodle_validate_prim_password()</a> in general.php</div>
  3372. <div class="index-item-description">Checks if the given prim password is valid.</div>
  3373. </dd>
  3374. <dt class="field">
  3375. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3376. <span class="method-title">sloodle_validate_prim_password_verbose</span>
  3377. </dt>
  3378. <dd class="index-item-body">
  3379. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_validate_prim_password_verbose">sloodle_validate_prim_password_verbose()</a> in general.php</div>
  3380. <div class="index-item-description">Checks if the given prim password is valid, and provides feedback.</div>
  3381. </dd>
  3382. <dt class="field">
  3383. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3384. <span class="method-title">sloodle_vector_to_array</span>
  3385. </dt>
  3386. <dd class="index-item-body">
  3387. <div class="index-item-details"><a href="sloodle/_sloodle---lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array()</a> in general.php</div>
  3388. <div class="index-item-description">Converts a string vector to an array vector.</div>
  3389. </dd>
  3390. <dt class="field">
  3391. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3392. <span class="const-title">SLOODLE_VERSION</span>
  3393. </dt>
  3394. <dd class="index-item-body">
  3395. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_VERSION">SLOODLE_VERSION</a> in sl_config.php</div>
  3396. <div class="index-item-description">The Sloodle version number.</div>
  3397. </dd>
  3398. <dt class="field">
  3399. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3400. <span class="method-title">sloodle_view_controller</span>
  3401. </dt>
  3402. <dd class="index-item-body">
  3403. <div class="index-item-details"><a href="sloodle/_sloodle---view---view_controller.php.html#functionsloodle_view_controller">sloodle_view_controller()</a> in view_controller.php</div>
  3404. <div class="index-item-description">Displays information about the given Sloodle module.</div>
  3405. </dd>
  3406. <dt class="field">
  3407. <img src="media/images/Function.png" alt="Function" title="Function" /></title>
  3408. <span class="method-title">sloodle_view_distributor</span>
  3409. </dt>
  3410. <dd class="index-item-body">
  3411. <div class="index-item-details"><a href="sloodle/_sloodle---view---view_distributor.php.html#functionsloodle_view_distributor">sloodle_view_distributor()</a> in view_distributor.php</div>
  3412. <div class="index-item-description">Displays information about the given Sloodle Distributor.</div>
  3413. </dd>
  3414. <dt class="field">
  3415. <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title>
  3416. <span class="const-title">SLOODLE_WWWROOT</span>
  3417. </dt>
  3418. <dd class="index-item-body">
  3419. <div class="index-item-details"><a href="sloodle/_sloodle---sl_config.php.html#defineSLOODLE_WWWROOT">SLOODLE_WWWROOT</a> in sl_config.php</div>
  3420. <div class="index-item-description">The path for browsing to the root of the Sloodle folder.</div>
  3421. </dd>
  3422. <dt class="field">
  3423. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3424. <span class="method-title">submit</span>
  3425. </dt>
  3426. <dd class="index-item-body">
  3427. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methodsubmit">SloodleModuleSloodleObject::submit()</a> in module_sloodleobject.php</div>
  3428. <div class="index-item-description">Add a new submission (or replace an existing one).</div>
  3429. </dd>
  3430. </dl>
  3431. <a name="t"></a>
  3432. <div class="index-letter-section">
  3433. <div style="float: left" class="index-letter-title">t</div>
  3434. <div style="float: right"><a href="#top">top</a></div>
  3435. <div style="clear: both"></div>
  3436. </div>
  3437. <dl>
  3438. <dt class="field">
  3439. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  3440. <span class="var-title">$timestamp</span>
  3441. </dt>
  3442. <dd class="index-item-body">
  3443. <div class="index-item-details"><a href="sloodle/SloodleChatMessage.html#var$timestamp">SloodleChatMessage::$timestamp</a> in module_chat.php</div>
  3444. <div class="index-item-description">Timestamp of the message.</div>
  3445. </dd>
  3446. <dt class="field">
  3447. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  3448. <span class="var-title">$tracking_code</span>
  3449. </dt>
  3450. <dd class="index-item-body">
  3451. <div class="index-item-details"><a href="sloodle/SloodleResponse.html#var$tracking_code">SloodleResponse::$tracking_code</a> in io.php</div>
  3452. <div class="index-item-description">Tracking code of the request.</div>
  3453. </dd>
  3454. <dt class="field">
  3455. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  3456. <span class="var-title">$type</span>
  3457. </dt>
  3458. <dd class="index-item-body">
  3459. <div class="index-item-details"><a href="sloodle/SloodleActiveObject.html#var$type">SloodleActiveObject::$type</a> in active_object.php</div>
  3460. <div class="index-item-description">The type of this object.</div>
  3461. </dd>
  3462. <dt class="field">
  3463. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3464. <span class="method-title">text_summary</span>
  3465. </dt>
  3466. <dd class="index-item-body">
  3467. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject_submission.html#methodtext_summary">assignment_sloodleobject_submission::text_summary()</a> in assignment.class.php</div>
  3468. <div class="index-item-description">Construct a text summary of this submission.</div>
  3469. </dd>
  3470. </dl>
  3471. <a name="u"></a>
  3472. <div class="index-letter-section">
  3473. <div style="float: left" class="index-letter-title">u</div>
  3474. <div style="float: right"><a href="#top">top</a></div>
  3475. <div style="clear: both"></div>
  3476. </div>
  3477. <dl>
  3478. <dt class="field">
  3479. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  3480. <span class="var-title">$user</span>
  3481. </dt>
  3482. <dd class="index-item-body">
  3483. <div class="index-item-details"><a href="sloodle/SloodleActiveObject.html#var$user">SloodleActiveObject::$user</a> in active_object.php</div>
  3484. <div class="index-item-description">The user who authorised this object.</div>
  3485. </dd>
  3486. <dt class="field">
  3487. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  3488. <span class="var-title">$user</span>
  3489. </dt>
  3490. <dd class="index-item-body">
  3491. <div class="index-item-details"><a href="sloodle/SloodleSession.html#var$user">SloodleSession::$user</a> in sloodle_session.php</div>
  3492. <div class="index-item-description">Current user information.</div>
  3493. </dd>
  3494. <dt class="field">
  3495. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  3496. <span class="var-title">$user</span>
  3497. </dt>
  3498. <dd class="index-item-body">
  3499. <div class="index-item-details"><a href="sloodle/SloodleLSLHandler.html#var$user">SloodleLSLHandler::$user</a> in lsl.php</div>
  3500. <div class="index-item-description">A Sloodle user object.</div>
  3501. </dd>
  3502. <dt class="field">
  3503. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  3504. <span class="var-title">$user</span>
  3505. </dt>
  3506. <dd class="index-item-body">
  3507. <div class="index-item-details"><a href="sloodle/SloodleChatMessage.html#var$user">SloodleChatMessage::$user</a> in module_chat.php</div>
  3508. <div class="index-item-description">The user who wrote this message.</div>
  3509. </dd>
  3510. <dt class="field">
  3511. <img src="media/images/PrivateVariable.png" alt="Variable" title="Variable" /></title>
  3512. <span class="var-title">$user_data</span>
  3513. </dt>
  3514. <dd class="index-item-body">
  3515. <div class="index-item-details"><a href="sloodle/SloodleUser.html#var$user_data">SloodleUser::$user_data</a> in user.php</div>
  3516. <div class="index-item-description">Internal only - user data. (i.e. VLE user) In Moodle, corresponds to a record from the 'user' table.</div>
  3517. </dd>
  3518. <dt class="field">
  3519. <img src="media/images/Variable.png" alt="Variable" title="Variable" /></title>
  3520. <span class="var-title">$uuid</span>
  3521. </dt>
  3522. <dd class="index-item-body">
  3523. <div class="index-item-details"><a href="sloodle/SloodleActiveObject.html#var$uuid">SloodleActiveObject::$uuid</a> in active_object.php</div>
  3524. <div class="index-item-description">The UUID of this object.</div>
  3525. </dd>
  3526. <dt class="field">
  3527. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  3528. <span class="include-title">user.php</span>
  3529. </dt>
  3530. <dd class="index-item-body">
  3531. <div class="index-item-details"><a href="sloodle/_sloodle---lib---user.php.html">user.php</a> in user.php</div>
  3532. </dd>
  3533. <dt class="field">
  3534. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3535. <span class="method-title">update_object_type</span>
  3536. </dt>
  3537. <dd class="index-item-body">
  3538. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodupdate_object_type">SloodleController::update_object_type()</a> in controller.php</div>
  3539. <div class="index-item-description">Updates the type of a given active object to the specified type.</div>
  3540. </dd>
  3541. <dt class="field">
  3542. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3543. <span class="method-title">update_submission</span>
  3544. </dt>
  3545. <dd class="index-item-body">
  3546. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject.html#methodupdate_submission">assignment_sloodleobject::update_submission()</a> in assignment.class.php</div>
  3547. <div class="index-item-description">Update the submission with the provided data.</div>
  3548. </dd>
  3549. <dt class="field">
  3550. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3551. <span class="method-title">user_can_submit</span>
  3552. </dt>
  3553. <dd class="index-item-body">
  3554. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methoduser_can_submit">SloodleModuleSloodleObject::user_can_submit()</a> in module_sloodleobject.php</div>
  3555. <div class="index-item-description">Checks if the specified user is permitted to submit to this assignment.</div>
  3556. </dd>
  3557. <dt class="field">
  3558. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3559. <span class="method-title">user_can_view</span>
  3560. </dt>
  3561. <dd class="index-item-body">
  3562. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methoduser_can_view">SloodleModuleSloodleObject::user_can_view()</a> in module_sloodleobject.php</div>
  3563. <div class="index-item-description">Checks if the specified user is permitted to view submissions to this assignment.</div>
  3564. </dd>
  3565. <dt class="field">
  3566. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3567. <span class="method-title">user_has_submitted</span>
  3568. </dt>
  3569. <dd class="index-item-body">
  3570. <div class="index-item-details"><a href="sloodle/SloodleModuleSloodleObject.html#methoduser_has_submitted">SloodleModuleSloodleObject::user_has_submitted()</a> in module_sloodleobject.php</div>
  3571. <div class="index-item-description">Checks if the specified user has submitted to this assignment already.</div>
  3572. </dd>
  3573. </dl>
  3574. <a name="v"></a>
  3575. <div class="index-letter-section">
  3576. <div style="float: left" class="index-letter-title">v</div>
  3577. <div style="float: right"><a href="#top">top</a></div>
  3578. <div style="clear: both"></div>
  3579. </div>
  3580. <dl>
  3581. <dt class="field">
  3582. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  3583. <span class="include-title">version.php</span>
  3584. </dt>
  3585. <dd class="index-item-body">
  3586. <div class="index-item-details"><a href="sloodle/_sloodle---version.php.html">version.php</a> in version.php</div>
  3587. </dd>
  3588. <dt class="field">
  3589. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  3590. <span class="include-title">version_linker.php</span>
  3591. </dt>
  3592. <dd class="index-item-body">
  3593. <div class="index-item-details"><a href="sloodle/_sloodle---version_linker.php.html">version_linker.php</a> in version_linker.php</div>
  3594. </dd>
  3595. <dt class="field">
  3596. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  3597. <span class="include-title">view_configuration_notecard.php</span>
  3598. </dt>
  3599. <dd class="index-item-body">
  3600. <div class="index-item-details"><a href="sloodle/_sloodle---view---view_configuration_notecard.php.html">view_configuration_notecard.php</a> in view_configuration_notecard.php</div>
  3601. </dd>
  3602. <dt class="field">
  3603. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  3604. <span class="include-title">view_controller.php</span>
  3605. </dt>
  3606. <dd class="index-item-body">
  3607. <div class="index-item-details"><a href="sloodle/_sloodle---view---view_controller.php.html">view_controller.php</a> in view_controller.php</div>
  3608. </dd>
  3609. <dt class="field">
  3610. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  3611. <span class="include-title">view_course.php</span>
  3612. </dt>
  3613. <dd class="index-item-body">
  3614. <div class="index-item-details"><a href="sloodle/_sloodle---view---view_course.php.html">view_course.php</a> in view_course.php</div>
  3615. </dd>
  3616. <dt class="field">
  3617. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  3618. <span class="include-title">view_distributor.php</span>
  3619. </dt>
  3620. <dd class="index-item-body">
  3621. <div class="index-item-details"><a href="sloodle/_sloodle---view---view_distributor.php.html">view_distributor.php</a> in view_distributor.php</div>
  3622. </dd>
  3623. <dt class="field">
  3624. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  3625. <span class="include-title">view_user.php</span>
  3626. </dt>
  3627. <dd class="index-item-body">
  3628. <div class="index-item-details"><a href="sloodle/_sloodle---view---view_user.php.html">view_user.php</a> in view_user.php</div>
  3629. </dd>
  3630. <dt class="field">
  3631. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  3632. <span class="include-title">view_users.php</span>
  3633. </dt>
  3634. <dd class="index-item-body">
  3635. <div class="index-item-details"><a href="sloodle/_sloodle---view---view_users.php.html">view_users.php</a> in view_users.php</div>
  3636. </dd>
  3637. <dt class="field">
  3638. <img src="media/images/Page.png" alt="Page" title="Page" /></title>
  3639. <span class="include-title">view.php</span>
  3640. </dt>
  3641. <dd class="index-item-body">
  3642. <div class="index-item-details"><a href="sloodle/_sloodle---view.php.html">view.php</a> in view.php</div>
  3643. </dd>
  3644. <dt class="field">
  3645. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3646. <span class="method-title">validate_user</span>
  3647. </dt>
  3648. <dd class="index-item-body">
  3649. <div class="index-item-details"><a href="sloodle/SloodleSession.html#methodvalidate_user">SloodleSession::validate_user()</a> in sloodle_session.php</div>
  3650. <div class="index-item-description">Validates the user account and enrolment (ensures there is an avatar linked to a VLE account, and that the VLE account is enrolled in the current course).</div>
  3651. </dd>
  3652. <dt class="field">
  3653. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3654. <span class="method-title">validation</span>
  3655. </dt>
  3656. <dd class="index-item-body">
  3657. <div class="index-item-details"><a href="sloodle/mod_sloodle_mod_form.html#methodvalidation">mod_sloodle_mod_form::validation()</a> in mod_form.php</div>
  3658. <div class="index-item-description">Validates the form data.</div>
  3659. </dd>
  3660. <dt class="field">
  3661. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3662. <span class="method-title">view</span>
  3663. </dt>
  3664. <dd class="index-item-body">
  3665. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject.html#methodview">assignment_sloodleobject::view()</a> in assignment.class.php</div>
  3666. </dd>
  3667. <dt class="field">
  3668. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3669. <span class="method-title">view_dates</span>
  3670. </dt>
  3671. <dd class="index-item-body">
  3672. <div class="index-item-details"><a href="sloodle/assignment_sloodleobject.html#methodview_dates">assignment_sloodleobject::view_dates()</a> in assignment.class.php</div>
  3673. </dd>
  3674. </dl>
  3675. <a name="w"></a>
  3676. <div class="index-letter-section">
  3677. <div style="float: left" class="index-letter-title">w</div>
  3678. <div style="float: right"><a href="#top">top</a></div>
  3679. <div style="clear: both"></div>
  3680. </div>
  3681. <dl>
  3682. <dt class="field">
  3683. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3684. <span class="method-title">write</span>
  3685. </dt>
  3686. <dd class="index-item-body">
  3687. <div class="index-item-details"><a href="sloodle/SloodleController.html#methodwrite">SloodleController::write()</a> in controller.php</div>
  3688. <div class="index-item-description">Updates the currently loaded entry in the database.</div>
  3689. </dd>
  3690. <dt class="field">
  3691. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3692. <span class="method-title">write</span>
  3693. </dt>
  3694. <dd class="index-item-body">
  3695. <div class="index-item-details"><a href="sloodle/SloodleCourse.html#methodwrite">SloodleCourse::write()</a> in course.php</div>
  3696. <div class="index-item-description">Writes current Sloodle course data back to the database.</div>
  3697. </dd>
  3698. <dt class="field">
  3699. <img src="media/images/Method.png" alt="Method" title="Method" /></title>
  3700. <span class="method-title">write_avatar</span>
  3701. </dt>
  3702. <dd class="index-item-body">
  3703. <div class="index-item-details"><a href="sloodle/SloodleUser.html#methodwrite_avatar">SloodleUser::write_avatar()</a> in user.php</div>
  3704. <div class="index-item-description">Uses the current avatar data to update the database.</div>
  3705. </dd>
  3706. </dl>
  3707. <div class="index-letter-menu">
  3708. <a class="index-letter" href="elementindex_sloodle.html#a">a</a>
  3709. <a class="index-letter" href="elementindex_sloodle.html#b">b</a>
  3710. <a class="index-letter" href="elementindex_sloodle.html#c">c</a>
  3711. <a class="index-letter" href="elementindex_sloodle.html#d">d</a>
  3712. <a class="index-letter" href="elementindex_sloodle.html#e">e</a>
  3713. <a class="index-letter" href="elementindex_sloodle.html#f">f</a>
  3714. <a class="index-letter" href="elementindex_sloodle.html#g">g</a>
  3715. <a class="index-letter" href="elementindex_sloodle.html#h">h</a>
  3716. <a class="index-letter" href="elementindex_sloodle.html#i">i</a>
  3717. <a class="index-letter" href="elementindex_sloodle.html#l">l</a>
  3718. <a class="index-letter" href="elementindex_sloodle.html#m">m</a>
  3719. <a class="index-letter" href="elementindex_sloodle.html#n">n</a>
  3720. <a class="index-letter" href="elementindex_sloodle.html#o">o</a>
  3721. <a class="index-letter" href="elementindex_sloodle.html#p">p</a>
  3722. <a class="index-letter" href="elementindex_sloodle.html#q">q</a>
  3723. <a class="index-letter" href="elementindex_sloodle.html#r">r</a>
  3724. <a class="index-letter" href="elementindex_sloodle.html#s">s</a>
  3725. <a class="index-letter" href="elementindex_sloodle.html#t">t</a>
  3726. <a class="index-letter" href="elementindex_sloodle.html#u">u</a>
  3727. <a class="index-letter" href="elementindex_sloodle.html#v">v</a>
  3728. <a class="index-letter" href="elementindex_sloodle.html#w">w</a>
  3729. <a class="index-letter" href="elementindex_sloodle.html#_">_</a>
  3730. </div> </body>
  3731. </html>