elementindex_sloodle.html 247 KB

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