| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156 |
- <?xml version="1.0" encoding="iso-8859-1"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <!-- template designed by Marco Von Ballmoos -->
- <title>File Source for io.php</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- </head>
- <body>
-
<h1>Source for file io.php</h1>
- <p>Documentation is available at <a href="../sloodle/_lib---io.php.html">io.php</a></p>
- <div class="src-code">
- <div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
- <li><div class="src-line"><a name="a2"></a> <span class="src-comm">// This file is part of the Sloodle project (www.sloodle.org) and is released under the GNU GPL v3.</span></div></li>
- <li><div class="src-line"><a name="a3"></a> </div></li>
- <li><div class="src-line"><a name="a4"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a5"></a><span class="src-doc"> * Sloodle input/output library.</span></div></li>
- <li><div class="src-line"><a name="a6"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a7"></a><span class="src-doc"> * Provides general request and response functionality for interacting with in-world LSL scripts.</span></div></li>
- <li><div class="src-line"><a name="a8"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a9"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> sloodle</span></div></li>
- <li><div class="src-line"><a name="a10"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright (c) 2007-8 Sloodle (various contributors)</span></div></li>
- <li><div class="src-line"><a name="a11"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3</span></div></li>
- <li><div class="src-line"><a name="a12"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@since</span><span class="src-doc"> Sloodle 0.2</span></div></li>
- <li><div class="src-line"><a name="a13"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a14"></a><span class="src-doc"> * </span><span class="src-doc-tag">@contributor</span><span class="src-doc"> Peter R. Bloomfield</span></div></li>
- <li><div class="src-line"><a name="a15"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a16"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a17"></a> </div></li>
- <li><div class="src-line"><a name="a18"></a> </div></li>
- <li><div class="src-line"><a name="a19"></a> <span class="src-comm">// NOTE: this file requires that the Sloodle "config.php" file already be included</span></div></li>
- <li><div class="src-line"><a name="a20"></a> </div></li>
- <li><div class="src-line"><a name="a21"></a> <span class="src-doc">/** Include our general library. */</span></div></li>
- <li><div class="src-line"><a name="a22"></a> <span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">SLOODLE_DIRROOT </span>. <span class="src-str">'/lib/general.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a23"></a> </div></li>
- <li><div class="src-line"><a name="a24"></a> </div></li>
- <li><div class="src-line"><a name="a25"></a> <span class="src-doc">/** Defines the HTTP parameter name for a Sloodle password. */</span></div></li>
- <li><div class="src-line"><a name="a26"></a> <a href="http://www.php.net/define">define</a><span class="src-sym">(</span><span class="src-str">'SLOODLE_PARAM_PASSWORD'</span><span class="src-sym">, </span><span class="src-str">'sloodlepwd'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a27"></a> <span class="src-doc">/** Defines the HTTP parameter name for a course ID. */</span></div></li>
- <li><div class="src-line"><a name="a28"></a> <a href="http://www.php.net/define">define</a><span class="src-sym">(</span><span class="src-str">'SLOODLE_PARAM_COURSE_ID'</span><span class="src-sym">, </span><span class="src-str">'sloodlecourseid'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a29"></a> <span class="src-doc">/** Defines the HTTP parameter name for a Sloodle controller ID. */</span></div></li>
- <li><div class="src-line"><a name="a30"></a> <a href="http://www.php.net/define">define</a><span class="src-sym">(</span><span class="src-str">'SLOODLE_PARAM_CONTROLLER_ID'</span><span class="src-sym">, </span><span class="src-str">'sloodlecontrollerid'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a31"></a> <span class="src-doc">/** Defines the HTTP parameter name for a module ID. */</span></div></li>
- <li><div class="src-line"><a name="a32"></a> <a href="http://www.php.net/define">define</a><span class="src-sym">(</span><span class="src-str">'SLOODLE_PARAM_MODULE_ID'</span><span class="src-sym">, </span><span class="src-str">'sloodlemoduleid'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a33"></a> <span class="src-doc">/** Defines the HTTP parameter name for an avatar UUID. */</span></div></li>
- <li><div class="src-line"><a name="a34"></a> <a href="http://www.php.net/define">define</a><span class="src-sym">(</span><span class="src-str">'SLOODLE_PARAM_AVATAR_UUID'</span><span class="src-sym">, </span><span class="src-str">'sloodleuuid'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a35"></a> <span class="src-doc">/** Defines the HTTP parameter name for an avatar name. */</span></div></li>
- <li><div class="src-line"><a name="a36"></a> <a href="http://www.php.net/define">define</a><span class="src-sym">(</span><span class="src-str">'SLOODLE_PARAM_AVATAR_NAME'</span><span class="src-sym">, </span><span class="src-str">'sloodleavname'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a37"></a> </div></li>
- <li><div class="src-line"><a name="a38"></a> <span class="src-doc">/** Defines the HTTP parameter name for a request descriptor. */</span></div></li>
- <li><div class="src-line"><a name="a39"></a> <a href="http://www.php.net/define">define</a><span class="src-sym">(</span><span class="src-str">'SLOODLE_PARAM_REQUEST_DESC'</span><span class="src-sym">, </span><span class="src-str">'sloodlerequestdesc'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a40"></a> <span class="src-doc">/** Defines the HTTP parameter name for indicating a request which relates to an object instead of a user. */</span></div></li>
- <li><div class="src-line"><a name="a41"></a> <a href="http://www.php.net/define">define</a><span class="src-sym">(</span><span class="src-str">'SLOODLE_PARAM_IS_OBJECT'</span><span class="src-sym">, </span><span class="src-str">'sloodleisobject'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a42"></a> <span class="src-doc">/** Defines the HTTP parameter name for specifying server access level. */</span></div></li>
- <li><div class="src-line"><a name="a43"></a> <a href="http://www.php.net/define">define</a><span class="src-sym">(</span><span class="src-str">'SLOODLE_PARAM_SERVER_ACCESS_LEVEL'</span><span class="src-sym">, </span><span class="src-str">'sloodleserveraccesslevel'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a44"></a> </div></li>
- <li><div class="src-line"><a name="a45"></a> </div></li>
- <li><div class="src-line"><a name="a46"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a47"></a><span class="src-doc"> * A helper class to validate and structure data for output according to the </span><span class="src-doc-inlinetag">{@link http://slisweb.sjsu.edu/sl/index.php/Sloodle_communications_specification Sloodle communications specification}</span><span class="src-doc">.</span></div></li>
- <li><div class="src-line"><a name="a48"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> sloodle</span></div></li>
- <li><div class="src-line"><a name="a49"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a50"></a> <span class="src-key">class </span><a href="../sloodle/SloodleResponse.html">SloodleResponse</a></div></li>
- <li><div class="src-line"><a name="a51"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a52"></a> <span class="src-comm">// DATA //</span></div></li>
- <li><div class="src-line"><a name="a53"></a> </div></li>
- <li><div class="src-line"><a name="a54"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a55"></a><span class="src-doc"> * The separation string between lines of the response (typically just a newline).</span></div></li>
- <li><div class="src-line"><a name="a56"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">string </span></div></li>
- <li><div class="src-line"><a name="a57"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a58"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a59"></a> <span class="src-key">var </span><a href="../sloodle/SloodleResponse.html#var$line_separator">$line_separator</a> = <span class="src-str">"\n"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a60"></a> </div></li>
- <li><div class="src-line"><a name="a61"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a62"></a><span class="src-doc"> * The separation string between fields of a response line (by default, a pipe character |).</span></div></li>
- <li><div class="src-line"><a name="a63"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">string </span></div></li>
- <li><div class="src-line"><a name="a64"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a65"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a66"></a> <span class="src-key">var </span><a href="../sloodle/SloodleResponse.html#var$field_separator">$field_separator</a> = <span class="src-str">"|"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a67"></a> </div></li>
- <li><div class="src-line"><a name="a68"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a69"></a><span class="src-doc"> * Integer status code of the response.</span></div></li>
- <li><div class="src-line"><a name="a70"></a><span class="src-doc"> * Refer to the </span><span class="src-doc-inlinetag">{@link http://slisweb.sjsu.edu/sl/index.php/Sloodle_status_codes status codes}</span><span class="src-doc"> page on the Sloodle wiki for a reference.</span></div></li>
- <li><div class="src-line"><a name="a71"></a><span class="src-doc"> * <b>Required.</b></span></div></li>
- <li><div class="src-line"><a name="a72"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">int </span></div></li>
- <li><div class="src-line"><a name="a73"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a74"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a75"></a> <span class="src-key">var </span><a href="../sloodle/SloodleResponse.html#var$status_code">$status_code</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a76"></a> </div></li>
- <li><div class="src-line"><a name="a77"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a78"></a><span class="src-doc"> * Status descriptor string.</span></div></li>
- <li><div class="src-line"><a name="a79"></a><span class="src-doc"> * Should contain a generalised description/category of the status code.</span></div></li>
- <li><div class="src-line"><a name="a80"></a><span class="src-doc"> * <b>Optional but recommended. Ignored if null.</b></span></div></li>
- <li><div class="src-line"><a name="a81"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">string </span></div></li>
- <li><div class="src-line"><a name="a82"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a83"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a84"></a> <span class="src-key">var </span><a href="../sloodle/SloodleResponse.html#var$status_descriptor">$status_descriptor</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a85"></a> </div></li>
- <li><div class="src-line"><a name="a86"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a87"></a><span class="src-doc"> * Integer side effect(s) codes.</span></div></li>
- <li><div class="src-line"><a name="a88"></a><span class="src-doc"> * Status code(s) of side effect(s) incurred during the operation.</span></div></li>
- <li><div class="src-line"><a name="a89"></a><span class="src-doc"> * Can be a single integer, or an array of integers.</span></div></li>
- <li><div class="src-line"><a name="a90"></a><span class="src-doc"> * <b>Optional. Ignored if null.</b></span></div></li>
- <li><div class="src-line"><a name="a91"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">mixed </span></div></li>
- <li><div class="src-line"><a name="a92"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a93"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a94"></a> <span class="src-key">var </span><a href="../sloodle/SloodleResponse.html#var$side_effects">$side_effects</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a95"></a> </div></li>
- <li><div class="src-line"><a name="a96"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a97"></a><span class="src-doc"> * Request descriptor.</span></div></li>
- <li><div class="src-line"><a name="a98"></a><span class="src-doc"> * A brief string passed into the request by an LSL script (via HTTP parameter 'sloodlerequestdesc'),</span></div></li>
- <li><div class="src-line"><a name="a99"></a><span class="src-doc"> * which is returned so that it can correctly distinguish one request from anotehr.</span></div></li>
- <li><div class="src-line"><a name="a100"></a><span class="src-doc"> * <b>Optional. Ignored if null.</b></span></div></li>
- <li><div class="src-line"><a name="a101"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">string </span></div></li>
- <li><div class="src-line"><a name="a102"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a103"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a104"></a> <span class="src-key">var </span><a href="../sloodle/SloodleResponse.html#var$request_descriptor">$request_descriptor</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a105"></a> </div></li>
- <li><div class="src-line"><a name="a106"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a107"></a><span class="src-doc"> * Timestamp when the request was originally made by the LSL script.</span></div></li>
- <li><div class="src-line"><a name="a108"></a><span class="src-doc"> * This is <i>not</i> filled-in automatically. You must do it manually if you need it.</span></div></li>
- <li><div class="src-line"><a name="a109"></a><span class="src-doc"> * <b>Optional. Ignored if null.</b></span></div></li>
- <li><div class="src-line"><a name="a110"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">integer </span></div></li>
- <li><div class="src-line"><a name="a111"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a112"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a113"></a> <span class="src-key">var </span><a href="../sloodle/SloodleResponse.html#var$request_timestamp">$request_timestamp</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a114"></a> </div></li>
- <li><div class="src-line"><a name="a115"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a116"></a><span class="src-doc"> * Timestamp when the response was generated on the Moodle site.</span></div></li>
- <li><div class="src-line"><a name="a117"></a><span class="src-doc"> * This is <i>not</i> filled-in automatically. You must do it manually if you need it.</span></div></li>
- <li><div class="src-line"><a name="a118"></a><span class="src-doc"> * <b>Optional. Ignored if null.</b></span></div></li>
- <li><div class="src-line"><a name="a119"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">integer </span></div></li>
- <li><div class="src-line"><a name="a120"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a121"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a122"></a> <span class="src-key">var </span><a href="../sloodle/SloodleResponse.html#var$response_timestamp">$response_timestamp</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a123"></a> </div></li>
- <li><div class="src-line"><a name="a124"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a125"></a><span class="src-doc"> * Avatar UUID.</span></div></li>
- <li><div class="src-line"><a name="a126"></a><span class="src-doc"> * Should be a string specifying the UUID key of the agent in-world being handled. (Typically of the user who initiated the request).</span></div></li>
- <li><div class="src-line"><a name="a127"></a><span class="src-doc"> * <b>Optional. Ignored if null.</b></span></div></li>
- <li><div class="src-line"><a name="a128"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">string </span></div></li>
- <li><div class="src-line"><a name="a129"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a130"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a131"></a> <span class="src-key">var </span><a href="../sloodle/SloodleResponse.html#var$avatar_uuid">$avatar_uuid</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a132"></a> </div></li>
- <li><div class="src-line"><a name="a133"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a134"></a><span class="src-doc"> * Tracking code of the request.</span></div></li>
- <li><div class="src-line"><a name="a135"></a><span class="src-doc"> * Use of this value is undefined. Please do not use it.</span></div></li>
- <li><div class="src-line"><a name="a136"></a><span class="src-doc"> * <b>Optional. Ignored if null.</b></span></div></li>
- <li><div class="src-line"><a name="a137"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">mixed </span></div></li>
- <li><div class="src-line"><a name="a138"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a139"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a140"></a> <span class="src-key">var </span><a href="../sloodle/SloodleResponse.html#var$tracking_code">$tracking_code</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a141"></a> </div></li>
- <li><div class="src-line"><a name="a142"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a143"></a><span class="src-doc"> * Total number of pages.</span></div></li>
- <li><div class="src-line"><a name="a144"></a><span class="src-doc"> * If a response requires multiple pages, this value indicates how many pages there are.</span></div></li>
- <li><div class="src-line"><a name="a145"></a><span class="src-doc"> * <b>Optional, unless $page_number is specified. Ignored if null.</b> <i>Not yet supported.</i></span></div></li>
- <li><div class="src-line"><a name="a146"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">integer </span></div></li>
- <li><div class="src-line"><a name="a147"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a148"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a149"></a> <span class="src-key">var </span><a href="../sloodle/SloodleResponse.html#var$page_total">$page_total</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a150"></a> </div></li>
- <li><div class="src-line"><a name="a151"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a152"></a><span class="src-doc"> * Current page number.</span></div></li>
- <li><div class="src-line"><a name="a153"></a><span class="src-doc"> * If a response requires multiple pages, this value indicates which page is being returned in this response.</span></div></li>
- <li><div class="src-line"><a name="a154"></a><span class="src-doc"> * <b>Optional, unless $page_total is specified. Ignored if null.</b> <i>Not yet supported.</i></span></div></li>
- <li><div class="src-line"><a name="a155"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">integer </span></div></li>
- <li><div class="src-line"><a name="a156"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a157"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a158"></a> <span class="src-key">var </span><a href="../sloodle/SloodleResponse.html#var$page_number">$page_number</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a159"></a> </div></li>
- <li><div class="src-line"><a name="a160"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a161"></a><span class="src-doc"> * Data to render following the status line in the response.</span></div></li>
- <li><div class="src-line"><a name="a162"></a><span class="src-doc"> * This value can either be a scalar (single value, e.g. int, string, float), or an array.</span></div></li>
- <li><div class="src-line"><a name="a163"></a><span class="src-doc"> * If it is a single scalar, it is rendered as a single line.</span></div></li>
- <li><div class="src-line"><a name="a164"></a><span class="src-doc"> * If it is an array, then each element becomes one line.</span></div></li>
- <li><div class="src-line"><a name="a165"></a><span class="src-doc"> * If an element is a scalar, then it is directly output onto the line.</span></div></li>
- <li><div class="src-line"><a name="a166"></a><span class="src-doc"> * If an element is an array, then each child element is output as a separate field on the same line.</span></div></li>
- <li><div class="src-line"><a name="a167"></a><span class="src-doc"> * <b>Optional. Ignored if null.</b></span></div></li>
- <li><div class="src-line"><a name="a168"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> SloodleResponse::set_data()</span></div></li>
- <li><div class="src-line"><a name="a169"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> SloodleResponse::add_data_line()</span></div></li>
- <li><div class="src-line"><a name="a170"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> SloodleResponse::clear_data()</span></div></li>
- <li><div class="src-line"><a name="a171"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">mixed </span></div></li>
- <li><div class="src-line"><a name="a172"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a173"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a174"></a> <span class="src-key">var </span><a href="../sloodle/SloodleResponse.html#var$data">$data</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a175"></a> </div></li>
- <li><div class="src-line"><a name="a176"></a> </div></li>
- <li><div class="src-line"><a name="a177"></a> <span class="src-comm">// ACCESSORS //</span></div></li>
- <li><div class="src-line"><a name="a178"></a> </div></li>
- <li><div class="src-line"><a name="a179"></a> </div></li>
- <li><div class="src-line"><a name="a180"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a181"></a><span class="src-doc"> * Sets the line separator.</span></div></li>
- <li><div class="src-line"><a name="a182"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$sep </span><span class="src-doc">A string to separate lines</span></div></li>
- <li><div class="src-line"><a name="a183"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a184"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a185"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodset_line_separator">set_line_separator</a><span class="src-sym">(</span><span class="src-var">$sep</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a186"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a187"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$line_separator">line_separator</a> = <span class="src-var">$sep</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a188"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a189"></a> </div></li>
- <li><div class="src-line"><a name="a190"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a191"></a><span class="src-doc"> * Gets the line separator.</span></div></li>
- <li><div class="src-line"><a name="a192"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc">The current line separator string</span></div></li>
- <li><div class="src-line"><a name="a193"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a194"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodget_line_separator">get_line_separator</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a195"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a196"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$line_separator">line_separator</a><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a197"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a198"></a> </div></li>
- <li><div class="src-line"><a name="a199"></a> </div></li>
- <li><div class="src-line"><a name="a200"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a201"></a><span class="src-doc"> * Sets the field separator.</span></div></li>
- <li><div class="src-line"><a name="a202"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$sep </span><span class="src-doc">A string to separate fields</span></div></li>
- <li><div class="src-line"><a name="a203"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a204"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a205"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodset_field_separator">set_field_separator</a><span class="src-sym">(</span><span class="src-var">$sep</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a206"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a207"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a> = <span class="src-var">$sep</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a208"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a209"></a> </div></li>
- <li><div class="src-line"><a name="a210"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a211"></a><span class="src-doc"> * Gets the field separator.</span></div></li>
- <li><div class="src-line"><a name="a212"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc">The current field separator string</span></div></li>
- <li><div class="src-line"><a name="a213"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a214"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodget_field_separator">get_field_separator</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a215"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a216"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a217"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a218"></a> </div></li>
- <li><div class="src-line"><a name="a219"></a> </div></li>
- <li><div class="src-line"><a name="a220"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a221"></a><span class="src-doc"> * Accessor function to set member value </span><span class="src-doc-inlinetag">{@link $status_code}</span></div></li>
- <li><div class="src-line"><a name="a222"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$par </span><span class="src-doc">A non-zero status code</span></div></li>
- <li><div class="src-line"><a name="a223"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a224"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a225"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodset_status_code">set_status_code</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a226"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a227"></a> <span class="src-comm">// Validate</span></div></li>
- <li><div class="src-line"><a name="a228"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_int">is_int</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false </span>|| <span class="src-var">$par </span>== <span class="src-num">0</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a229"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: invalid status code specified; should be non-zero integer"</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a230"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a231"></a> <span class="src-comm">// Store</span></div></li>
- <li><div class="src-line"><a name="a232"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$status_code">status_code</a> = <span class="src-var">$par</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a233"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a234"></a> </div></li>
- <li><div class="src-line"><a name="a235"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a236"></a><span class="src-doc"> * Accessor function to set member value </span><span class="src-doc-inlinetag">{@link $status_descriptor}</span></div></li>
- <li><div class="src-line"><a name="a237"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$par </span><span class="src-doc">A status descriptor string, or null to clear it</span></div></li>
- <li><div class="src-line"><a name="a238"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a239"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a240"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodset_status_descriptor">set_status_descriptor</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a241"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a242"></a> <span class="src-comm">// Validate</span></div></li>
- <li><div class="src-line"><a name="a243"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_string">is_string</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false </span>&& <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a244"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: invalid status descriptor specified; should be a string or null"</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a245"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a246"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$status_descriptor">status_descriptor</a> = <span class="src-var">$par</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a247"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a248"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a249"></a> </div></li>
- <li><div class="src-line"><a name="a250"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a251"></a><span class="src-doc"> * Accessor function to set member value </span><span class="src-doc-inlinetag">{@link $side_effects}</span><span class="src-doc">. <b>Note:</b> it is recommended that you use </span><span class="src-doc-inlinetag">{@link add_side_effect()}</span><span class="src-doc"> or </span><span class="src-doc-inlinetag">{@link add_side_effects()}</span><span class="src-doc"> instead.</span></div></li>
- <li><div class="src-line"><a name="a252"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$par </span><span class="src-doc">An integer side effect code, an array of integer side effect codes, or null to clear it</span></div></li>
- <li><div class="src-line"><a name="a253"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a254"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a255"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodset_side_effects">set_side_effects</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a256"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a257"></a> <span class="src-comm">// We'll use a variable to store the validity</span></div></li>
- <li><div class="src-line"><a name="a258"></a> <span class="src-var">$valid </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a259"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_array">is_array</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a260"></a> <span class="src-comm">// Array types are acceptable</span></div></li>
- <li><div class="src-line"><a name="a261"></a> <span class="src-comm">// Make sure each array element is valid</span></div></li>
- <li><div class="src-line"><a name="a262"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$par </span><span class="src-key">as </span><span class="src-var">$elem</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a263"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/is_int">is_int</a><span class="src-sym">(</span><span class="src-var">$elem</span><span class="src-sym">)) </span><span class="src-var">$valid </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a264"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a265"></a> <span class="src-comm">// Were all elements valid?</span></div></li>
- <li><div class="src-line"><a name="a266"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$valid </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a267"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: invalid element in array of side effect codes; all elements should be integers"</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a268"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a269"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_int">is_int</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false </span>&& <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a270"></a> <span class="src-comm">// It's not an array, an integer or null</span></div></li>
- <li><div class="src-line"><a name="a271"></a> <span class="src-var">$valid </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a272"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: invalid side effect type; should be an integer, an array of integers, or null"</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a273"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a274"></a> <span class="src-comm">// Was it valid?</span></div></li>
- <li><div class="src-line"><a name="a275"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$valid</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a276"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$side_effects">side_effects</a> = <span class="src-var">$par</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a277"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a278"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a279"></a> </div></li>
- <li><div class="src-line"><a name="a280"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a281"></a><span class="src-doc"> * Adds one or more integer side effect codes to member </span><span class="src-doc-inlinetag">{@link $status_code}</span><span class="src-doc">.</span></div></li>
- <li><div class="src-line"><a name="a282"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$par </span><span class="src-doc">An integer side effect code, or an array of them.</span></div></li>
- <li><div class="src-line"><a name="a283"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a284"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a285"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodadd_side_effects">add_side_effects</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a286"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a287"></a> <span class="src-comm">// We'll use a variable to store the validity</span></div></li>
- <li><div class="src-line"><a name="a288"></a> <span class="src-var">$valid </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a289"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_array">is_array</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a290"></a> <span class="src-comm">// Array types are acceptable</span></div></li>
- <li><div class="src-line"><a name="a291"></a> <span class="src-comm">// Make sure each array element is valid</span></div></li>
- <li><div class="src-line"><a name="a292"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$par </span><span class="src-key">as </span><span class="src-var">$elem</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a293"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/is_int">is_int</a><span class="src-sym">(</span><span class="src-var">$elem</span><span class="src-sym">)) </span><span class="src-var">$valid </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a294"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a295"></a> <span class="src-comm">// Were all elements valid?</span></div></li>
- <li><div class="src-line"><a name="a296"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$valid </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a297"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: cannot add side effects. Invalid element in array of side effect codes. All elements should be integers"</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a298"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a299"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_int">is_int</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a300"></a> <span class="src-comm">// It's not an array or an integer</span></div></li>
- <li><div class="src-line"><a name="a301"></a> <span class="src-var">$valid </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a302"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: cannot add side effect. Invalid side effect type. should be an integer or an array of integers"</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a303"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a304"></a> <span class="src-comm">// Was it valid?</span></div></li>
- <li><div class="src-line"><a name="a305"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$valid</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a306"></a> <span class="src-comm">// If we were passed just a single side effect, then convert it to an array</span></div></li>
- <li><div class="src-line"><a name="a307"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_int">is_int</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a308"></a> <span class="src-var">$par </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a309"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a310"></a> <span class="src-comm">// Make sure our existing side effect member is an array</span></div></li>
- <li><div class="src-line"><a name="a311"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$side_effects">side_effects</a><span class="src-sym">)) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$side_effects">side_effects</a> = <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a312"></a> <span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_int">is_int</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$side_effects">side_effects</a><span class="src-sym">)) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$side_effects">side_effects</a> = <span class="src-key">array</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$side_effects">side_effects</a><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a313"></a> </div></li>
- <li><div class="src-line"><a name="a314"></a> <span class="src-comm">// Append our new side effect(s) </span></div></li>
- <li><div class="src-line"><a name="a315"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$par </span><span class="src-key">as </span><span class="src-var">$cur</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a316"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$side_effects">side_effects</a><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-var">$cur</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a317"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a318"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a319"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a320"></a> </div></li>
- <li><div class="src-line"><a name="a321"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a322"></a><span class="src-doc"> * Adds a single side effect code to member </span><span class="src-doc-inlinetag">{@link $status_code}</span></div></li>
- <li><div class="src-line"><a name="a323"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$par </span><span class="src-doc">An integer side-effect code.</span></div></li>
- <li><div class="src-line"><a name="a324"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a325"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a326"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodadd_side_effect">add_side_effect</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a327"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a328"></a> <span class="src-comm">// Make sure the parameter is valid</span></div></li>
- <li><div class="src-line"><a name="a329"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/is_int">is_int</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">))</span></div></li>
- <li><div class="src-line"><a name="a330"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: cannot add side effect. Invalid side effect type. Should be an integer."</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a331"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#methodadd_side_effects">add_side_effects</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a332"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a333"></a> </div></li>
- <li><div class="src-line"><a name="a334"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a335"></a><span class="src-doc"> * Accessor function to set member value </span><span class="src-doc-inlinetag">{@link $request_descriptor}</span></div></li>
- <li><div class="src-line"><a name="a336"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$par </span><span class="src-doc">A string request descriptor, or null to clear it</span></div></li>
- <li><div class="src-line"><a name="a337"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a338"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a339"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodset_request_descriptor">set_request_descriptor</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a340"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a341"></a> <span class="src-comm">// Validate</span></div></li>
- <li><div class="src-line"><a name="a342"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_string">is_string</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false </span>&& <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a343"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: invalid request descriptor specified; should be a string or null"</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a344"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a345"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$request_descriptor">request_descriptor</a> = <span class="src-var">$par</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a346"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a347"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a348"></a> </div></li>
- <li><div class="src-line"><a name="a349"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a350"></a><span class="src-doc"> * Accessor function to set member value </span><span class="src-doc-inlinetag">{@link $request_timestamp}</span></div></li>
- <li><div class="src-line"><a name="a351"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$par </span><span class="src-doc">An integer timestamp, or null to clear it</span></div></li>
- <li><div class="src-line"><a name="a352"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a353"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a354"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodset_request_timestamp">set_request_timestamp</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a355"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a356"></a> <span class="src-comm">// Validate</span></div></li>
- <li><div class="src-line"><a name="a357"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_int">is_int</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false </span>&& <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a358"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: invalid request timestamp; should be an integer, or null"</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a359"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a360"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$request_timestamp">request_timestamp</a> = <span class="src-var">$par</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a361"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a362"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a363"></a> </div></li>
- <li><div class="src-line"><a name="a364"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a365"></a><span class="src-doc"> * Accessor function to set member value </span><span class="src-doc-inlinetag">{@link $response_timestamp}</span></div></li>
- <li><div class="src-line"><a name="a366"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$par </span><span class="src-doc">An integer timestamp, or null to clear it</span></div></li>
- <li><div class="src-line"><a name="a367"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a368"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a369"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodset_response_timestamp">set_response_timestamp</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a370"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a371"></a> <span class="src-comm">// Validate</span></div></li>
- <li><div class="src-line"><a name="a372"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_int">is_int</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false </span>&& <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a373"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: invalid response timestamp; should be an integer, or null"</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a374"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a375"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$response_timestamp">response_timestamp</a> = <span class="src-var">$par</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a376"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a377"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a378"></a> </div></li>
- <li><div class="src-line"><a name="a379"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a380"></a><span class="src-doc"> * Accessor function to set member value </span><span class="src-doc-inlinetag">{@link $avatar_uuid}</span></div></li>
- <li><div class="src-line"><a name="a381"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$par </span><span class="src-doc">A string containing a UUID, or null to clear it</span></div></li>
- <li><div class="src-line"><a name="a382"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a383"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a384"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodset_avatar_uuid">set_avatar_uuid</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a385"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a386"></a> <span class="src-comm">// Validate</span></div></li>
- <li><div class="src-line"><a name="a387"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_string">is_string</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false </span>&& <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a388"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: invalid avatar UUID specified; should be a string or null"</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a389"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a390"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$avatar_uuid">avatar_uuid</a> = <span class="src-var">$par</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a391"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a392"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a393"></a> </div></li>
- <li><div class="src-line"><a name="a394"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a395"></a><span class="src-doc"> * Accessor function to set member value </span><span class="src-doc-inlinetag">{@link $tracking_code}</span></div></li>
- <li><div class="src-line"><a name="a396"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$par </span><span class="src-doc">Any scalar value</span></div></li>
- <li><div class="src-line"><a name="a397"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a398"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a399"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodset_tracking_code">set_tracking_code</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a400"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a401"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$tracking_code">tracking_code</a> = <span class="src-var">$par</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a402"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a403"></a> </div></li>
- <li><div class="src-line"><a name="a404"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a405"></a><span class="src-doc"> * Accessor function to set member value </span><span class="src-doc-inlinetag">{@link $page_total}</span></div></li>
- <li><div class="src-line"><a name="a406"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$par </span><span class="src-doc">A positive page total count, or null to clear it</span></div></li>
- <li><div class="src-line"><a name="a407"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a408"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a409"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodset_page_total">set_page_total</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a410"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a411"></a> <span class="src-comm">// Validate</span></div></li>
- <li><div class="src-line"><a name="a412"></a> <span class="src-key">if </span><span class="src-sym">((</span><a href="http://www.php.net/is_int">is_int</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false </span>|| <span class="src-var">$par </span>< <span class="src-num">0</span><span class="src-sym">) </span>&& <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a413"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: invalid page total; should be a positive integer, or null"</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a414"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a415"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$page_total">page_total</a> = <span class="src-var">$par</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a416"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a417"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a418"></a> </div></li>
- <li><div class="src-line"><a name="a419"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a420"></a><span class="src-doc"> * Accessor function to set member value </span><span class="src-doc-inlinetag">{@link $page_number}</span></div></li>
- <li><div class="src-line"><a name="a421"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$par </span><span class="src-doc">A positive page number, or null to clear it</span></div></li>
- <li><div class="src-line"><a name="a422"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a423"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a424"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodset_page_number">set_page_number</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a425"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a426"></a> <span class="src-comm">// Validate</span></div></li>
- <li><div class="src-line"><a name="a427"></a> <span class="src-key">if </span><span class="src-sym">((</span><a href="http://www.php.net/is_int">is_int</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false </span>|| <span class="src-var">$par </span>< <span class="src-num">0</span><span class="src-sym">) </span>&& <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a428"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: invalid page number; should be a positive integer, or null"</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a429"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a430"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$page_number">page_number</a> = <span class="src-var">$par</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a431"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a432"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a433"></a> </div></li>
- <li><div class="src-line"><a name="a434"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a435"></a><span class="src-doc"> * Accessor function to set member value </span><span class="src-doc-inlinetag">{@link $data}</span><span class="src-doc">. <b>Note: it is recommended that you use the </span><span class="src-doc-inlinetag">{@link add_data_line()}</span><span class="src-doc"> and </span><span class="src-doc-inlinetag">{@link clear_data()}</span><span class="src-doc"> functions instead of this.</b></span></div></li>
- <li><div class="src-line"><a name="a436"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$par </span><span class="src-doc">Any scalar value, or a mixed array of scalars or scalar arrays, or null to clear it</span></div></li>
- <li><div class="src-line"><a name="a437"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a438"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a439"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodset_data">set_data</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a440"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a441"></a> <span class="src-comm">// We'll use a variable to store validity</span></div></li>
- <li><div class="src-line"><a name="a442"></a> <span class="src-var">$valid </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a443"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_array">is_array</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a444"></a> <span class="src-comm">// Check each element</span></div></li>
- <li><div class="src-line"><a name="a445"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$par </span><span class="src-key">as </span><span class="src-var">$elem</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a446"></a> <span class="src-comm">// Is this element another array? Or is it a scalar/null value?</span></div></li>
- <li><div class="src-line"><a name="a447"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_array">is_array</a><span class="src-sym">(</span><span class="src-var">$elem</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a448"></a> <span class="src-comm">// Check each inner element for validity</span></div></li>
- <li><div class="src-line"><a name="a449"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$elem </span><span class="src-key">as </span><span class="src-var">$innerelem</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a450"></a> <span class="src-comm">// Is this element scalar or null? If not, it is invalid</span></div></li>
- <li><div class="src-line"><a name="a451"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_scalar">is_scalar</a><span class="src-sym">(</span><span class="src-var">$innerelem</span><span class="src-sym">) </span>== <span class="src-id">false </span>&& <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$innerelem</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a452"></a> <span class="src-var">$valid </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a453"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a454"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a455"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_scalar">is_scalar</a><span class="src-sym">(</span><span class="src-var">$elem</span><span class="src-sym">) </span>== <span class="src-id">false </span>&& <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$elem</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a456"></a> <span class="src-comm">// Not an array, nor a scalar/null value - it is invalid</span></div></li>
- <li><div class="src-line"><a name="a457"></a> <span class="src-var">$valid </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a458"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a459"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a460"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$valid </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a461"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: non-scalar element in array of items for a data line"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a462"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a463"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_scalar">is_scalar</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false </span>&& <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a464"></a> <span class="src-var">$valid </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a465"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: each line of data must be a scalar type, or an array of scalars"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a466"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a467"></a> <span class="src-comm">// Store it if it is valid</span></div></li>
- <li><div class="src-line"><a name="a468"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$valid</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a469"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$data">data</a> = <span class="src-var">$par</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a470"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a471"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a472"></a> </div></li>
- <li><div class="src-line"><a name="a473"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a474"></a><span class="src-doc"> * Adds one line of data to the </span><span class="src-doc-inlinetag">{@link $data}</span><span class="src-doc"> member</span></div></li>
- <li><div class="src-line"><a name="a475"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$par </span><span class="src-doc">A scalar, or an array of scalars</span></div></li>
- <li><div class="src-line"><a name="a476"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a477"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a478"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodadd_data_line">add_data_line</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a479"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a480"></a> <span class="src-comm">// We'll use a variable to store validity</span></div></li>
- <li><div class="src-line"><a name="a481"></a> <span class="src-var">$valid </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a482"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_array">is_array</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a483"></a> <span class="src-comm">// Check each element</span></div></li>
- <li><div class="src-line"><a name="a484"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$par </span><span class="src-key">as </span><span class="src-var">$elem</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a485"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_scalar">is_scalar</a><span class="src-sym">(</span><span class="src-var">$elem</span><span class="src-sym">) </span>== <span class="src-id">false </span>&& <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$elem</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-var">$valid </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a486"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a487"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$valid </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a488"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: non-scalar element in array of items for a data line"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a489"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a490"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_scalar">is_scalar</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false </span>&& <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a491"></a> <span class="src-var">$valid </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a492"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: each line of data must be a scalar type, or an array of scalars"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a493"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a494"></a> <span class="src-comm">// Store it if it is valid</span></div></li>
- <li><div class="src-line"><a name="a495"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$valid</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a496"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$data">data</a><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-var">$par</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a497"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a498"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a499"></a> </div></li>
- <li><div class="src-line"><a name="a500"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a501"></a><span class="src-doc"> * Clears all data from member </span><span class="src-doc-inlinetag">{@link $data}</span></div></li>
- <li><div class="src-line"><a name="a502"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a503"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a504"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodclear_data">clear_data</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a505"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a506"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$data">data</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a507"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a508"></a> </div></li>
- <li><div class="src-line"><a name="a509"></a> </div></li>
- <li><div class="src-line"><a name="a510"></a> <span class="src-comm">// OTHER FUNCTIONS //</span></div></li>
- <li><div class="src-line"><a name="a511"></a> </div></li>
- <li><div class="src-line"><a name="a512"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a513"></a><span class="src-doc"> * <i>Constructor</i> - can intialise some variables</span></div></li>
- <li><div class="src-line"><a name="a514"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc-var">$status_code </span><span class="src-doc">The initial status code for the response (optional - ignore if null)</span></div></li>
- <li><div class="src-line"><a name="a515"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$status_descriptor </span><span class="src-doc">The initial status descriptor for the response (optional - ignore if null)</span></div></li>
- <li><div class="src-line"><a name="a516"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$data </span><span class="src-doc">The initial data for the response, which can be a scalar, or a mixed array of scalars/scalar-arrays (see </span><span class="src-doc-inlinetag">{@link SloodleResponse::$data}</span><span class="src-doc">) (optional - ignore if null)</span></div></li>
- <li><div class="src-line"><a name="a517"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a518"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
- <li><div class="src-line"><a name="a519"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a520"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodSloodleResponse">SloodleResponse</a><span class="src-sym">(</span><span class="src-var">$status_code </span>= <span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$status_descriptor </span>= <span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$data </span>= <span class="src-id">null</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a521"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a522"></a> <span class="src-comm">// Store the data</span></div></li>
- <li><div class="src-line"><a name="a523"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$status_code</span><span class="src-sym">)) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$status_code">status_code</a> = (int)<span class="src-var">$status_code</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a524"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$status_descriptor</span><span class="src-sym">)) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$status_descriptor">status_descriptor</a> = (string)<span class="src-var">$status_descriptor</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a525"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$data</span><span class="src-sym">)) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$data">data</a> = <span class="src-var">$data</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a526"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a527"></a> </div></li>
- <li><div class="src-line"><a name="a528"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a529"></a><span class="src-doc"> * Renders the response to a string.</span></div></li>
- <li><div class="src-line"><a name="a530"></a><span class="src-doc"> * Prior to rendering, this function will perform final validation on all the data.</span></div></li>
- <li><div class="src-line"><a name="a531"></a><span class="src-doc"> * If anything fails, then the script will terminate with an LSL-friendly error message.</span></div></li>
- <li><div class="src-line"><a name="a532"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a533"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">&$str </span><span class="src-doc">Reference to a string object which the response should be rendered to.</span></div></li>
- <li><div class="src-line"><a name="a534"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a535"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
- <li><div class="src-line"><a name="a536"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a537"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodrender_to_string">render_to_string</a><span class="src-sym">(</span><span class="src-sym">&</span><span class="src-var">$str</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a538"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a539"></a> <span class="src-comm">// Clear the string</span></div></li>
- <li><div class="src-line"><a name="a540"></a> <span class="src-var">$str </span>= <span class="src-str">""</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a541"></a> </div></li>
- <li><div class="src-line"><a name="a542"></a> <span class="src-comm">// We can omit any unnecessary items of data, but the number of field-separators must be correct</span></div></li>
- <li><div class="src-line"><a name="a543"></a> <span class="src-comm">// E.g. if item 4 is specified, but items 2 and 3 are not, then empty field-separators must be output as if items 2 and 3 were present, e.g.:</span></div></li>
- <li><div class="src-line"><a name="a544"></a> <span class="src-comm">// 1|||AVATAR_LIST</span></div></li>
- <li><div class="src-line"><a name="a545"></a> <span class="src-comm">// (where the pipe-character | is the field separator)</span></div></li>
- <li><div class="src-line"><a name="a546"></a> </div></li>
- <li><div class="src-line"><a name="a547"></a> <span class="src-comm">// We will step backwards through out list of fields, and as soon as one item is specified, all of them should be</span></div></li>
- <li><div class="src-line"><a name="a548"></a> <span class="src-var">$showall </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a549"></a> <span class="src-comm">// Make sure that if the page number is specified, that the total is as well</span></div></li>
- <li><div class="src-line"><a name="a550"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$page_number">page_number</a><span class="src-sym">) </span><span class="src-key">xor </span><a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$page_total">page_total</a><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a551"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: script must specify both \"page_total\" *and* \"page_number\", or specify neither"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a552"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$showall </span>|| <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$page_number">page_number</a><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a553"></a> <span class="src-var">$showall </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a554"></a> <span class="src-var">$str </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a> . (string)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$page_total">page_total</a> . <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a> . (string)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$page_number">page_number</a> . <span class="src-var">$str</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a555"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a556"></a> </div></li>
- <li><div class="src-line"><a name="a557"></a> <span class="src-comm">// Do we have a tracking code?</span></div></li>
- <li><div class="src-line"><a name="a558"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$showall </span>|| <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$tracking_code">tracking_code</a><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a559"></a> <span class="src-var">$showall </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a560"></a> <span class="src-var">$str </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a> . (string)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$tracking_code">tracking_code</a> . <span class="src-var">$str</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a561"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a562"></a> </div></li>
- <li><div class="src-line"><a name="a563"></a> <span class="src-comm">// User key?</span></div></li>
- <li><div class="src-line"><a name="a564"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$showall </span>|| <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$avatar_uuid">avatar_uuid</a><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a565"></a> <span class="src-var">$showall </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a566"></a> <span class="src-var">$str </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a> . <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$avatar_uuid">avatar_uuid</a> . <span class="src-var">$str</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a567"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a568"></a> </div></li>
- <li><div class="src-line"><a name="a569"></a> <span class="src-comm">// Response timestamp?</span></div></li>
- <li><div class="src-line"><a name="a570"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$showall </span>|| <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$response_timestamp">response_timestamp</a><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a571"></a> <span class="src-var">$showall </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a572"></a> <span class="src-var">$str </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a> . (string)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$response_timestamp">response_timestamp</a> . <span class="src-var">$str</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a573"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a574"></a> </div></li>
- <li><div class="src-line"><a name="a575"></a> <span class="src-comm">// Request timestamp?</span></div></li>
- <li><div class="src-line"><a name="a576"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$showall </span>|| <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$request_timestamp">request_timestamp</a><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a577"></a> <span class="src-var">$showall </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a578"></a> <span class="src-var">$str </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a> . (string)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$request_timestamp">request_timestamp</a> . <span class="src-var">$str</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a579"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a580"></a> </div></li>
- <li><div class="src-line"><a name="a581"></a> <span class="src-comm">// Request descriptor?</span></div></li>
- <li><div class="src-line"><a name="a582"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$showall </span>|| <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$request_descriptor">request_descriptor</a><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a583"></a> <span class="src-var">$showall </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a584"></a> <span class="src-var">$str </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a> . <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$request_descriptor">request_descriptor</a> . <span class="src-var">$str</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a585"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a586"></a> </div></li>
- <li><div class="src-line"><a name="a587"></a> <span class="src-comm">// Side-effects?</span></div></li>
- <li><div class="src-line"><a name="a588"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$showall </span>|| <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$side_effects">side_effects</a><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a589"></a> <span class="src-var">$showall </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a590"></a> <span class="src-comm">// Is this an array?</span></div></li>
- <li><div class="src-line"><a name="a591"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_array">is_array</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$side_effects">side_effects</a><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a592"></a> <span class="src-comm">// Yes - output each side effect code in a comma-separated list</span></div></li>
- <li><div class="src-line"><a name="a593"></a> <span class="src-var">$selist </span>= <span class="src-str">""</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a594"></a> <span class="src-var">$isfirst </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a595"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$side_effects">side_effects</a> <span class="src-key">as </span><span class="src-var">$cur_side_effect</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a596"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$isfirst</span><span class="src-sym">) </span><span class="src-var">$selist </span>.= <span class="src-str">","</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a597"></a> <span class="src-key">else </span><span class="src-var">$isfirst </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a598"></a> <span class="src-var">$selist </span>.= (string)<span class="src-var">$cur_side_effect</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a599"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a600"></a> <span class="src-comm">// Add that list to the output</span></div></li>
- <li><div class="src-line"><a name="a601"></a> <span class="src-var">$str </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a> . <span class="src-var">$selist </span>. <span class="src-var">$str</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a602"></a> </div></li>
- <li><div class="src-line"><a name="a603"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a604"></a> <span class="src-comm">// Not at an array - output the single item</span></div></li>
- <li><div class="src-line"><a name="a605"></a> <span class="src-var">$str </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a> . (string)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$side_effects">side_effects</a> . <span class="src-var">$str</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a606"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a607"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a608"></a> </div></li>
- <li><div class="src-line"><a name="a609"></a> <span class="src-comm">// Status descriptor?</span></div></li>
- <li><div class="src-line"><a name="a610"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$showall </span>|| <a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$status_descriptor">status_descriptor</a><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a611"></a> <span class="src-var">$showall </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a612"></a> <span class="src-var">$str </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a> . <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$status_descriptor">status_descriptor</a> . <span class="src-var">$str</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a613"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a614"></a> </div></li>
- <li><div class="src-line"><a name="a615"></a> <span class="src-comm">// Ensure that a status code has been specified</span></div></li>
- <li><div class="src-line"><a name="a616"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$status_code">status_code</a><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a617"></a> <span class="src-comm">// Not specified - report an error</span></div></li>
- <li><div class="src-line"><a name="a618"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-str">"Sloodle - LSL response: no status code specified"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a619"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a620"></a> <span class="src-comm">// Output the status code</span></div></li>
- <li><div class="src-line"><a name="a621"></a> <span class="src-var">$str </span>= (string)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$status_code">status_code</a> . <span class="src-var">$str</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a622"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a623"></a> </div></li>
- <li><div class="src-line"><a name="a624"></a> </div></li>
- <li><div class="src-line"><a name="a625"></a> <span class="src-comm">// Has any data been specified?</span></div></li>
- <li><div class="src-line"><a name="a626"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$data">data</a><span class="src-sym">) </span>== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a627"></a> </div></li>
- <li><div class="src-line"><a name="a628"></a> <span class="src-comm">// Do we have an outer array?</span></div></li>
- <li><div class="src-line"><a name="a629"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_array">is_array</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$data">data</a><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a630"></a> </div></li>
- <li><div class="src-line"><a name="a631"></a> <span class="src-comm">// Go through each element in the outer array</span></div></li>
- <li><div class="src-line"><a name="a632"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$data">data</a> <span class="src-key">as </span><span class="src-var">$outer_elem</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a633"></a> </div></li>
- <li><div class="src-line"><a name="a634"></a> <span class="src-comm">// Do we have an inner array on this element?</span></div></li>
- <li><div class="src-line"><a name="a635"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_array">is_array</a><span class="src-sym">(</span><span class="src-var">$outer_elem</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a636"></a> </div></li>
- <li><div class="src-line"><a name="a637"></a> <span class="src-comm">// Construct the line, piece-at-a-time</span></div></li>
- <li><div class="src-line"><a name="a638"></a> <span class="src-var">$line </span>= <span class="src-str">""</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a639"></a> <span class="src-var">$isfirst </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a640"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$outer_elem </span><span class="src-key">as </span><span class="src-var">$inner_elem</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a641"></a> <span class="src-comm">// Use the standard field separator</span></div></li>
- <li><div class="src-line"><a name="a642"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$isfirst</span><span class="src-sym">) </span><span class="src-var">$line </span>.= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a643"></a> <span class="src-key">else </span><span class="src-var">$isfirst </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a644"></a> <span class="src-var">$line </span>.= (string)<span class="src-var">$inner_elem</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a645"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a646"></a> <span class="src-comm">// Append the new line of data</span></div></li>
- <li><div class="src-line"><a name="a647"></a> <span class="src-var">$str </span>.= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$line_separator">line_separator</a> . (string)<span class="src-var">$line</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a648"></a> </div></li>
- <li><div class="src-line"><a name="a649"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a650"></a> <span class="src-comm">// Output the single item</span></div></li>
- <li><div class="src-line"><a name="a651"></a> <span class="src-var">$str </span>.= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$line_separator">line_separator</a> . (string)<span class="src-var">$outer_elem</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a652"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a653"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a654"></a> </div></li>
- <li><div class="src-line"><a name="a655"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a656"></a> <span class="src-comm">// Output the single item</span></div></li>
- <li><div class="src-line"><a name="a657"></a> <span class="src-var">$str </span>.= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$line_separator">line_separator</a> . (string)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$data">data</a><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a658"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a659"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a660"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a661"></a> </div></li>
- <li><div class="src-line"><a name="a662"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a663"></a><span class="src-doc"> * Outputs the response directly to the HTTP response.</span></div></li>
- <li><div class="src-line"><a name="a664"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a665"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
- <li><div class="src-line"><a name="a666"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a667"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@uses</span><span class="src-doc"> SloodleResponse::render_to_string() Outputs the result from this function directly to the HTTP response stream.</span></div></li>
- <li><div class="src-line"><a name="a668"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a669"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodrender_to_output">render_to_output</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a670"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a671"></a> <span class="src-comm">// Attempt to render the output to a string, and then copy that string to the HTTP response</span></div></li>
- <li><div class="src-line"><a name="a672"></a> <span class="src-var">$str </span>= <span class="src-str">""</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a673"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#methodrender_to_string">render_to_string</a><span class="src-sym">(</span><span class="src-var">$str</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a674"></a> echo <span class="src-var">$str</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a675"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a676"></a> </div></li>
- <li><div class="src-line"><a name="a677"></a> </div></li>
- <li><div class="src-line"><a name="a678"></a> <span class="src-comm">// Quick-output</span></div></li>
- <li><div class="src-line"><a name="a679"></a> <span class="src-comm">// Can be called statically to allow simple output of basic data</span></div></li>
- <li><div class="src-line"><a name="a680"></a> <span class="src-comm">// The status code is required, but the other parameters are optional</span></div></li>
- <li><div class="src-line"><a name="a681"></a> <span class="src-comm">// If an error occurs, the LSL-friendly error message is output to the HTTP response, and the script terminated</span></div></li>
- <li><div class="src-line"><a name="a682"></a> <span class="src-comm">// If $static is true (default) then this will be treated as a static call, and a new response object will be used</span></div></li>
- <li><div class="src-line"><a name="a683"></a> <span class="src-comm">// If $static is false then this is treated as adding data to an existing response object</span></div></li>
- <li><div class="src-line"><a name="a684"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a685"></a><span class="src-doc"> * Quick output of data to avoid several accessor calls if the response is very basic.</span></div></li>
- <li><div class="src-line"><a name="a686"></a><span class="src-doc"> * Can be called statically to allow simple output of basic data.</span></div></li>
- <li><div class="src-line"><a name="a687"></a><span class="src-doc"> * The status code is required, but the other parameters are optional</span></div></li>
- <li><div class="src-line"><a name="a688"></a><span class="src-doc"> * If an error occurs, the LSL-friendly error message is output to the HTTP response, and the script terminated</span></div></li>
- <li><div class="src-line"><a name="a689"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a690"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc-var">$status_code </span><span class="src-doc">The status code for the response (required)</span></div></li>
- <li><div class="src-line"><a name="a691"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$status_descriptor </span><span class="src-doc">The status descriptor for the response (optional - ignored if null)</span></div></li>
- <li><div class="src-line"><a name="a692"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$data </span><span class="src-doc">The data for the response, which can be a scalar, or a mixed array of scalars/scalar-arrays (see </span><span class="src-doc-inlinetag">{@link SloodleResponse::$data}</span><span class="src-doc">) (optional - ignored if null)</span></div></li>
- <li><div class="src-line"><a name="a693"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$static </span><span class="src-doc">If true (default), then this function will assume it is being call statically, and construct its own response object. Otherwise, it will all the existing member data to render the output.</span></div></li>
- <li><div class="src-line"><a name="a694"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a695"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
- <li><div class="src-line"><a name="a696"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a697"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#methodquick_output">quick_output</a><span class="src-sym">(</span><span class="src-var">$status_code</span><span class="src-sym">, </span><span class="src-var">$status_descriptor </span>= <span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$data </span>= <span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$static </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a698"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a699"></a> <span class="src-comm">// Is this s static call?</span></div></li>
- <li><div class="src-line"><a name="a700"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$static</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a701"></a> <span class="src-comm">// Construct and render the output of a response object</span></div></li>
- <li><div class="src-line"><a name="a702"></a> <span class="src-var">$response </span>= <span class="src-key">new </span><a href="../sloodle/SloodleResponse.html#methodSloodleResponse">SloodleResponse</a><span class="src-sym">(</span><span class="src-var">$status_code</span><span class="src-sym">, </span><span class="src-var">$status_descriptor</span><span class="src-sym">, </span><span class="src-var">$data</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a703"></a> <span class="src-var">$response</span><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a704"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a705"></a> <span class="src-comm">// Set all our data</span></div></li>
- <li><div class="src-line"><a name="a706"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$status_code">status_code</a> = <span class="src-var">$status_code</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a707"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$status_descriptor </span>!= <span class="src-id">null</span><span class="src-sym">) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$status_descriptor">status_descriptor</a> = <span class="src-var">$status_descriptor</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a708"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$data </span>!= <span class="src-id">null</span><span class="src-sym">) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#methodadd_data_line">add_data_line</a><span class="src-sym">(</span><span class="src-var">$data</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a709"></a> <span class="src-comm">// Output it</span></div></li>
- <li><div class="src-line"><a name="a710"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#methodrender_to_output">render_to_output</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a711"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a712"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a713"></a> </div></li>
- <li><div class="src-line"><a name="a714"></a> </div></li>
- <li><div class="src-line"><a name="a715"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a716"></a><span class="src-doc"> * Internal function to report a data validation error.</span></div></li>
- <li><div class="src-line"><a name="a717"></a><span class="src-doc"> * Outputs an LSL-friendly error message, and terminates the script</span></div></li>
- <li><div class="src-line"><a name="a718"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a719"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$msg </span><span class="src-doc">The error message to output.</span></div></li>
- <li><div class="src-line"><a name="a720"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a721"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a722"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a723"></a> <span class="src-key">function </span><a href="../sloodle/SloodleResponse.html#method_internal_validation_error">_internal_validation_error</a><span class="src-sym">(</span><span class="src-var">$msg</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a724"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a725"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-str">"-104"</span>.<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$field_separator">field_separator</a>.<span class="src-str">"SYSTEM"</span>.<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleResponse.html#var$line_separator">line_separator</a>.<span class="src-var">$msg</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a726"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a727"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a728"></a> </div></li>
- <li><div class="src-line"><a name="a729"></a> </div></li>
- <li><div class="src-line"><a name="a730"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a731"></a><span class="src-doc"> * Obtains a named HTTP request parameter, and terminates script with an error message if it was not provided.</span></div></li>
- <li><div class="src-line"><a name="a732"></a><span class="src-doc"> * This is a 'Sloodle-friendly' version of the Moodle "required_param" function.</span></div></li>
- <li><div class="src-line"><a name="a733"></a><span class="src-doc"> * Instead of terminate the script with an HTML-formatted error message, it will terminate with a message</span></div></li>
- <li><div class="src-line"><a name="a734"></a><span class="src-doc"> * which conforms for the </span><span class="src-doc-inlinetag">{@link http://slisweb.sjsu.edu/sl/index.php/Sloodle_communications_specification Sloodle communications specification}</span><span class="src-doc">,</span></div></li>
- <li><div class="src-line"><a name="a735"></a><span class="src-doc"> * making it suitable for use in </span><span class="src-doc-inlinetag">{@link http://slisweb.sjsu.edu/sl/index.php/Linker_Script linker scripts}</span><span class="src-doc">.</span></div></li>
- <li><div class="src-line"><a name="a736"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a737"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$parname </span><span class="src-doc">Name of the HTTP request parameter to fetch.</span></div></li>
- <li><div class="src-line"><a name="a738"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc-var">$type </span><span class="src-doc">Type of parameter expected, such as "PARAM_RAW". See Moodle documentation for a complete list.</span></div></li>
- <li><div class="src-line"><a name="a739"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">The appropriately parsed and/or cleaned parameter value, if it was found.</span></div></li>
- <li><div class="src-line"><a name="a740"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@deprecated</span></div></li>
- <li><div class="src-line"><a name="a741"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a742"></a> <span class="src-key">function </span><a href="../sloodle/_lib---io.php.html#functionsloodle_required_param">sloodle_required_param</a><span class="src-sym">(</span><span class="src-var">$parname</span><span class="src-sym">, </span><span class="src-var">$type</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a743"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a744"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-str">'ERROR: deprecated function \'sloodle_required_param()\' called.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a745"></a> <span class="src-comm">// Attempt to get the parameter</span></div></li>
- <li><div class="src-line"><a name="a746"></a> <span class="src-var">$par </span>= <span class="src-id">optional_param</span><span class="src-sym">(</span><span class="src-var">$parname</span><span class="src-sym">, </span><span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$type</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a747"></a> <span class="src-comm">// Was it provided?</span></div></li>
- <li><div class="src-line"><a name="a748"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a749"></a> <span class="src-comm">// No - report the error</span></div></li>
- <li><div class="src-line"><a name="a750"></a> <a href="../sloodle/SloodleResponse.html#methodSloodleResponse">SloodleResponse</a><span class="src-sym">::</span><a href="../sloodle/SloodleResponse.html#methodquick_output">quick_output</a><span class="src-sym">(</span>-<span class="src-num">811</span><span class="src-sym">, </span><span class="src-str">"SYSTEM"</span><span class="src-sym">, </span><span class="src-str">"</span><span class="src-str">Expected request parameter '<span class="src-var">$parname</span>'.</span><span class="src-str">"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a751"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a752"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a753"></a> </div></li>
- <li><div class="src-line"><a name="a754"></a> <span class="src-key">return </span><span class="src-var">$par</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a755"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a756"></a> </div></li>
- <li><div class="src-line"><a name="a757"></a> </div></li>
- <li><div class="src-line"><a name="a758"></a> <span class="src-comm">// This class handles an HTTP request</span></div></li>
- <li><div class="src-line"><a name="a759"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a760"></a><span class="src-doc"> * Handles incoming HTTP requests, typically from LSL if dealing with Second Life.</span></div></li>
- <li><div class="src-line"><a name="a761"></a><span class="src-doc"> * This class will perform much of the complex and repetitive processing required for handling HTTP requests.</span></div></li>
- <li><div class="src-line"><a name="a762"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a763"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@uses</span><span class="src-doc"> SloodleResponse Outputs error messages in appropriate format if an error occurs.</span></div></li>
- <li><div class="src-line"><a name="a764"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@uses</span><span class="src-doc"> SloodleUser Stores and processes user data incoming from an HTTP request</span></div></li>
- <li><div class="src-line"><a name="a765"></a><span class="src-doc"> * </span></div></li>
- <li><div class="src-line"><a name="a766"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> sloodle</span></div></li>
- <li><div class="src-line"><a name="a767"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a768"></a> <span class="src-key">class </span><a href="../sloodle/SloodleRequest.html">SloodleRequest</a></div></li>
- <li><div class="src-line"><a name="a769"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a770"></a> <span class="src-comm">// DATA //</span></div></li>
- <li><div class="src-line"><a name="a771"></a> </div></li>
- <li><div class="src-line"><a name="a772"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a773"></a><span class="src-doc"> * Reference to the containing </span><span class="src-doc-inlinetag">{@link SloodleSession}</span><span class="src-doc"> object.</span></div></li>
- <li><div class="src-line"><a name="a774"></a><span class="src-doc"> * If null, then this module is being used outwith the framework.</span></div></li>
- <li><div class="src-line"><a name="a775"></a><span class="src-doc"> * <b>Always check the status of the variable before using it!</b></span></div></li>
- <li><div class="src-line"><a name="a776"></a><span class="src-doc"> * Note: if not provided, then this object will not render any response information.</span></div></li>
- <li><div class="src-line"><a name="a777"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">object </span></div></li>
- <li><div class="src-line"><a name="a778"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> protected</span></div></li>
- <li><div class="src-line"><a name="a779"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a780"></a> <span class="src-key">var </span><a href="../sloodle/SloodleRequest.html#var$_session">$_session</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a781"></a> </div></li>
- <li><div class="src-line"><a name="a782"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a783"></a><span class="src-doc"> * Indicates whether or not the basic request data has already been processed.</span></div></li>
- <li><div class="src-line"><a name="a784"></a><span class="src-doc"> * This is used to ensure data is processed.</span></div></li>
- <li><div class="src-line"><a name="a785"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">bool </span></div></li>
- <li><div class="src-line"><a name="a786"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a787"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a788"></a> <span class="src-key">var </span><a href="../sloodle/SloodleRequest.html#var$request_data_processed">$request_data_processed</a> = <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a789"></a> </div></li>
- <li><div class="src-line"><a name="a790"></a> </div></li>
- <li><div class="src-line"><a name="a791"></a> <span class="src-comm">// ACCESSORS //</span></div></li>
- <li><div class="src-line"><a name="a792"></a> </div></li>
- <li><div class="src-line"><a name="a793"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a794"></a><span class="src-doc"> * Checks whether or not the request data has already been processed.</span></div></li>
- <li><div class="src-line"><a name="a795"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
- <li><div class="src-line"><a name="a796"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a797"></a> <span class="src-key">function </span><a href="../sloodle/SloodleRequest.html#methodis_request_data_processed">is_request_data_processed</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a798"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a799"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$request_data_processed">request_data_processed</a><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a800"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a801"></a> </div></li>
- <li><div class="src-line"><a name="a802"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a803"></a><span class="src-doc"> * Fetches the password request parameter.</span></div></li>
- <li><div class="src-line"><a name="a804"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$required </span><span class="src-doc">If true (default) then the function will terminate the script with an error message if the HTTP request parameter was not specified.</span></div></li>
- <li><div class="src-line"><a name="a805"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string</span><span class="src-doc">|</span><span class="src-doc-type">null</span><span class="src-doc">The password provided in the request parameters, or null if there wasn't one</span></div></li>
- <li><div class="src-line"><a name="a806"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a807"></a> <span class="src-key">function </span><a href="../sloodle/SloodleRequest.html#methodget_password">get_password</a><span class="src-sym">(</span><span class="src-var">$required </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a808"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a809"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_param">get_param</a><span class="src-sym">(</span><span class="src-id"><a href="../sloodle/_lib---io.php.html#defineSLOODLE_PARAM_PASSWORD">SLOODLE_PARAM_PASSWORD</a></span><span class="src-sym">, </span><span class="src-var">$required</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a810"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a811"></a> </div></li>
- <li><div class="src-line"><a name="a812"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a813"></a><span class="src-doc"> * Fetches the course ID request parameter.</span></div></li>
- <li><div class="src-line"><a name="a814"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$required </span><span class="src-doc">If true (default) then the function will terminate the script with an error message if the HTTP request parameter was not specified.</span></div></li>
- <li><div class="src-line"><a name="a815"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">int</span><span class="src-doc">|</span><span class="src-doc-type">null</span><span class="src-doc">The course ID provided in the request parameters, or null if there wasn't one</span></div></li>
- <li><div class="src-line"><a name="a816"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a817"></a> <span class="src-key">function </span><a href="../sloodle/SloodleRequest.html#methodget_course_id">get_course_id</a><span class="src-sym">(</span><span class="src-var">$required </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a818"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a819"></a> <span class="src-key">return </span>(int)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_param">get_param</a><span class="src-sym">(</span><span class="src-id"><a href="../sloodle/_lib---io.php.html#defineSLOODLE_PARAM_COURSE_ID">SLOODLE_PARAM_COURSE_ID</a></span><span class="src-sym">, </span><span class="src-var">$required</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a820"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a821"></a> </div></li>
- <li><div class="src-line"><a name="a822"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a823"></a><span class="src-doc"> * Fetches the controller ID request parameter.</span></div></li>
- <li><div class="src-line"><a name="a824"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$required </span><span class="src-doc">If true (default) then the function will terminate the script with an error message if the HTTP request parameter was not specified.</span></div></li>
- <li><div class="src-line"><a name="a825"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">int</span><span class="src-doc">|</span><span class="src-doc-type">null</span><span class="src-doc">The controller ID provided in the request parameters, or null if there wasn't one</span></div></li>
- <li><div class="src-line"><a name="a826"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a827"></a> <span class="src-key">function </span><a href="../sloodle/SloodleRequest.html#methodget_controller_id">get_controller_id</a><span class="src-sym">(</span><span class="src-var">$required </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a828"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a829"></a> <span class="src-key">return </span>(int)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_param">get_param</a><span class="src-sym">(</span><span class="src-id"><a href="../sloodle/_lib---io.php.html#defineSLOODLE_PARAM_CONTROLLER_ID">SLOODLE_PARAM_CONTROLLER_ID</a></span><span class="src-sym">, </span><span class="src-var">$required</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a830"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a831"></a> </div></li>
- <li><div class="src-line"><a name="a832"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a833"></a><span class="src-doc"> * Fetches the module ID request parameter.</span></div></li>
- <li><div class="src-line"><a name="a834"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$required </span><span class="src-doc">If true (default) then the function will terminate the script with an error message if the HTTP request parameter was not specified.</span></div></li>
- <li><div class="src-line"><a name="a835"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">int</span><span class="src-doc">|</span><span class="src-doc-type">null</span><span class="src-doc">The module ID provided in the request parameters, or null if there wasn't one</span></div></li>
- <li><div class="src-line"><a name="a836"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a837"></a> <span class="src-key">function </span><a href="../sloodle/SloodleRequest.html#methodget_module_id">get_module_id</a><span class="src-sym">(</span><span class="src-var">$required </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a838"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a839"></a> <span class="src-key">return </span>(int)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_param">get_param</a><span class="src-sym">(</span><span class="src-id"><a href="../sloodle/_lib---io.php.html#defineSLOODLE_PARAM_MODULE_ID">SLOODLE_PARAM_MODULE_ID</a></span><span class="src-sym">, </span><span class="src-var">$required</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a840"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a841"></a> </div></li>
- <li><div class="src-line"><a name="a842"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a843"></a><span class="src-doc"> * Fetches the avatar UUID request parameter.</span></div></li>
- <li><div class="src-line"><a name="a844"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$required </span><span class="src-doc">If true (default) then the function will terminate the script with an error message if the HTTP request parameter was not specified.</span></div></li>
- <li><div class="src-line"><a name="a845"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string</span><span class="src-doc">|</span><span class="src-doc-type">null</span><span class="src-doc">The avatar UUID provided in the request parameters, or null if there wasn't one</span></div></li>
- <li><div class="src-line"><a name="a846"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a847"></a> <span class="src-key">function </span><a href="../sloodle/SloodleRequest.html#methodget_avatar_uuid">get_avatar_uuid</a><span class="src-sym">(</span><span class="src-var">$required </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a848"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a849"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_param">get_param</a><span class="src-sym">(</span><span class="src-id"><a href="../sloodle/_lib---io.php.html#defineSLOODLE_PARAM_AVATAR_UUID">SLOODLE_PARAM_AVATAR_UUID</a></span><span class="src-sym">, </span><span class="src-var">$required</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a850"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a851"></a> </div></li>
- <li><div class="src-line"><a name="a852"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a853"></a><span class="src-doc"> * Fetches the avatar name request parameter.</span></div></li>
- <li><div class="src-line"><a name="a854"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$required </span><span class="src-doc">If true (default) then the function will terminate the script with an error message if the HTTP request parameter was not specified.</span></div></li>
- <li><div class="src-line"><a name="a855"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string</span><span class="src-doc">|</span><span class="src-doc-type">null</span><span class="src-doc">The avatar name provided in the request parameters, or null if there wasn't one</span></div></li>
- <li><div class="src-line"><a name="a856"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a857"></a> <span class="src-key">function </span><a href="../sloodle/SloodleRequest.html#methodget_avatar_name">get_avatar_name</a><span class="src-sym">(</span><span class="src-var">$required </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a858"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a859"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_param">get_param</a><span class="src-sym">(</span><span class="src-id"><a href="../sloodle/_lib---io.php.html#defineSLOODLE_PARAM_AVATAR_NAME">SLOODLE_PARAM_AVATAR_NAME</a></span><span class="src-sym">, </span><span class="src-var">$required</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a860"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a861"></a> </div></li>
- <li><div class="src-line"><a name="a862"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a863"></a><span class="src-doc"> * Fetches the request descriptor request parameter.</span></div></li>
- <li><div class="src-line"><a name="a864"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$required </span><span class="src-doc">If true (default) then the function will terminate the script with an error message if the HTTP request parameter was not specified.</span></div></li>
- <li><div class="src-line"><a name="a865"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string</span><span class="src-doc">|</span><span class="src-doc-type">null</span><span class="src-doc">The request descriptor provided in the request parameters, or null if there wasn't one</span></div></li>
- <li><div class="src-line"><a name="a866"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a867"></a> <span class="src-key">function </span><a href="../sloodle/SloodleRequest.html#methodget_request_descriptor">get_request_descriptor</a><span class="src-sym">(</span><span class="src-var">$required </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a868"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a869"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_param">get_param</a><span class="src-sym">(</span><span class="src-id"><a href="../sloodle/_lib---io.php.html#defineSLOODLE_PARAM_REQUEST_DESC">SLOODLE_PARAM_REQUEST_DESC</a></span><span class="src-sym">, </span><span class="src-var">$required</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a870"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a871"></a> </div></li>
- <li><div class="src-line"><a name="a872"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a873"></a><span class="src-doc"> * Checks the parameters to determine if the request relates to an object rather than a user</span></div></li>
- <li><div class="src-line"><a name="a874"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if the request seems to have come from an object, or false otherwise.</span></div></li>
- <li><div class="src-line"><a name="a875"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a876"></a> <span class="src-key">function </span><a href="../sloodle/SloodleRequest.html#methodis_object_request">is_object_request</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a877"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a878"></a> <span class="src-var">$par </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_param">get_param</a><span class="src-sym">(</span><span class="src-id"><a href="../sloodle/_lib---io.php.html#defineSLOODLE_PARAM_IS_OBJECT">SLOODLE_PARAM_IS_OBJECT</a></span><span class="src-sym">, </span><span class="src-id">false</span><span class="src-sym">, </span><span class="src-id">false</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a879"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/strcasecmp">strcasecmp</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">, </span><span class="src-str">'true'</span><span class="src-sym">) </span>== <span class="src-num">0 </span>|| <a href="http://www.php.net/strcasecmp">strcasecmp</a><span class="src-sym">(</span><span class="src-var">$par</span><span class="src-sym">, </span><span class="src-str">'yes'</span><span class="src-sym">) </span>== <span class="src-num">0 </span>|| <span class="src-var">$par </span>== <span class="src-str">'1'</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a880"></a> <span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a881"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a882"></a> </div></li>
- <li><div class="src-line"><a name="a883"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a884"></a><span class="src-doc"> * Fetches the server access level parameter, if specified.</span></div></li>
- <li><div class="src-line"><a name="a885"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$required </span><span class="src-doc">If true (default) then the function will terminate the script with an error message if the HTTP request parameter was not specified.</span></div></li>
- <li><div class="src-line"><a name="a886"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string</span><span class="src-doc">|</span><span class="src-doc-type">null</span><span class="src-doc">The server access level provided in the request parameters, or null if there wasn't one</span></div></li>
- <li><div class="src-line"><a name="a887"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a888"></a> <span class="src-key">function </span><a href="../sloodle/SloodleRequest.html#methodget_server_access_level">get_server_access_level</a><span class="src-sym">(</span><span class="src-var">$required </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a889"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a890"></a> <span class="src-key">return </span>(int)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_param">get_param</a><span class="src-sym">(</span><span class="src-id"><a href="../sloodle/_lib---io.php.html#defineSLOODLE_PARAM_SERVER_ACCESS_LEVEL">SLOODLE_PARAM_SERVER_ACCESS_LEVEL</a></span><span class="src-sym">, </span><span class="src-var">$required</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a891"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a892"></a> </div></li>
- <li><div class="src-line"><a name="a893"></a> </div></li>
- <li><div class="src-line"><a name="a894"></a> <span class="src-comm">// FUNCTIONS //</span></div></li>
- <li><div class="src-line"><a name="a895"></a> </div></li>
- <li><div class="src-line"><a name="a896"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a897"></a><span class="src-doc"> * <i>Constructor</i> - initialises the </span><span class="src-doc-inlinetag">{@link SloodleSession}</span><span class="src-doc"> object.</span></div></li>
- <li><div class="src-line"><a name="a898"></a><span class="src-doc"> * If the session parameter is null, then this object simply does not render response information.</span></div></li>
- <li><div class="src-line"><a name="a899"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a900"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">SloodleUser </span><span class="src-doc-var">$_session </span><span class="src-doc">A reference to the </span><span class="src-doc-inlinetag">{@link SloodleSession}</span><span class="src-doc"> object which this request should use, or null</span></div></li>
- <li><div class="src-line"><a name="a901"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a902"></a> <span class="src-key">function </span><a href="../sloodle/SloodleRequest.html#methodSloodleRequest">SloodleRequest</a><span class="src-sym">(</span><span class="src-sym">&</span><span class="src-var">$_session</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a903"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a904"></a> <span class="src-comm">// Store our session object</span></div></li>
- <li><div class="src-line"><a name="a905"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a> = <span class="src-sym">&</span><span class="src-var">$_session</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a906"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a907"></a> </div></li>
- <li><div class="src-line"><a name="a908"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a909"></a><span class="src-doc"> * Process all of the standard data provided by the HTTP request, and write it into our </span><span class="src-doc-inlinetag">{@link SloodleSession}</span><span class="src-doc"> object.</span></div></li>
- <li><div class="src-line"><a name="a910"></a><span class="src-doc"> * Requires that a </span><span class="src-doc-inlinetag">{@link SloodleSession}</span><span class="src-doc"> object was provided at construction, and is stored in the $_session member.</span></div></li>
- <li><div class="src-line"><a name="a911"></a><span class="src-doc"> * NOTE: this does not load the module part of the session. That must be done separately, using the </span><span class="src-doc-inlinetag">{@link SloodleSession::load_module()}</span><span class="src-doc"> member function.</span></div></li>
- <li><div class="src-line"><a name="a912"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$require_auth </span><span class="src-doc">If true, then the function will terminate the script with an error message if it cannot authenticate the request through a course, controller and password</span></div></li>
- <li><div class="src-line"><a name="a913"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$require_user </span><span class="src-doc">If true, then the function will terminate the script with an error message if a legitimate user was not identified or could not be auto-registered</span></div></li>
- <li><div class="src-line"><a name="a914"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if successful, or false otherwise.</span></div></li>
- <li><div class="src-line"><a name="a915"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a916"></a> <span class="src-key">function </span><a href="../sloodle/SloodleRequest.html#methodprocess_request_data">process_request_data</a><span class="src-sym">(</span><span class="src-var">$require_auth </span>= <span class="src-id">true</span><span class="src-sym">, </span><span class="src-var">$require_user </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a917"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a918"></a> <span class="src-comm">// Do we have a session object?</span></div></li>
- <li><div class="src-line"><a name="a919"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a920"></a> </div></li>
- <li><div class="src-line"><a name="a921"></a> <span class="src-comm">// Store the request descriptor</span></div></li>
- <li><div class="src-line"><a name="a922"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">response</span><span class="src-sym">-></span><span class="src-id">set_request_descriptor</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_request_descriptor">get_request_descriptor</a><span class="src-sym">(</span><span class="src-id">false</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a923"></a> <span class="src-comm">// Attempt to load the controller, then the course</span></div></li>
- <li><div class="src-line"><a name="a924"></a> <span class="src-comm">// (there is a shortcut, using course->load_by_controller(), </span></div></li>
- <li><div class="src-line"><a name="a925"></a> <span class="src-comm">// however, that makes it harder to locate problems)</span></div></li>
- <li><div class="src-line"><a name="a926"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">course</span><span class="src-sym">-></span><span class="src-id">controller</span><span class="src-sym">-></span><span class="src-id">load</span><span class="src-sym">( </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_controller_id">get_controller_id</a><span class="src-sym">(</span><span class="src-id">false</span><span class="src-sym">) )) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a927"></a> <span class="src-comm">// Got the controller... now the course</span></div></li>
- <li><div class="src-line"><a name="a928"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">course</span><span class="src-sym">-></span><span class="src-id">load</span><span class="src-sym">( </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">course</span><span class="src-sym">-></span><span class="src-id">controller</span><span class="src-sym">-></span><span class="src-id">get_course_id</span><span class="src-sym">(</span><span class="src-sym">) )</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a929"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a930"></a> <span class="src-comm">// Perhaps a course was specified in the request instead?</span></div></li>
- <li><div class="src-line"><a name="a931"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">course</span><span class="src-sym">-></span><span class="src-id">load</span><span class="src-sym">( </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_course_id">get_course_id</a><span class="src-sym">(</span><span class="src-id">false</span><span class="src-sym">) )</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a932"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a933"></a> </div></li>
- <li><div class="src-line"><a name="a934"></a> <span class="src-comm">// Get the avatar details</span></div></li>
- <li><div class="src-line"><a name="a935"></a> <span class="src-var">$uuid </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_avatar_uuid">get_avatar_uuid</a><span class="src-sym">(</span><span class="src-id">false</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a936"></a> <span class="src-var">$avname </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodget_avatar_name">get_avatar_name</a><span class="src-sym">(</span><span class="src-id">false</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a937"></a> </div></li>
- <li><div class="src-line"><a name="a938"></a> <span class="src-comm">// Attempt to load an avatar</span></div></li>
- <li><div class="src-line"><a name="a939"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">user</span><span class="src-sym">-></span><span class="src-id">load_avatar</span><span class="src-sym">(</span><span class="src-var">$uuid</span><span class="src-sym">, </span><span class="src-var">$avname</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a940"></a> <span class="src-comm">// Success - now attempt to load the linked VLE user</span></div></li>
- <li><div class="src-line"><a name="a941"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">user</span><span class="src-sym">-></span><span class="src-id">load_linked_user</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a942"></a> <span class="src-comm">// If we didn't already have a UUID then get it from the user data</span></div></li>
- <li><div class="src-line"><a name="a943"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$uuid</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a944"></a> <span class="src-var">$uuid </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">user</span><span class="src-sym">-></span><span class="src-id">get_avatar_uuid</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a945"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a946"></a> </div></li>
- <li><div class="src-line"><a name="a947"></a> <span class="src-comm">// Update the user's activity listing</span></div></li>
- <li><div class="src-line"><a name="a948"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">user</span><span class="src-sym">-></span><span class="src-id">set_avatar_last_active</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a949"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">user</span><span class="src-sym">-></span><span class="src-id">write_avatar</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a950"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a951"></a> </div></li>
- <li><div class="src-line"><a name="a952"></a> <span class="src-comm">// If we now have a UUID, then add it to our response data</span></div></li>
- <li><div class="src-line"><a name="a953"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$uuid</span><span class="src-sym">)) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">response</span><span class="src-sym">-></span><span class="src-id">set_avatar_uuid</span><span class="src-sym">(</span><span class="src-var">$uuid</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a954"></a> </div></li>
- <li><div class="src-line"><a name="a955"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$request_data_processed">request_data_processed</a> = <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a956"></a> <span class="src-key">return </span><span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a957"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a958"></a> </div></li>
- <li><div class="src-line"><a name="a959"></a> </div></li>
- <li><div class="src-line"><a name="a960"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a961"></a><span class="src-doc"> * Gets a database record for the course identified in the request.</span></div></li>
- <li><div class="src-line"><a name="a962"></a><span class="src-doc"> * (Note: this function does not check whether or not the user is enrolled in the course)</span></div></li>
- <li><div class="src-line"><a name="a963"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a964"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$require </span><span class="src-doc">If true, the function will NOT return failure. Rather, it will terminate the script with an error message.</span></div></li>
- <li><div class="src-line"><a name="a965"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">object </span><span class="src-doc-type">A </span><span class="src-doc">record directly from the database, or null if the course is not found.</span></div></li>
- <li><div class="src-line"><a name="a966"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a967"></a> <span class="src-key">function </span><a href="../sloodle/SloodleRequest.html#methodget_course_record">get_course_record</a><span class="src-sym">(</span><span class="src-var">$require </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a968"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a969"></a> <span class="src-comm">// Make sure the request data is processed</span></div></li>
- <li><div class="src-line"><a name="a970"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodprocess_request_data">process_request_data</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a971"></a> <span class="src-comm">// Make sure the course ID was specified</span></div></li>
- <li><div class="src-line"><a name="a972"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_null">is_null</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">course_id</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a973"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a974"></a> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">501</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a975"></a> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'COURSE'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a976"></a> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'No course specified in request.'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a977"></a> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a978"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a979"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a980"></a> <span class="src-key">return </span><span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a981"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a982"></a> <span class="src-comm">// Attempt to get the course data</span></div></li>
- <li><div class="src-line"><a name="a983"></a> <span class="src-var">$course_record </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'course'</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">course_id</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a984"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$course_record </span>=== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a985"></a> <span class="src-comm">// Course not found</span></div></li>
- <li><div class="src-line"><a name="a986"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a987"></a> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">512</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a988"></a> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'COURSE'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a989"></a> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">"</span><span class="src-str">Course {<span class="src-var">$this</span></span><span class="src-sym">-></span><span class="src-var">course_id</span><span class="src-sym">}</span> not found.</span><span class="src-str"><span class="src-str">"</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a990"></a></span><span class="src-str"> <span class="src-var">$this</span></span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a991"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a992"></a> </span><span class="src-str"><span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a993"></a></span><span class="src-str"> <span class="src-key">return</span> <span class="src-id">null</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a994"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a995"></a></span><span class="src-str"> <span class="src-comm">// Make sure the course is visible</span></span></div></li>
- <li><div class="src-line"><a name="a996"></a></span><span class="src-str"> <span class="src-comm">// TODO: any availability other checks here?</span></span></div></li>
- <li><div class="src-line"><a name="a997"></a></span><span class="src-str"><span class="src-comm"></span> <span class="src-key">if</span> <span class="src-sym">(</span>(int)<span class="src-var">$course_record</span><span class="src-sym">-></span><span class="src-id">visible</span> == <span class="src-num">0</span><span class="src-sym">)</span> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a998"></a></span><span class="src-str"> <span class="src-comm">// Course not available</span></span></div></li>
- <li><div class="src-line"><a name="a999"></a></span><span class="src-str"> <span class="src-key">if</span> <span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">)</span> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1000"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">513</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1001"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'COURSE'</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1002"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">"</span></span>Course {<span class="src-var">$this</span><span class="src-sym">-></span><span class="src-id">course_id</span><span class="src-sym">}</span> is not available.<span class="src-str">"</span><span class="src-str"><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1003"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1004"></a></span><span class="src-str"> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1005"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1006"></a></span><span class="src-str"> <span class="src-key">return</span> <span class="src-id">null</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1007"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1008"></a></span><span class="src-str"> <span class="src-comm">// TODO: in future, we need to check that the course is Sloodle-enabled</span></span></div></li>
- <li><div class="src-line"><a name="a1009"></a></span><span class="src-str"> <span class="src-comm">// TODO: in future, make sure we are authenticated for this particular course</span></span></div></li>
- <li><div class="src-line"><a name="a1010"></a></span><span class="src-str"> </span></div></li>
- <li><div class="src-line"><a name="a1011"></a></span><span class="src-str"> <span class="src-comm">// Seems fine... return the object</span></span></div></li>
- <li><div class="src-line"><a name="a1012"></a></span><span class="src-str"> <span class="src-key">return</span> <span class="src-var">$course_record</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1013"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1014"></a></span><span class="src-str"> </span></div></li>
- <li><div class="src-line"><a name="a1015"></a></span><span class="src-str"> /**</span></div></li>
- <li><div class="src-line"><a name="a1016"></a></span><span class="src-str"> * Get a course module instance for the module specified in the request</span></div></li>
- <li><div class="src-line"><a name="a1017"></a></span><span class="src-str"> * Uses the ID specified in {@link $module_id}.</span></div></li>
- <li><div class="src-line"><a name="a1018"></a></span><span class="src-str"> *</span></div></li>
- <li><div class="src-line"><a name="a1019"></a></span><span class="src-str"> * @param string $type specifies the name of the module type (e.g. 'forum', 'choice' etc.) - ignored if blank (default).</span></div></li>
- <li><div class="src-line"><a name="a1020"></a></span><span class="src-str"> * @param bool $require If true, the function will NOT return failure. Rather, it will terminate the script with an error message.</span></div></li>
- <li><div class="src-line"><a name="a1021"></a></span><span class="src-str"> * @return object A database record if successful, or false if not (e.g. if instance is not found, is not visible, or is not of the correct type)</span></div></li>
- <li><div class="src-line"><a name="a1022"></a></span><span class="src-str"> */</span></div></li>
- <li><div class="src-line"><a name="a1023"></a></span><span class="src-str"> <span class="src-key">function</span> <span class="src-id">get_course_module_instance</span><span class="src-sym">(</span> <span class="src-var">$type</span> = <span class="src-str">''</span><span class="src-sym">,</span> <span class="src-var">$require</span> = <span class="src-id">true</span> <span class="src-sym">)</span></span></div></li>
- <li><div class="src-line"><a name="a1024"></a></span><span class="src-str"> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1025"></a></span><span class="src-str"> <span class="src-comm">// Make sure the request data is processed</span></span></div></li>
- <li><div class="src-line"><a name="a1026"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodprocess_request_data">process_request_data</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1027"></a></span><span class="src-str"> </span></div></li>
- <li><div class="src-line"><a name="a1028"></a></span><span class="src-str"> <span class="src-comm">// Make sure the module ID was specified</span></span></div></li>
- <li><div class="src-line"><a name="a1029"></a></span><span class="src-str"> <span class="src-key">if</span> <span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">module_id</span> == <span class="src-id">null</span><span class="src-sym">)</span> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1030"></a></span><span class="src-str"> <span class="src-key">if</span> <span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">)</span> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1031"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">711</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1032"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'MODULE_DESCRIPTOR'</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1033"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'Course module instance ID not specified.'</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1034"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1035"></a></span><span class="src-str"> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1036"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1037"></a></span><span class="src-str"> <span class="src-key">return</span> <span class="src-id">false</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1038"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1039"></a></span><span class="src-str"> </span></div></li>
- <li><div class="src-line"><a name="a1040"></a></span><span class="src-str"> <span class="src-comm">// Attempt to get the instance</span></span></div></li>
- <li><div class="src-line"><a name="a1041"></a></span><span class="src-str"> <span class="src-key">if</span> <span class="src-sym">(</span><span class="src-sym">!</span><span class="src-sym">(</span><span class="src-var">$cmi</span> = <a href="../sloodle/_lib---general.php.html#functionsloodle_get_course_module_instance">sloodle_get_course_module_instance</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">module_id</span><span class="src-sym">)))</span> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1042"></a></span><span class="src-str"> <span class="src-key">if</span> <span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">)</span> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1043"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">712</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1044"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'MODULE_DESCRIPTOR'</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1045"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'Could not find course module instance.'</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1046"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1047"></a></span><span class="src-str"> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1048"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1049"></a></span><span class="src-str"> <span class="src-key">return</span> <span class="src-id">false</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1050"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1051"></a></span><span class="src-str"> </span></div></li>
- <li><div class="src-line"><a name="a1052"></a></span><span class="src-str"> <span class="src-comm">// If the type was specified, then verify it</span></span></div></li>
- <li><div class="src-line"><a name="a1053"></a></span><span class="src-str"> <span class="src-key">if</span> <span class="src-sym">(</span><span class="src-sym">!</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$type</span><span class="src-sym">))</span> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1054"></a></span><span class="src-str"> <span class="src-key">if</span> <span class="src-sym">(</span><span class="src-sym">!</span><a href="../sloodle/_lib---general.php.html#functionsloodle_check_course_module_instance_type">sloodle_check_course_module_instance_type</a><span class="src-sym">(</span><span class="src-var">$cmi</span><span class="src-sym">,</span> <a href="http://www.php.net/strtolower">strtolower</a><span class="src-sym">(</span><span class="src-var">$type</span><span class="src-sym">)))</span> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1055"></a></span><span class="src-str"> <span class="src-key">if</span> <span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">)</span> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1056"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">712</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1057"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'MODULE_DESCRIPTOR'</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1058"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">"</span></span>Course module instance not of expected type. (Expected: '<span class="src-var">$type</span>').<span class="src-str">"</span><span class="src-str"><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1059"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1060"></a></span><span class="src-str"> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1061"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1062"></a></span><span class="src-str"> <span class="src-key">return</span> <span class="src-id">false</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1063"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1064"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1065"></a></span><span class="src-str"> </span></div></li>
- <li><div class="src-line"><a name="a1066"></a></span><span class="src-str"> <span class="src-comm">// Make sure the instance is visible</span></span></div></li>
- <li><div class="src-line"><a name="a1067"></a></span><span class="src-str"> <span class="src-key">if</span> <span class="src-sym">(</span><span class="src-sym">!</span><span class="src-id">sloodle_is_course_module_instance_visible</span><span class="src-sym">(</span><span class="src-var">$cmi</span><span class="src-sym">))</span> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1068"></a></span><span class="src-str"> <span class="src-key">if</span> <span class="src-sym">(</span><span class="src-var">$require</span><span class="src-sym">)</span> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1069"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">713</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1070"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'MODULE_DESCRIPTOR'</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1071"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">'Specified course module instance is not available.'</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1072"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">response</span><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1073"></a></span><span class="src-str"> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1074"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1075"></a></span><span class="src-str"> <span class="src-key">return</span> <span class="src-id">false</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1076"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1077"></a></span><span class="src-str"> </span></div></li>
- <li><div class="src-line"><a name="a1078"></a></span><span class="src-str"> <span class="src-comm">// Everything looks fine</span></span></div></li>
- <li><div class="src-line"><a name="a1079"></a></span><span class="src-str"> <span class="src-key">return</span> <span class="src-var">$cmi</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1080"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1081"></a></span><span class="src-str"> </span></div></li>
- <li><div class="src-line"><a name="a1082"></a></span><span class="src-str"> </span></div></li>
- <li><div class="src-line"><a name="a1083"></a></span><span class="src-str"> <span class="src-comm">// UTILITY FUNCTIONS //</span></span></div></li>
- <li><div class="src-line"><a name="a1084"></a></span><span class="src-str"> </span></div></li>
- <li><div class="src-line"><a name="a1085"></a></span><span class="src-str"> /**</span></div></li>
- <li><div class="src-line"><a name="a1086"></a></span><span class="src-str"> * Obtains a named HTTP request parameter, or NULL if it has not been provided.</span></div></li>
- <li><div class="src-line"><a name="a1087"></a></span><span class="src-str"> * Return values are always strings.</span></div></li>
- <li><div class="src-line"><a name="a1088"></a></span><span class="src-str"> * @param string $parname The name of the parameter to fetch</span></div></li>
- <li><div class="src-line"><a name="a1089"></a></span><span class="src-str"> * @param mixed $default The value to return if the parameter cannot be found</span></div></li>
- <li><div class="src-line"><a name="a1090"></a></span><span class="src-str"> * @return string|mixed The raw parameter value (will be a string if the parameter was found, or the value of parameter $default otherwise)</span></div></li>
- <li><div class="src-line"><a name="a1091"></a></span><span class="src-str"> */</span></div></li>
- <li><div class="src-line"><a name="a1092"></a></span><span class="src-str"> <span class="src-key">function</span> <a href="../sloodle/SloodleRequest.html#methodoptional_param">optional_param</a><span class="src-sym">(</span><span class="src-var">$parname</span><span class="src-sym">,</span> <span class="src-var">$default</span> = <span class="src-id">null</span><span class="src-sym">)</span></span></div></li>
- <li><div class="src-line"><a name="a1093"></a></span><span class="src-str"> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1094"></a></span><span class="src-str"> <span class="src-key">if</span> <span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$_REQUEST</span><span class="src-sym">[</span><span class="src-var">$parname</span><span class="src-sym">]</span><span class="src-sym">))</span> <span class="src-key">return</span> (string)<span class="src-var">$_REQUEST</span><span class="src-sym">[</span><span class="src-var">$parname</span><span class="src-sym">]</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1095"></a></span><span class="src-str"> <span class="src-key">return</span> <span class="src-var">$default</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1096"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1097"></a></span><span class="src-str"> </span></div></li>
- <li><div class="src-line"><a name="a1098"></a></span><span class="src-str"> /**</span></div></li>
- <li><div class="src-line"><a name="a1099"></a></span><span class="src-str"> * Obtains a named HTTP request parameter, or terminates with an error message if it has not been provided.</span></div></li>
- <li><div class="src-line"><a name="a1100"></a></span><span class="src-str"> * Note: for linker scripts, this should *always* be used instead of the standard Moodle function, as this will</span></div></li>
- <li><div class="src-line"><a name="a1101"></a></span><span class="src-str"> * render appropriately formatted error messages, which scripts can understand.</span></div></li>
- <li><div class="src-line"><a name="a1102"></a></span><span class="src-str"> * Also note that this function always returned values in the string type. They must be cast.</span></div></li>
- <li><div class="src-line"><a name="a1103"></a></span><span class="src-str"> *</span></div></li>
- <li><div class="src-line"><a name="a1104"></a></span><span class="src-str"> * @param string $parname The name of the HTTP request parameter to get.</span></div></li>
- <li><div class="src-line"><a name="a1105"></a></span><span class="src-str"> * @return string The raw parameter value</span></div></li>
- <li><div class="src-line"><a name="a1106"></a></span><span class="src-str"> */</span></div></li>
- <li><div class="src-line"><a name="a1107"></a></span><span class="src-str"> <span class="src-key">function</span> <a href="../sloodle/SloodleRequest.html#methodrequired_param">required_param</a><span class="src-sym">(</span><span class="src-var">$parname</span><span class="src-sym">)</span></span></div></li>
- <li><div class="src-line"><a name="a1108"></a></span><span class="src-str"> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1109"></a></span><span class="src-str"> <span class="src-comm">// Is the parameter provided?</span></span></div></li>
- <li><div class="src-line"><a name="a1110"></a></span><span class="src-str"><span class="src-comm"></span> <span class="src-key">if</span> <span class="src-sym">(</span><span class="src-sym">!</span>isset<span class="src-sym">(</span><span class="src-var">$_REQUEST</span><span class="src-sym">[</span><span class="src-var">$parname</span><span class="src-sym">]</span><span class="src-sym">))</span> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1111"></a></span><span class="src-str"> <span class="src-comm">// No - report the error</span></span></div></li>
- <li><div class="src-line"><a name="a1112"></a></span><span class="src-str"> <span class="src-key">if</span> <span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">))</span> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1113"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">response</span><span class="src-sym">-></span><span class="src-id">set_status_code</span><span class="src-sym">(</span>-<span class="src-num">811</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1114"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">response</span><span class="src-sym">-></span><span class="src-id">set_status_descriptor</span><span class="src-sym">(</span><span class="src-str">'SYSTEM'</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1115"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">response</span><span class="src-sym">-></span><span class="src-id">add_data_line</span><span class="src-sym">(</span><span class="src-str">"</span></span>Required parameter not provided: '<span class="src-var">$parname</span>'.<span class="src-str">"</span><span class="src-str"><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1116"></a></span><span class="src-str"> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#var$_session">_session</a><span class="src-sym">-></span><span class="src-id">response</span><span class="src-sym">-></span><span class="src-id">render_to_output</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1117"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1118"></a></span><span class="src-str"> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1119"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1120"></a></span><span class="src-str"> </span></div></li>
- <li><div class="src-line"><a name="a1121"></a></span><span class="src-str"> <span class="src-key">return</span> <span class="src-var">$_REQUEST</span><span class="src-sym">[</span><span class="src-var">$parname</span><span class="src-sym">]</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1122"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1123"></a></span><span class="src-str"> </span></div></li>
- <li><div class="src-line"><a name="a1124"></a></span><span class="src-str"> /**</span></div></li>
- <li><div class="src-line"><a name="a1125"></a></span><span class="src-str"> * Obtains a named HTTP request parameter, optionally requiring it or not</span></div></li>
- <li><div class="src-line"><a name="a1126"></a></span><span class="src-str"> * @param string $parname The name of the parameter to get</span></div></li>
- <li><div class="src-line"><a name="a1127"></a></span><span class="src-str"> * @param bool $required Indicates whether or not to 'require' the parameter (if it is required, but cannot be found, then the script is terminated with an error message)</span></div></li>
- <li><div class="src-line"><a name="a1128"></a></span><span class="src-str"> * @param mixed $default If the $require parameter is false, and the HTTP parameter cannot be found, then this value will be returned instead</span></div></li>
- <li><div class="src-line"><a name="a1129"></a></span><span class="src-str"> * @return string|mixed The raw value of the HTTP parameter if found, or the value of parameter $default if it was not found and parameter $require was false</span></div></li>
- <li><div class="src-line"><a name="a1130"></a></span><span class="src-str"> */</span></div></li>
- <li><div class="src-line"><a name="a1131"></a></span><span class="src-str"> <span class="src-key">function</span> <span class="src-id">get_param</span><span class="src-sym">(</span><span class="src-var">$parname</span><span class="src-sym">,</span> <span class="src-var">$required</span><span class="src-sym">,</span> <span class="src-var">$default</span> = <span class="src-id">null</span><span class="src-sym">)</span></span></div></li>
- <li><div class="src-line"><a name="a1132"></a></span><span class="src-str"> <span class="src-sym">{</span></span></div></li>
- <li><div class="src-line"><a name="a1133"></a></span><span class="src-str"> <span class="src-comm">// Use the existing functions to fetch the parameter</span></span></div></li>
- <li><div class="src-line"><a name="a1134"></a></span><span class="src-str"> <span class="src-key">if</span> <span class="src-sym">(</span><span class="src-var">$required</span><span class="src-sym">)</span> <span class="src-key">return</span> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodrequired_param">required_param</a><span class="src-sym">(</span><span class="src-var">$parname</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1135"></a></span><span class="src-str"> <span class="src-key">return</span> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleRequest.html#methodoptional_param">optional_param</a><span class="src-sym">(</span><span class="src-var">$parname</span><span class="src-sym">,</span> <span class="src-var">$default</span><span class="src-sym">)</span><span class="src-sym">;</span></span></div></li>
- <li><div class="src-line"><a name="a1136"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- <li><div class="src-line"><a name="a1137"></a></span><span class="src-str"> <span class="src-sym">}</span></span></div></li>
- </ol></div>
- </div>
- <p class="notes" id="credit">
- Documentation generated on Mon, 07 Jul 2008 12:32:31 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </body>
- </html>
|