elementindex.html 243 KB

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