elementindex.html 267 KB

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