| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948 |
- <?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 general.php</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- </head>
- <body>
-
<h1>Source for file general.php</h1>
- <p>Documentation is available at <a href="../sloodle/_lib---general.php.html">general.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> </div></li>
- <li><div class="src-line"><a name="a3"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a4"></a><span class="src-doc"> * Sloodle general library.</span></div></li>
- <li><div class="src-line"><a name="a5"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a6"></a><span class="src-doc"> * Provides various utility functionality for general Sloodle purposes.</span></div></li>
- <li><div class="src-line"><a name="a7"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a8"></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="a9"></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="a10"></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="a11"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a12"></a><span class="src-doc"> * </span><span class="src-doc-tag">@contributor</span><span class="src-doc"> Edmund Edgar</span></div></li>
- <li><div class="src-line"><a name="a13"></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="a14"></a><span class="src-doc"> *</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> </div></li>
- <li><div class="src-line"><a name="a17"></a> <span class="src-comm">// This library expects that the Sloodle config file has already been included</span></div></li>
- <li><div class="src-line"><a name="a18"></a> <span class="src-comm">// (along with the Moodle libraries)</span></div></li>
- <li><div class="src-line"><a name="a19"></a> </div></li>
- <li><div class="src-line"><a name="a20"></a> <span class="src-doc">/** Include our email functionality. */</span></div></li>
- <li><div class="src-line"><a name="a21"></a> <span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">SLOODLE_LIBROOT</span>.<span class="src-str">'/mail.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a22"></a> </div></li>
- <li><div class="src-line"><a name="a23"></a> </div></li>
- <li><div class="src-line"><a name="a24"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a25"></a><span class="src-doc"> * Sets a Sloodle configuration value.</span></div></li>
- <li><div class="src-line"><a name="a26"></a><span class="src-doc"> * This data will be stored in Moodle's "config" table, so it will persist even after Sloodle is uninstalled.</span></div></li>
- <li><div class="src-line"><a name="a27"></a><span class="src-doc"> * After being set, it will be available (read-only) as a named member of Moodle's $CFG variable.</span></div></li>
- <li><div class="src-line"><a name="a28"></a><span class="src-doc"> * <b>NOTE:</b> in Sloodle debug mode, this function will terminate the script with an error if the name is not prefixed with "sloodle_".</span></div></li>
- <li><div class="src-line"><a name="a29"></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">$name </span><span class="src-doc">The name of the value to be stored (should be prefixed with "sloodle_")</span></div></li>
- <li><div class="src-line"><a name="a30"></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">$value </span><span class="src-doc">The string representation of the value to be stored</span></div></li>
- <li><div class="src-line"><a name="a31"></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 on success, or false on failure (may fail if database query encountered an error)</span></div></li>
- <li><div class="src-line"><a name="a32"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> sloodle_get_config()</span></div></li>
- <li><div class="src-line"><a name="a33"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a34"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_set_config">sloodle_set_config</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">, </span><span class="src-var">$value</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a35"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a36"></a> <span class="src-comm">// If in debug mode, ensure the name is prefixed appropriately for Sloodle</span></div></li>
- <li><div class="src-line"><a name="a37"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/defined">defined</a><span class="src-sym">(</span><span class="src-str">'SLOODLE_DEBUG'</span><span class="src-sym">) </span>&& <span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_DEBUG">SLOODLE_DEBUG</a></span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a38"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/substr_count">substr_count</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">, </span><span class="src-str">'sloodle_'</span><span class="src-sym">) </span>< <span class="src-num">1</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a39"></a> <span class="src-key">exit </span><span class="src-sym">(</span><span class="src-str">"</span><span class="src-str">ERROR: sloodle_set_config(..) called with invalid value name \"<span class="src-var">$name</span>\". Expected \"sloodle_\" prefix.</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="a40"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a41"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a42"></a> <span class="src-comm">// Use the standard Moodle config function, ignoring the 3rd parameter ("plugin", which defaults to NULL)</span></div></li>
- <li><div class="src-line"><a name="a43"></a> <span class="src-key">return </span><span class="src-id">set_config</span><span class="src-sym">(</span><a href="http://www.php.net/strtolower">strtolower</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-var">$value</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a44"></a> <span class="src-sym">}</span></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"> * Gets a Sloodle configuration value from Moodle's "config" table.</span></div></li>
- <li><div class="src-line"><a name="a48"></a><span class="src-doc"> * This function does not necessarily need to be used.</span></div></li>
- <li><div class="src-line"><a name="a49"></a><span class="src-doc"> * All configuration data is available as named members of Moodle's $CFG global variable.</span></div></li>
- <li><div class="src-line"><a name="a50"></a><span class="src-doc"> * <b>NOTE:</b> in Sloodle debug mode, this function will terminate the script with an error if the name is not prefixed with "sloodle_".</span></div></li>
- <li><div class="src-line"><a name="a51"></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">$name </span><span class="src-doc">The name of the value to be stored (should be prefixed with "sloodle_")</span></div></li>
- <li><div class="src-line"><a name="a52"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">A string containing the configuration value, or false if the query failed (e.g. if the named value didn't exist)</span></div></li>
- <li><div class="src-line"><a name="a53"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> sloodle_set_config()</span></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-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_get_config">sloodle_get_config</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a56"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a57"></a> <span class="src-comm">// If in debug mode, ensure the name is prefixed appropriately for Sloodle</span></div></li>
- <li><div class="src-line"><a name="a58"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/defined">defined</a><span class="src-sym">(</span><span class="src-str">'SLOODLE_DEBUG'</span><span class="src-sym">) </span>&& <span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_DEBUG">SLOODLE_DEBUG</a></span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a59"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/substr_count">substr_count</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">, </span><span class="src-str">'sloodle_'</span><span class="src-sym">) </span>< <span class="src-num">1</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a60"></a> <span class="src-key">exit </span><span class="src-sym">(</span><span class="src-str">"</span><span class="src-str">ERROR: sloodle_get_config(..) called with invalid value name \"<span class="src-var">$name</span>\". Expected \"sloodle_\" prefix.</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="a61"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a62"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a63"></a> <span class="src-comm">// Use the Moodle config function, ignoring the plugin parameter</span></div></li>
- <li><div class="src-line"><a name="a64"></a> <span class="src-var">$val </span>= <span class="src-id">get_config</span><span class="src-sym">(</span><span class="src-id">NULL</span><span class="src-sym">, </span><a href="http://www.php.net/strtolower">strtolower</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a65"></a> <span class="src-comm">// Older Moodle versions return a database record object instead of the value itself</span></div></li>
- <li><div class="src-line"><a name="a66"></a> <span class="src-comm">// Workaround:</span></div></li>
- <li><div class="src-line"><a name="a67"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_object">is_object</a><span class="src-sym">(</span><span class="src-var">$val</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-var">$val</span><span class="src-sym">-></span><span class="src-id">value</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a68"></a> <span class="src-key">return </span><span class="src-var">$val</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a69"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a70"></a> </div></li>
- <li><div class="src-line"><a name="a71"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a72"></a><span class="src-doc"> * Determines whether or not auto-registration is allowed for the site.</span></div></li>
- <li><div class="src-line"><a name="a73"></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 auto-reg is allowed on the site, or false otherwise.</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">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_autoreg_enabled_site">sloodle_autoreg_enabled_site</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a76"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a77"></a> <span class="src-key">return </span>(bool)<a href="../sloodle/_lib---general.php.html#functionsloodle_get_config">sloodle_get_config</a><span class="src-sym">(</span><span class="src-str">'sloodle_allow_autoreg'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a78"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a79"></a> </div></li>
- <li><div class="src-line"><a name="a80"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a81"></a><span class="src-doc"> * Determines whether or not auto-enrolment is allowed for the site.</span></div></li>
- <li><div class="src-line"><a name="a82"></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 auto-enrolment is allowed on the site, or false otherwise.</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">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_autoenrol_enabled_site">sloodle_autoenrol_enabled_site</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a85"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a86"></a> <span class="src-key">return </span>(bool)<a href="../sloodle/_lib---general.php.html#functionsloodle_get_config">sloodle_get_config</a><span class="src-sym">(</span><span class="src-str">'sloodle_allow_autoenrol'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a87"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a88"></a> </div></li>
- <li><div class="src-line"><a name="a89"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a90"></a><span class="src-doc"> * Sends an XMLRPC message into Second Life.</span></div></li>
- <li><div class="src-line"><a name="a91"></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">$channel </span><span class="src-doc">A string containing a UUID identifying the XMLRPC channel in SL to be used</span></div></li>
- <li><div class="src-line"><a name="a92"></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">$intval </span><span class="src-doc">An integer value to be sent in the message</span></div></li>
- <li><div class="src-line"><a name="a93"></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">$strval </span><span class="src-doc">A string value to be sent in the message</span></div></li>
- <li><div class="src-line"><a name="a94"></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 if an error occurs</span></div></li>
- <li><div class="src-line"><a name="a95"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a96"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_send_xmlrpc_message">sloodle_send_xmlrpc_message</a><span class="src-sym">(</span><span class="src-var">$channel</span><span class="src-sym">,</span><span class="src-var">$intval</span><span class="src-sym">,</span><span class="src-var">$strval</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a97"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a98"></a> <span class="src-comm">// Include our XMLRPC library</span></div></li>
- <li><div class="src-line"><a name="a99"></a> <span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_DIRROOT">SLOODLE_DIRROOT</a></span>.<span class="src-str">'/lib/xmlrpc.inc'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a100"></a> <span class="src-comm">// Instantiate a new client object for communicating with Second Life</span></div></li>
- <li><div class="src-line"><a name="a101"></a> <span class="src-var">$client </span>= <span class="src-key">new </span><span class="src-id">xmlrpc_client</span><span class="src-sym">(</span><span class="src-str">"http://xmlrpc.secondlife.com/cgi-bin/xmlrpc.cgi"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a102"></a> <span class="src-comm">// Construct the content of the RPC</span></div></li>
- <li><div class="src-line"><a name="a103"></a> <span class="src-var">$content </span>= <span class="src-str">'<?xml version="1.0"?><methodCall><methodName>llRemoteData</methodName><params><param><value><struct><member><name>Channel</name><value><string>'</span>.<span class="src-var">$channel</span>.<span class="src-str">'</string></value></member><member><name>IntValue</name><value><int>'</span>.<span class="src-var">$intval</span>.<span class="src-str">'</int></value></member><member><name>StringValue</name><value><string>'</span>.<span class="src-var">$strval</span>.<span class="src-str">'</string></value></member></struct></value></param></params></methodCall>'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a104"></a> </div></li>
- <li><div class="src-line"><a name="a105"></a> <span class="src-comm">// Attempt to send the data via http</span></div></li>
- <li><div class="src-line"><a name="a106"></a> <span class="src-var">$response </span>= <span class="src-var">$client</span><span class="src-sym">-></span><span class="src-id">send</span><span class="src-sym">(</span></div></li>
- <li><div class="src-line"><a name="a107"></a> <span class="src-var">$content</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a108"></a> <span class="src-num">60</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a109"></a> <span class="src-str">'http'</span></div></li>
- <li><div class="src-line"><a name="a110"></a> <span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a111"></a> </div></li>
- <li><div class="src-line"><a name="a112"></a> <span class="src-comm">//var_dump($response); // Debug output</span></div></li>
- <li><div class="src-line"><a name="a113"></a> <span class="src-comm">// Make sure we got a response value</span></div></li>
- <li><div class="src-line"><a name="a114"></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">$response</span><span class="src-sym">-></span><span class="src-id">val</span><span class="src-sym">) </span>|| <span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$response</span><span class="src-sym">-></span><span class="src-id">val</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">$response</span><span class="src-sym">-></span><span class="src-id">val</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a115"></a> <span class="src-comm">// Report an error if we are in debug mode</span></div></li>
- <li><div class="src-line"><a name="a116"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/defined">defined</a><span class="src-sym">(</span><span class="src-str">'SLOODLE_DEBUG'</span><span class="src-sym">) </span>&& <span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_DEBUG">SLOODLE_DEBUG</a></span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a117"></a> print <span class="src-str">'<p align="left">Not getting the expected XMLRPC response. Is Second Life broken again?<br/>'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a118"></a> <span class="src-key">if </span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$response</span><span class="src-sym">-></span><span class="src-id">errstr</span><span class="src-sym">)) </span>print <span class="src-str">"XMLRPC Error - "</span>.<span class="src-var">$response</span><span class="src-sym">-></span><span class="src-id">errstr</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a119"></a> print <span class="src-str">'</p>'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a120"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a121"></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="a122"></a> <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-comm">// Check the contents of the response value</span></div></li>
- <li><div class="src-line"><a name="a125"></a> <span class="src-comm">//if (defined('SLOODLE_DEBUG') && SLOODLE_DEBUG) {</span></div></li>
- <li><div class="src-line"><a name="a126"></a> <span class="src-comm">// print_r($response->val);</span></div></li>
- <li><div class="src-line"><a name="a127"></a> <span class="src-comm">//}</span></div></li>
- <li><div class="src-line"><a name="a128"></a> </div></li>
- <li><div class="src-line"><a name="a129"></a> <span class="src-comm">//TODO: Check the details of the response to see if this was successful or not...</span></div></li>
- <li><div class="src-line"><a name="a130"></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="a131"></a> </div></li>
- <li><div class="src-line"><a name="a132"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a133"></a> </div></li>
- <li><div class="src-line"><a name="a134"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a135"></a><span class="src-doc"> * Old logging function</span></div></li>
- <li><div class="src-line"><a name="a136"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> <b>May require update?</b></span></div></li>
- <li><div class="src-line"><a name="a137"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a138"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_add_to_log">sloodle_add_to_log</a><span class="src-sym">(</span><span class="src-var">$courseid </span>= <span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$module </span>= <span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$action </span>= <span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$url </span>= <span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$cmid </span>= <span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$info </span>= <span class="src-id">null</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a139"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a140"></a> </div></li>
- <li><div class="src-line"><a name="a141"></a> <span class="src-key">global </span><span class="src-var">$CFG</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a142"></a> </div></li>
- <li><div class="src-line"><a name="a143"></a> <span class="src-comm">// TODO: Make sure we set this in the calling function, then remove this bit</span></div></li>
- <li><div class="src-line"><a name="a144"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$courseid </span>== <span class="src-id">null</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a145"></a> <span class="src-var">$courseid </span>= <span class="src-id">optional_param</span><span class="src-sym">(</span><span class="src-str">'sloodle_courseid'</span><span class="src-sym">,</span><span class="src-num">0</span><span class="src-sym">,</span><span class="src-id">PARAM_RAW</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a146"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a147"></a> </div></li>
- <li><div class="src-line"><a name="a148"></a> <span class="src-comm">// if no action is specified, use the object name</span></div></li>
- <li><div class="src-line"><a name="a149"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$action </span>== <span class="src-id">null</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a150"></a> <span class="src-var">$action </span>= <span class="src-var">$_SERVER</span><span class="src-sym">[</span><span class="src-str">'X-SecondLife-Object-Name'</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a151"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a152"></a> </div></li>
- <li><div class="src-line"><a name="a153"></a> <span class="src-var">$region </span>= <span class="src-var">$_SERVER</span><span class="src-sym">[</span><span class="src-str">'X-SecondLife-Region'</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a154"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$info </span>== <span class="src-id">null</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a155"></a> <span class="src-var">$info </span>= <span class="src-var">$region</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a156"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a157"></a> </div></li>
- <li><div class="src-line"><a name="a158"></a> <span class="src-var">$slurl </span>= <span class="src-str">''</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a159"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/preg_match">preg_match</a><span class="src-sym">(</span><span class="src-str">'/^(.*)\(.*?\)$/'</span><span class="src-sym">,</span><span class="src-var">$region</span><span class="src-sym">,</span><span class="src-var">$matches</span><span class="src-sym">)) </span><span class="src-sym">{ </span><span class="src-comm">// strip the coordinates, eg. Cicero (123,123)</span></div></li>
- <li><div class="src-line"><a name="a160"></a> <span class="src-var">$region </span>= <span class="src-var">$matches</span><span class="src-sym">[</span><span class="src-num">1</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a161"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a162"></a> </div></li>
- <li><div class="src-line"><a name="a163"></a> <span class="src-var">$xyz </span>= <span class="src-var">$_SERVER</span><span class="src-sym">[</span><span class="src-str">'X-SecondLife-Local-Position'</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a164"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/preg_match">preg_match</a><span class="src-sym">(</span><span class="src-str">'/^\((.*?),(.*?),(.*?)\)$/'</span><span class="src-sym">,</span><span class="src-var">$xyz</span><span class="src-sym">,</span><span class="src-var">$matches</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a165"></a> <span class="src-var">$xyz </span>= <span class="src-var">$matches</span><span class="src-sym">[</span><span class="src-num">1</span><span class="src-sym">]</span>.<span class="src-str">'/'</span>.<span class="src-var">$matches</span><span class="src-sym">[</span><span class="src-num">2</span><span class="src-sym">]</span>.<span class="src-str">'/'</span>.<span class="src-var">$matches</span><span class="src-sym">[</span><span class="src-num">3</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a166"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a167"></a> </div></li>
- <li><div class="src-line"><a name="a168"></a> <span class="src-key">return </span><span class="src-id">add_to_log</span><span class="src-sym">(</span><span class="src-var">$courseid</span><span class="src-sym">, </span><span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$action</span><span class="src-sym">, </span><span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">wwwroot</span>.<span class="src-str">'/mod/sloodle/toslurl.php?region='</span>.<a href="http://www.php.net/urlencode">urlencode</a><span class="src-sym">(</span><span class="src-var">$region</span><span class="src-sym">)</span>.<span class="src-str">'&xyz='</span>.<span class="src-var">$xyz</span><span class="src-sym">, </span><span class="src-var">$userid</span><span class="src-sym">, </span><span class="src-var">$info </span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a169"></a> <span class="src-comm">//return add_to_log($courseid, null, "ok", "ok", $userid, "ok");</span></div></li>
- <li><div class="src-line"><a name="a170"></a> </div></li>
- <li><div class="src-line"><a name="a171"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a172"></a> </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-doc"> * Determines whether or not Sloodle is installed.</span></div></li>
- <li><div class="src-line"><a name="a175"></a><span class="src-doc"> * Queries Moodle's modules table for a Sloodle entry.</span></div></li>
- <li><div class="src-line"><a name="a176"></a><span class="src-doc"> * <b>NOTE:</b> does not check for the presence of the Sloodle files.</span></div></li>
- <li><div class="src-line"><a name="a177"></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 Sloodle is installed, or false otherwise.</span></div></li>
- <li><div class="src-line"><a name="a178"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a179"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_is_installed">sloodle_is_installed</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a180"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a181"></a> <span class="src-comm">// Is there a Sloodle entry in the modules table?</span></div></li>
- <li><div class="src-line"><a name="a182"></a> <span class="src-key">return </span><span class="src-id">record_exists</span><span class="src-sym">(</span><span class="src-str">'modules'</span><span class="src-sym">, </span><span class="src-str">'name'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a183"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a184"></a> </div></li>
- <li><div class="src-line"><a name="a185"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a186"></a><span class="src-doc"> * Generates a random login security token.</span></div></li>
- <li><div class="src-line"><a name="a187"></a><span class="src-doc"> * Uses mixed-case letters and numbers to generate a random 16-character string.</span></div></li>
- <li><div class="src-line"><a name="a188"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
- <li><div class="src-line"><a name="a189"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> sloodle_random_web_password()</span></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-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_random_security_token">sloodle_random_security_token</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a192"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a193"></a> <span class="src-comm">// Define the characters we can use in our token, and get the length of it</span></div></li>
- <li><div class="src-line"><a name="a194"></a> <span class="src-var">$str </span>= <span class="src-str">"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a195"></a> <span class="src-var">$strlen </span>= <a href="http://www.php.net/strlen">strlen</a><span class="src-sym">(</span><span class="src-var">$str</span><span class="src-sym">) </span>- <span class="src-num">1</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a196"></a> <span class="src-comm">// Prepare the token variable</span></div></li>
- <li><div class="src-line"><a name="a197"></a> <span class="src-var">$token </span>= <span class="src-str">''</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a198"></a> <span class="src-comm">// Loop once for each output character</span></div></li>
- <li><div class="src-line"><a name="a199"></a> <span class="src-key">for</span><span class="src-sym">(</span><span class="src-var">$length </span>= <span class="src-num">0</span><span class="src-sym">; </span><span class="src-var">$length </span>< <span class="src-num">16</span><span class="src-sym">; </span><span class="src-var">$length</span>++<span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a200"></a> <span class="src-comm">// Shuffle the string, then pick and store a random character</span></div></li>
- <li><div class="src-line"><a name="a201"></a> <span class="src-var">$str </span>= <a href="http://www.php.net/str_shuffle">str_shuffle</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="a202"></a> <span class="src-var">$char </span>= <a href="http://www.php.net/mt_rand">mt_rand</a><span class="src-sym">(</span><span class="src-num">0</span><span class="src-sym">, </span><span class="src-var">$strlen</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a203"></a> <span class="src-var">$token </span>.= <span class="src-var">$str</span><span class="src-sym">[</span><span class="src-var">$char</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a204"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a205"></a> </div></li>
- <li><div class="src-line"><a name="a206"></a> <span class="src-key">return </span><span class="src-var">$token</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a207"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a208"></a> </div></li>
- <li><div class="src-line"><a name="a209"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a210"></a><span class="src-doc"> * Generates a random web password</span></div></li>
- <li><div class="src-line"><a name="a211"></a><span class="src-doc"> * Uses mixed-case letters and numbers to generate a random 8-character string.</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></div></li>
- <li><div class="src-line"><a name="a213"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> sloodle_random_security_token()</span></div></li>
- <li><div class="src-line"><a name="a214"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a215"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_random_web_password">sloodle_random_web_password</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a216"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a217"></a> <span class="src-comm">// Define the characters we can use in our token, and get the length of it</span></div></li>
- <li><div class="src-line"><a name="a218"></a> <span class="src-var">$str </span>= <span class="src-str">"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a219"></a> <span class="src-var">$strlen </span>= <a href="http://www.php.net/strlen">strlen</a><span class="src-sym">(</span><span class="src-var">$str</span><span class="src-sym">) </span>- <span class="src-num">1</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a220"></a> <span class="src-comm">// Prepare the password string</span></div></li>
- <li><div class="src-line"><a name="a221"></a> <span class="src-var">$pwd </span>= <span class="src-str">''</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a222"></a> <span class="src-comm">// Loop once for each output character</span></div></li>
- <li><div class="src-line"><a name="a223"></a> <span class="src-key">for</span><span class="src-sym">(</span><span class="src-var">$length </span>= <span class="src-num">0</span><span class="src-sym">; </span><span class="src-var">$length </span>< <span class="src-num">8</span><span class="src-sym">; </span><span class="src-var">$length</span>++<span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a224"></a> <span class="src-comm">// Shuffle the string, then pick and store a random character</span></div></li>
- <li><div class="src-line"><a name="a225"></a> <span class="src-var">$str </span>= <a href="http://www.php.net/str_shuffle">str_shuffle</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="a226"></a> <span class="src-var">$char </span>= <a href="http://www.php.net/mt_rand">mt_rand</a><span class="src-sym">(</span><span class="src-num">0</span><span class="src-sym">, </span><span class="src-var">$strlen</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a227"></a> <span class="src-var">$pwd </span>.= <span class="src-var">$str</span><span class="src-sym">[</span><span class="src-var">$char</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a228"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a229"></a> </div></li>
- <li><div class="src-line"><a name="a230"></a> <span class="src-key">return </span><span class="src-var">$pwd</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a231"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a232"></a> </div></li>
- <li><div class="src-line"><a name="a233"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a234"></a><span class="src-doc"> * Generates a random prim password (7 to 9 digit number).</span></div></li>
- <li><div class="src-line"><a name="a235"></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 password as a string</span></div></li>
- <li><div class="src-line"><a name="a236"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a237"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_random_prim_password">sloodle_random_prim_password</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a238"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a239"></a> <span class="src-key">return </span>(string)<a href="http://www.php.net/mt_rand">mt_rand</a><span class="src-sym">(</span><span class="src-num">1000000</span><span class="src-sym">, </span><span class="src-num">999999999</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a240"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a241"></a> </div></li>
- <li><div class="src-line"><a name="a242"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a243"></a><span class="src-doc"> * Converts a string vector to an array vector.</span></div></li>
- <li><div class="src-line"><a name="a244"></a><span class="src-doc"> * String vector should be of format "<x,y,z>".</span></div></li>
- <li><div class="src-line"><a name="a245"></a><span class="src-doc"> * Converts to associative array with members 'x', 'y', and 'z'.</span></div></li>
- <li><div class="src-line"><a name="a246"></a><span class="src-doc"> * Returns false if input parameter was not of correct format.</span></div></li>
- <li><div class="src-line"><a name="a247"></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">$vector </span><span class="src-doc">A string vector of format "<x,y,z>".</span></div></li>
- <li><div class="src-line"><a name="a248"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span></div></li>
- <li><div class="src-line"><a name="a249"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> sloodle_array_to_vector()</span></div></li>
- <li><div class="src-line"><a name="a250"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> sloodle_round_vector()</span></div></li>
- <li><div class="src-line"><a name="a251"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a252"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array</a><span class="src-sym">(</span><span class="src-var">$vector</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a253"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a254"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/preg_match">preg_match</a><span class="src-sym">(</span><span class="src-str">'/<(.*?),(.*?),(.*?)>/'</span><span class="src-sym">,</span><span class="src-var">$vector</span><span class="src-sym">,</span><span class="src-var">$vectorbits</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a255"></a> <span class="src-var">$arr </span>= <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="a256"></a> <span class="src-var">$arr</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">] </span>= <span class="src-var">$vectorbits</span><span class="src-sym">[</span><span class="src-num">1</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a257"></a> <span class="src-var">$arr</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">] </span>= <span class="src-var">$vectorbits</span><span class="src-sym">[</span><span class="src-num">2</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a258"></a> <span class="src-var">$arr</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">] </span>= <span class="src-var">$vectorbits</span><span class="src-sym">[</span><span class="src-num">3</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a259"></a> <span class="src-key">return </span><span class="src-var">$arr</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a260"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a261"></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="a262"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a263"></a> </div></li>
- <li><div class="src-line"><a name="a264"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a265"></a><span class="src-doc"> * Converts an array vector to a string vector.</span></div></li>
- <li><div class="src-line"><a name="a266"></a><span class="src-doc"> * Array vector should be associative, containing elements 'x', 'y', and 'z'.</span></div></li>
- <li><div class="src-line"><a name="a267"></a><span class="src-doc"> * Converts to a string vector of format "<x,y,z>".</span></div></li>
- <li><div class="src-line"><a name="a268"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
- <li><div class="src-line"><a name="a269"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> sloodle_vector_to_array()</span></div></li>
- <li><div class="src-line"><a name="a270"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> sloodle_round_vector()</span></div></li>
- <li><div class="src-line"><a name="a271"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a272"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_array_to_vector">sloodle_array_to_vector</a><span class="src-sym">(</span><span class="src-var">$arr</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-var">$ret </span>= <span class="src-str">'<'</span>.<span class="src-var">$arr</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">]</span>.<span class="src-str">','</span>.<span class="src-var">$arr</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">]</span>.<span class="src-str">','</span>.<span class="src-var">$arr</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">]</span>.<span class="src-str">'>'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a275"></a> <span class="src-key">return </span><span class="src-var">$ret</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a276"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a277"></a> </div></li>
- <li><div class="src-line"><a name="a278"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a279"></a><span class="src-doc"> * Obtains the identified course module instance database record.</span></div></li>
- <li><div class="src-line"><a name="a280"></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">$id </span><span class="src-doc">The integer ID of a course module instance</span></div></li>
- <li><div class="src-line"><a name="a281"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc"> A database record if successful, or false if it could not be found</span></div></li>
- <li><div class="src-line"><a name="a282"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a283"></a> <span class="src-key">function </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">$id</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a284"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a285"></a> <span class="src-key">return </span><span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'course_modules'</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span><span class="src-var">$id</span><span class="src-sym">)</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> </div></li>
- <li><div class="src-line"><a name="a288"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a289"></a><span class="src-doc"> * Determines whether or not the specified course module instance is visible.</span></div></li>
- <li><div class="src-line"><a name="a290"></a><span class="src-doc"> * Checks that the instance itself and the course section are both valid.</span></div></li>
- <li><div class="src-line"><a name="a291"></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">$id </span><span class="src-doc">The integer ID of a course module instance.</span></div></li>
- <li><div class="src-line"><a name="a292"></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 visible, or false if invisible or not found</span></div></li>
- <li><div class="src-line"><a name="a293"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a294"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_is_course_module_instance_visible">sloodle_is_course_module_instance_visible</a><span class="src-sym">(</span><span class="src-var">$id</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a295"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a296"></a> <span class="src-comm">// Get the course module instance record, whether directly from the parameter, or from the database</span></div></li>
- <li><div class="src-line"><a name="a297"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_object">is_object</a><span class="src-sym">(</span><span class="src-var">$id</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-var">$course_module_instance </span>= <span class="src-var">$id</span><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">$id</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-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-sym">(</span><span class="src-var">$course_module_instance </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'course_modules'</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span><span class="src-var">$id</span><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="a301"></a> <span class="src-sym">} </span><span class="src-key">else </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="a302"></a> </div></li>
- <li><div class="src-line"><a name="a303"></a> <span class="src-comm">// Make sure the instance itself is visible</span></div></li>
- <li><div class="src-line"><a name="a304"></a> <span class="src-key">if </span><span class="src-sym">(</span>(int)<span class="src-var">$course_module_instance</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-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a305"></a> <span class="src-comm">// Find out which section it is in, and if that section is valid</span></div></li>
- <li><div class="src-line"><a name="a306"></a> <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">$section </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'course_sections'</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span><span class="src-var">$course_module_instance</span><span class="src-sym">-></span><span class="src-id">section</span><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="a307"></a> <span class="src-key">if </span><span class="src-sym">(</span>(int)<span class="src-var">$section</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-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a308"></a> </div></li>
- <li><div class="src-line"><a name="a309"></a> <span class="src-comm">// Looks like the module is visible</span></div></li>
- <li><div class="src-line"><a name="a310"></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="a311"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a312"></a> </div></li>
- <li><div class="src-line"><a name="a313"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a314"></a><span class="src-doc"> * Determines if the specified course module instance is of the named type.</span></div></li>
- <li><div class="src-line"><a name="a315"></a><span class="src-doc"> * For example, this can check if a particular instance is a "forum" or a "chat".</span></div></li>
- <li><div class="src-line"><a name="a316"></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">$id </span><span class="src-doc">The integer ID of a course module instance</span></div></li>
- <li><div class="src-line"><a name="a317"></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">$module_name </span><span class="src-doc">Module type to check (must be the exact name of an installed module, e.g. 'sloodle' or 'quiz')</span></div></li>
- <li><div class="src-line"><a name="a318"></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 module is of the specified type, or false otherwise</span></div></li>
- <li><div class="src-line"><a name="a319"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a320"></a> <span class="src-key">function </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">$id</span><span class="src-sym">, </span><span class="src-var">$module_name</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a321"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a322"></a> <span class="src-comm">// Get the record for the module type</span></div></li>
- <li><div class="src-line"><a name="a323"></a> <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">$module_record </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'modules'</span><span class="src-sym">, </span><span class="src-str">'name'</span><span class="src-sym">, </span><span class="src-var">$module_name</span><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="a324"></a> </div></li>
- <li><div class="src-line"><a name="a325"></a> <span class="src-comm">// Get the course module instance record, whether directly from the parameter, or from the database</span></div></li>
- <li><div class="src-line"><a name="a326"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_object">is_object</a><span class="src-sym">(</span><span class="src-var">$id</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a327"></a> <span class="src-var">$course_module_instance </span>= <span class="src-var">$id</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a328"></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">$id</span><span class="src-sym">)) </span><span class="src-sym">{</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><span class="src-sym">(</span><span class="src-var">$course_module_instance </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'course_modules'</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span><span class="src-var">$id</span><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="a330"></a> <span class="src-sym">} </span><span class="src-key">else </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="a331"></a> </div></li>
- <li><div class="src-line"><a name="a332"></a> <span class="src-comm">// Check the type of the instance</span></div></li>
- <li><div class="src-line"><a name="a333"></a> <span class="src-key">return </span><span class="src-sym">(</span><span class="src-var">$course_module_instance</span><span class="src-sym">-></span><span class="src-id">module </span>== <span class="src-var">$module_record</span><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a334"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a335"></a> </div></li>
- <li><div class="src-line"><a name="a336"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a337"></a><span class="src-doc"> * Obtains the ID number of the specified module (type not instance).</span></div></li>
- <li><div class="src-line"><a name="a338"></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">$name </span><span class="src-doc">The name of the module type to check, e.g. 'sloodle' or 'forum'</span></div></li>
- <li><div class="src-line"><a name="a339"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">Integer containing module ID, or false if it is not installed</span></div></li>
- <li><div class="src-line"><a name="a340"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a341"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_get_module_id">sloodle_get_module_id</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a342"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a343"></a> <span class="src-comm">// Ensure the name is a non-empty string</span></div></li>
- <li><div class="src-line"><a name="a344"></a> <span class="src-key">if </span><span class="src-sym">(</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">$name</span><span class="src-sym">) </span>|| <span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$name</span><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="a345"></a> <span class="src-comm">// Obtain the module record</span></div></li>
- <li><div class="src-line"><a name="a346"></a> <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">$module_record </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'modules'</span><span class="src-sym">, </span><span class="src-str">'name'</span><span class="src-sym">, </span><span class="src-var">$module_name</span><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="a347"></a> </div></li>
- <li><div class="src-line"><a name="a348"></a> <span class="src-key">return </span><span class="src-var">$module_record</span><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a349"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a350"></a> </div></li>
- <li><div class="src-line"><a name="a351"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a352"></a><span class="src-doc"> * Checks if the specified position is in the current (site-wide) loginzone.</span></div></li>
- <li><div class="src-line"><a name="a353"></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">$pos </span><span class="src-doc">A string vector or an associated array vector</span></div></li>
- <li><div class="src-line"><a name="a354"></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 position is in LoginZone, or false if not</span></div></li>
- <li><div class="src-line"><a name="a355"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> sloodle_login_zone_coordinates()</span></div></li>
- <li><div class="src-line"><a name="a356"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Update or remove... no longer valid</span></div></li>
- <li><div class="src-line"><a name="a357"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a358"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_position_is_in_login_zone">sloodle_position_is_in_login_zone</a><span class="src-sym">(</span><span class="src-var">$pos</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a359"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a360"></a> <span class="src-comm">// Get a position array from the parameter</span></div></li>
- <li><div class="src-line"><a name="a361"></a> <span class="src-var">$posarr </span>= <span class="src-id">NULL</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a362"></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">$pos</span><span class="src-sym">) </span>&& <a href="http://www.php.net/count">count</a><span class="src-sym">(</span><span class="src-var">$pos</span><span class="src-sym">) </span>== <span class="src-num">3</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a363"></a> <span class="src-var">$posarr </span>= <span class="src-var">$pos</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a364"></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_string">is_string</a><span class="src-sym">(</span><span class="src-var">$pos</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a365"></a> <span class="src-var">$posarr </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array</a><span class="src-sym">(</span><span class="src-var">$pos</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a366"></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="a367"></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="a368"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a369"></a> <span class="src-comm">// Fetch the loginzone boundaries</span></div></li>
- <li><div class="src-line"><a name="a370"></a> list<span class="src-sym">(</span><span class="src-var">$maxarr</span><span class="src-sym">,</span><span class="src-var">$minarr</span><span class="src-sym">) </span>= <span class="src-id">sloodle_login_zone_coordinates</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="a371"></a> </div></li>
- <li><div class="src-line"><a name="a372"></a> <span class="src-comm">// Make sure the position is not past the maximum bounds</span></div></li>
- <li><div class="src-line"><a name="a373"></a> <span class="src-key">if </span><span class="src-sym">( (</span><span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">] </span>> <span class="src-var">$maxarr</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">]</span><span class="src-sym">) </span>|| <span class="src-sym">(</span><span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">] </span>> <span class="src-var">$maxarr</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">]</span><span class="src-sym">) </span>|| <span class="src-sym">(</span><span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">] </span>> <span class="src-var">$maxarr</span><span class="src-sym">[</span><span class="src-str">'z'</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="a374"></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="a375"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a376"></a> <span class="src-comm">// Make sure the position is not past the minimum bounds</span></div></li>
- <li><div class="src-line"><a name="a377"></a> <span class="src-key">if </span><span class="src-sym">( (</span><span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">] </span>< <span class="src-var">$minarr</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">]</span><span class="src-sym">) </span>|| <span class="src-sym">(</span><span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">] </span>< <span class="src-var">$minarr</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">]</span><span class="src-sym">) </span>|| <span class="src-sym">(</span><span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">] </span>< <span class="src-var">$minarr</span><span class="src-sym">[</span><span class="src-str">'z'</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="a378"></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="a379"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a380"></a> </div></li>
- <li><div class="src-line"><a name="a381"></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="a382"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a383"></a> </div></li>
- <li><div class="src-line"><a name="a384"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a385"></a><span class="src-doc"> * Generates teleport coordinates for a user who has already finished the LoginZone process.</span></div></li>
- <li><div class="src-line"><a name="a386"></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">$pos </span><span class="src-doc">A string vector giving the position of the LoginZone</span></div></li>
- <li><div class="src-line"><a name="a387"></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">$size </span><span class="src-doc">A string vector giving the size of the LoginZone</span></div></li>
- <li><div class="src-line"><a name="a388"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array, </span><span class="src-doc">bool An associative array vector containing a teleport location, or false if the operation fails.</span></div></li>
- <li><div class="src-line"><a name="a389"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a390"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_finished_login_coordinates">sloodle_finished_login_coordinates</a><span class="src-sym">(</span><span class="src-var">$pos</span><span class="src-sym">, </span><span class="src-var">$size</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-comm">// Make sure the parameters are valid types</span></div></li>
- <li><div class="src-line"><a name="a393"></a> <span class="src-key">if </span><span class="src-sym">(</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">$pos</span><span class="src-sym">) </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">$size</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a394"></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="a395"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a396"></a> <span class="src-comm">// Convert both to arrays</span></div></li>
- <li><div class="src-line"><a name="a397"></a> <span class="src-var">$posarr </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array</a><span class="src-sym">(</span><span class="src-var">$pos</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a398"></a> <span class="src-var">$sizearr </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array</a><span class="src-sym">(</span><span class="src-var">$size</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a399"></a> <span class="src-comm">// Calculate a position just below the loginzone</span></div></li>
- <li><div class="src-line"><a name="a400"></a> <span class="src-var">$coord </span>= <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="a401"></a> <span class="src-var">$coord</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">] </span>= <a href="http://www.php.net/round">round</a><span class="src-sym">(</span><span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">]</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="a402"></a> <span class="src-var">$coord</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">] </span>= <a href="http://www.php.net/round">round</a><span class="src-sym">(</span><span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">]</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="a403"></a> <span class="src-var">$coord</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">] </span>= <a href="http://www.php.net/round">round</a><span class="src-sym">((</span><span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">]</span>-<span class="src-sym">((</span><span class="src-var">$sizearr</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">]</span><span class="src-sym">)</span>/<span class="src-num">2</span><span class="src-sym">)</span>-<span class="src-num">2</span><span class="src-sym">)</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="a404"></a> <span class="src-key">return </span><span class="src-var">$coord</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a405"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a406"></a> </div></li>
- <li><div class="src-line"><a name="a407"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a408"></a><span class="src-doc"> * Generates a random position within a cuboid zone of the specified size.</span></div></li>
- <li><div class="src-line"><a name="a409"></a><span class="src-doc"> * (Note: leaves a 2 metre margin round the outside)</span></div></li>
- <li><div class="src-line"><a name="a410"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">$size </span><span class="src-doc">Associative array giving the size of the zone</span></div></li>
- <li><div class="src-line"><a name="a411"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span><span class="src-doc">An associative vector array</span></div></li>
- <li><div class="src-line"><a name="a412"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a413"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_random_position_in_zone">sloodle_random_position_in_zone</a><span class="src-sym">(</span><span class="src-var">$size</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a414"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a415"></a> <span class="src-comm">// Construct the half-size array</span></div></li>
- <li><div class="src-line"><a name="a416"></a> <span class="src-var">$halfsize </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'x'</span>=><span class="src-sym">(</span><span class="src-var">$size</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">] </span>/ <span class="src-num">2.0</span><span class="src-sym">) </span>- <span class="src-num">2.0</span><span class="src-sym">, </span><span class="src-str">'y'</span>=><span class="src-sym">(</span><span class="src-var">$size</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">] </span>/ <span class="src-num">2.0</span><span class="src-sym">) </span>- <span class="src-num">2.0</span><span class="src-sym">, </span><span class="src-str">'z'</span>=><span class="src-sym">(</span><span class="src-var">$size</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">] </span>/ <span class="src-num">2.0</span><span class="src-sym">) </span>- <span class="src-num">2.0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a417"></a> </div></li>
- <li><div class="src-line"><a name="a418"></a> <span class="src-var">$pos </span>= <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="a419"></a> <span class="src-var">$pos</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">] </span>= <a href="http://www.php.net/mt_rand">mt_rand</a><span class="src-sym">(</span><span class="src-num">0.0</span><span class="src-sym">, </span><span class="src-var">$size</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">] </span>- <span class="src-num">4.0</span><span class="src-sym">) </span>- <span class="src-var">$halfsize</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a420"></a> <span class="src-var">$pos</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">] </span>= <a href="http://www.php.net/mt_rand">mt_rand</a><span class="src-sym">(</span><span class="src-num">0.0</span><span class="src-sym">, </span><span class="src-var">$size</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">] </span>- <span class="src-num">4.0</span><span class="src-sym">) </span>- <span class="src-var">$halfsize</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a421"></a> <span class="src-var">$pos</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">] </span>= <a href="http://www.php.net/mt_rand">mt_rand</a><span class="src-sym">(</span><span class="src-num">0.0</span><span class="src-sym">, </span><span class="src-var">$size</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">] </span>- <span class="src-num">4.0</span><span class="src-sym">) </span>- <span class="src-var">$halfsize</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a422"></a> <span class="src-key">return </span><span class="src-var">$pos</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a423"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a424"></a> </div></li>
- <li><div class="src-line"><a name="a425"></a> <span class="src-comm">// Round the specified 3d vector to integer values</span></div></li>
- <li><div class="src-line"><a name="a426"></a> <span class="src-comm">// $pos should be a vector string "<x,y,z>" or an associative array {x,y,z}</span></div></li>
- <li><div class="src-line"><a name="a427"></a> <span class="src-comm">// Return is the same as the type passed-in</span></div></li>
- <li><div class="src-line"><a name="a428"></a> <span class="src-comm">// If the input type is unrecognised, it simply returns it back out unchanged</span></div></li>
- <li><div class="src-line"><a name="a429"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a430"></a><span class="src-doc"> * Rounds the specified 3d vector integer values.</span></div></li>
- <li><div class="src-line"><a name="a431"></a><span class="src-doc"> * Can handle/return a string vector, or an array vector.</span></div></li>
- <li><div class="src-line"><a name="a432"></a><span class="src-doc"> * (Output type matches input type).</span></div></li>
- <li><div class="src-line"><a name="a433"></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">$pos </span><span class="src-doc">Either a string vector or an array vector</span></div></li>
- <li><div class="src-line"><a name="a434"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span></div></li>
- <li><div class="src-line"><a name="a435"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a436"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_round_vector">sloodle_round_vector</a><span class="src-sym">(</span><span class="src-var">$pos</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a437"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a438"></a> <span class="src-comm">// We will work with an array, but allow for conversion to/from string</span></div></li>
- <li><div class="src-line"><a name="a439"></a> <span class="src-var">$arrayvec </span>= <span class="src-var">$pos</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a440"></a> <span class="src-var">$returnstring </span>= <span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a441"></a> <span class="src-comm">// Is it a string?</span></div></li>
- <li><div class="src-line"><a name="a442"></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">$pos</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a443"></a> <span class="src-var">$arrayvec </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array</a><span class="src-sym">(</span><span class="src-var">$pos</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-var">$returnstring </span>= <span class="src-id">TRUE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a445"></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-sym">!</span><a href="http://www.php.net/is_array">is_array</a><span class="src-sym">(</span><span class="src-var">$pos</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-key">return </span><span class="src-var">$pos</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a447"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a448"></a> </div></li>
- <li><div class="src-line"><a name="a449"></a> <span class="src-comm">// Construct an output array</span></div></li>
- <li><div class="src-line"><a name="a450"></a> <span class="src-var">$output </span>= <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="a451"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$arrayvec </span><span class="src-key">as </span><span class="src-var">$key </span>=> <span class="src-var">$val</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">$output</span><span class="src-sym">[</span><span class="src-var">$key</span><span class="src-sym">] </span>= <a href="http://www.php.net/round">round</a><span class="src-sym">(</span><span class="src-var">$val</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="a453"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a454"></a> </div></li>
- <li><div class="src-line"><a name="a455"></a> <span class="src-comm">// If we need to convert it back to a string, then do so</span></div></li>
- <li><div class="src-line"><a name="a456"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$returnstring</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a457"></a> <span class="src-key">return </span><a href="../sloodle/_lib---general.php.html#functionsloodle_array_to_vector">sloodle_array_to_vector</a><span class="src-sym">(</span><span class="src-var">$output</span><span class="src-sym">)</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> </div></li>
- <li><div class="src-line"><a name="a460"></a> <span class="src-key">return </span><span class="src-var">$output</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a461"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a462"></a> </div></li>
- <li><div class="src-line"><a name="a463"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a464"></a><span class="src-doc"> * Calculates the maximum and minimum bounds of the specified LoginZone</span></div></li>
- <li><div class="src-line"><a name="a465"></a><span class="src-doc"> * Returns the bounds as a numeric array of two associate array vectors: ($max, $min).</span></div></li>
- <li><div class="src-line"><a name="a466"></a><span class="src-doc"> * (Or returns false if no LoginZone position/size could be found in the Moodle configuration table).</span></div></li>
- <li><div class="src-line"><a name="a467"></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">$pos </span><span class="src-doc">A string vector giving the position of the LoginZone</span></div></li>
- <li><div class="src-line"><a name="a468"></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">$size </span><span class="src-doc">A string vector giving the size of the LoginZone</span></div></li>
- <li><div class="src-line"><a name="a469"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span></div></li>
- <li><div class="src-line"><a name="a470"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a471"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_login_zone_bounds">sloodle_login_zone_bounds</a><span class="src-sym">(</span><span class="src-var">$pos</span><span class="src-sym">, </span><span class="src-var">$size</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a472"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a473"></a> <span class="src-comm">// Make sure the parameters are valid types</span></div></li>
- <li><div class="src-line"><a name="a474"></a> <span class="src-key">if </span><span class="src-sym">((</span><span class="src-var">$pos </span>== <span class="src-id">FALSE</span><span class="src-sym">) </span>|| <span class="src-sym">(</span><span class="src-var">$size </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="a475"></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="a476"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a477"></a> <span class="src-comm">// Convert both to arrays</span></div></li>
- <li><div class="src-line"><a name="a478"></a> <span class="src-var">$posarr </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array</a><span class="src-sym">(</span><span class="src-var">$pos</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a479"></a> <span class="src-var">$sizearr </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array</a><span class="src-sym">(</span><span class="src-var">$size</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a480"></a> <span class="src-comm">// Calculate the bounds</span></div></li>
- <li><div class="src-line"><a name="a481"></a> <span class="src-var">$max </span>= <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="a482"></a> <span class="src-var">$max</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">] </span>= <span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">]</span>+<span class="src-sym">((</span><span class="src-var">$sizearr</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">]</span><span class="src-sym">)</span>/<span class="src-num">2</span><span class="src-sym">)</span>-<span class="src-num">2</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a483"></a> <span class="src-var">$max</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">] </span>= <span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">]</span>+<span class="src-sym">((</span><span class="src-var">$sizearr</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">]</span><span class="src-sym">)</span>/<span class="src-num">2</span><span class="src-sym">)</span>-<span class="src-num">2</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a484"></a> <span class="src-var">$max</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">] </span>= <span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">]</span>+<span class="src-sym">((</span><span class="src-var">$sizearr</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">]</span><span class="src-sym">)</span>/<span class="src-num">2</span><span class="src-sym">)</span>-<span class="src-num">2</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a485"></a> <span class="src-var">$min </span>= <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="a486"></a> <span class="src-var">$min</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">] </span>= <span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">]</span>-<span class="src-sym">((</span><span class="src-var">$sizearr</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">]</span><span class="src-sym">)</span>/<span class="src-num">2</span><span class="src-sym">)</span>+<span class="src-num">2</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a487"></a> <span class="src-var">$min</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">] </span>= <span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">]</span>-<span class="src-sym">((</span><span class="src-var">$sizearr</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">]</span><span class="src-sym">)</span>/<span class="src-num">2</span><span class="src-sym">)</span>+<span class="src-num">2</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a488"></a> <span class="src-var">$min</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">] </span>= <span class="src-var">$posarr</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">]</span>-<span class="src-sym">((</span><span class="src-var">$sizearr</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">]</span><span class="src-sym">)</span>/<span class="src-num">2</span><span class="src-sym">)</span>+<span class="src-num">2</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a489"></a> </div></li>
- <li><div class="src-line"><a name="a490"></a> <span class="src-key">return </span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-var">$max</span><span class="src-sym">,</span><span class="src-var">$min</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-sym">}</span></div></li>
- <li><div class="src-line"><a name="a492"></a> </div></li>
- <li><div class="src-line"><a name="a493"></a> </div></li>
- <li><div class="src-line"><a name="a494"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a495"></a><span class="src-doc"> * Checks if the given prim password is valid.</span></div></li>
- <li><div class="src-line"><a name="a496"></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">$password </span><span class="src-doc">The password string to check</span></div></li>
- <li><div class="src-line"><a name="a497"></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 it is valid, or false otherwise.</span></div></li>
- <li><div class="src-line"><a name="a498"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a499"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_validate_prim_password">sloodle_validate_prim_password</a><span class="src-sym">(</span><span class="src-var">$password</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a500"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a501"></a> <span class="src-comm">// Check that it's a string</span></div></li>
- <li><div class="src-line"><a name="a502"></a> <span class="src-key">if </span><span class="src-sym">(</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">$password</span><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="a503"></a> <span class="src-comm">// Check the length</span></div></li>
- <li><div class="src-line"><a name="a504"></a> <span class="src-var">$len </span>= <a href="http://www.php.net/strlen">strlen</a><span class="src-sym">(</span><span class="src-var">$password</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a505"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$len </span>< <span class="src-num">5 </span>|| <span class="src-var">$len </span>> <span class="src-num">9</span><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="a506"></a> <span class="src-comm">// Check that it's all numbers</span></div></li>
- <li><div class="src-line"><a name="a507"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/ctype_digit">ctype_digit</a><span class="src-sym">(</span><span class="src-var">$password</span><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="a508"></a> <span class="src-comm">// Check that it doesn't start with a 0</span></div></li>
- <li><div class="src-line"><a name="a509"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$password</span><span class="src-sym">[</span><span class="src-num">0</span><span class="src-sym">] </span>== <span class="src-str">'0'</span><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="a510"></a> </div></li>
- <li><div class="src-line"><a name="a511"></a> <span class="src-comm">// It all seems fine</span></div></li>
- <li><div class="src-line"><a name="a512"></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="a513"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a514"></a> </div></li>
- <li><div class="src-line"><a name="a515"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a516"></a><span class="src-doc"> * Checks if the given prim password is valid, and provides feedback.</span></div></li>
- <li><div class="src-line"><a name="a517"></a><span class="src-doc"> * An array is written to by reference, each element containing error codes.</span></div></li>
- <li><div class="src-line"><a name="a518"></a><span class="src-doc"> * Each error code is a word. The full text of the error message may be obtained</span></div></li>
- <li><div class="src-line"><a name="a519"></a><span class="src-doc"> * from the string file by looking for "primpass:errorcode".</span></div></li>
- <li><div class="src-line"><a name="a520"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a521"></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">$password </span><span class="src-doc">The password to validate</span></div></li>
- <li><div class="src-line"><a name="a522"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">&$errors </span><span class="src-doc">An array (passed by reference) which will contain any error messages</span></div></li>
- <li><div class="src-line"><a name="a523"></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 prim password is valid, or false otherwise</span></div></li>
- <li><div class="src-line"><a name="a524"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a525"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_validate_prim_password_verbose">sloodle_validate_prim_password_verbose</a><span class="src-sym">(</span><span class="src-var">$password</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$errors</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> <span class="src-comm">// Initialise variables</span></div></li>
- <li><div class="src-line"><a name="a528"></a> <span class="src-var">$errors </span>= <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="a529"></a> <span class="src-var">$result </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a530"></a> </div></li>
- <li><div class="src-line"><a name="a531"></a> <span class="src-comm">// Check that it's a string</span></div></li>
- <li><div class="src-line"><a name="a532"></a> <span class="src-key">if </span><span class="src-sym">(</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">$password</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a533"></a> <span class="src-var">$errors</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-str">'invalidtype'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a534"></a> <span class="src-var">$result </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a535"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a536"></a> <span class="src-comm">// Check the length</span></div></li>
- <li><div class="src-line"><a name="a537"></a> <span class="src-var">$len </span>= <a href="http://www.php.net/strlen">strlen</a><span class="src-sym">(</span><span class="src-var">$password</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a538"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$len </span>< <span class="src-num">5</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a539"></a> <span class="src-var">$errors</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-str">'tooshort'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a540"></a> <span class="src-var">$result </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a541"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a542"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$len </span>> <span class="src-num">9</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a543"></a> <span class="src-var">$errors</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-str">'toolong'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a544"></a> <span class="src-var">$result </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a545"></a> <span class="src-sym">}</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">// Check that it's all numbers</span></div></li>
- <li><div class="src-line"><a name="a548"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/ctype_digit">ctype_digit</a><span class="src-sym">(</span><span class="src-var">$password</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a549"></a> <span class="src-var">$errors</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-str">'numonly'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a550"></a> <span class="src-var">$result </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a551"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a552"></a> </div></li>
- <li><div class="src-line"><a name="a553"></a> <span class="src-comm">// Check that it doesn't start with a 0</span></div></li>
- <li><div class="src-line"><a name="a554"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$password</span><span class="src-sym">[</span><span class="src-num">0</span><span class="src-sym">] </span>== <span class="src-str">'0'</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a555"></a> <span class="src-var">$errors</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-str">'leadingzero'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a556"></a> <span class="src-var">$result </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a557"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a558"></a> </div></li>
- <li><div class="src-line"><a name="a559"></a> <span class="src-key">return </span><span class="src-var">$result</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a560"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a561"></a> </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-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a564"></a><span class="src-doc"> * Stores a pending login notification for an auto-registered user.</span></div></li>
- <li><div class="src-line"><a name="a565"></a><span class="src-doc"> * A cron job will process the pending notification queue.</span></div></li>
- <li><div class="src-line"><a name="a566"></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">$destination </span><span class="src-doc">Identifies the destination of the notification (for SL, this will be the object UUID. The send function will construct the email address)</span></div></li>
- <li><div class="src-line"><a name="a567"></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">$avatar </span><span class="src-doc">Identifier for the avatar being notified</span></div></li>
- <li><div class="src-line"><a name="a568"></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">$username </span><span class="src-doc">The username to notify the user of</span></div></li>
- <li><div class="src-line"><a name="a569"></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">$password </span><span class="src-doc">The (plaintext) password to notify the user of</span></div></li>
- <li><div class="src-line"><a name="a570"></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="a571"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a572"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_login_notification">sloodle_login_notification</a><span class="src-sym">(</span><span class="src-var">$destination</span><span class="src-sym">, </span><span class="src-var">$avatar</span><span class="src-sym">, </span><span class="src-var">$username</span><span class="src-sym">, </span><span class="src-var">$password</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> <span class="src-comm">// If another pending notification already exists for the same username, then delete it</span></div></li>
- <li><div class="src-line"><a name="a575"></a> <span class="src-id">delete_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_login_notifications'</span><span class="src-sym">, </span><span class="src-str">'username'</span><span class="src-sym">, </span><span class="src-var">$username</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a576"></a> </div></li>
- <li><div class="src-line"><a name="a577"></a> <span class="src-comm">// Add the new details</span></div></li>
- <li><div class="src-line"><a name="a578"></a> <span class="src-var">$notification </span>= <span class="src-key">new </span><span class="src-id">stdClass</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="a579"></a> <span class="src-var">$notification</span><span class="src-sym">-></span><span class="src-id">destination </span>= <span class="src-var">$destination</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a580"></a> <span class="src-var">$notification</span><span class="src-sym">-></span><span class="src-id">avatar </span>= <span class="src-var">$avatar</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a581"></a> <span class="src-var">$notification</span><span class="src-sym">-></span><span class="src-id">username </span>= <span class="src-var">$username</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a582"></a> <span class="src-var">$notification</span><span class="src-sym">-></span><span class="src-id">password </span>= <span class="src-var">$password</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a583"></a> </div></li>
- <li><div class="src-line"><a name="a584"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-id">insert_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_login_notifications'</span><span class="src-sym">, </span><span class="src-var">$notification</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a585"></a> echo <span class="src-str">"failed\n"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a586"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a587"></a> echo <span class="src-str">"succeeded\n"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a588"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a589"></a> </div></li>
- <li><div class="src-line"><a name="a590"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a591"></a><span class="src-doc"> * Send a login notification.</span></div></li>
- <li><div class="src-line"><a name="a592"></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">$destination </span><span class="src-doc">Identifies the destination of the notification (for SL, this will be the object UUID. The target email address will be constructed)</span></div></li>
- <li><div class="src-line"><a name="a593"></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">$avatar </span><span class="src-doc">Identifier for the avatar being notified</span></div></li>
- <li><div class="src-line"><a name="a594"></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">$username </span><span class="src-doc">The username to notify the user of</span></div></li>
- <li><div class="src-line"><a name="a595"></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">$password </span><span class="src-doc">The (plaintext) password to notify the user of</span></div></li>
- <li><div class="src-line"><a name="a596"></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="a597"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a598"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_send_login_notification">sloodle_send_login_notification</a><span class="src-sym">(</span><span class="src-var">$destination</span><span class="src-sym">, </span><span class="src-var">$avatar</span><span class="src-sym">, </span><span class="src-var">$username</span><span class="src-sym">, </span><span class="src-var">$password</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-key">global </span><span class="src-var">$CFG</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a601"></a> <span class="src-key">return </span><a href="../sloodle/_lib---mail.php.html#functionsloodle_text_email_sl">sloodle_text_email_sl</a><span class="src-sym">(</span><span class="src-var">$destination</span><span class="src-sym">, </span><span class="src-str">'SLOODLE_LOGIN'</span><span class="src-sym">, </span><span class="src-str">"</span><span class="src-str"><span class="src-var">$avatar</span>|{<span class="src-var">$CFG</span></span><span class="src-sym">-></span><span class="src-id">wwwroot</span><span class="src-str"></span><span class="src-sym">}</span>|<span class="src-var">$username</span>|<span class="src-var">$password</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="a602"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a603"></a> </div></li>
- <li><div class="src-line"><a name="a604"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a605"></a><span class="src-doc"> * Processes pending login notifications, up to a certain limit.</span></div></li>
- <li><div class="src-line"><a name="a606"></a><span class="src-doc"> * Retrieves the requests one-at-a-time for processing.</span></div></li>
- <li><div class="src-line"><a name="a607"></a><span class="src-doc"> * This is slower, but ensures minimal damage if the process is terminated, e.g. due to server timeout.</span></div></li>
- <li><div class="src-line"><a name="a608"></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">$limit </span><span class="src-doc">The maximum number of pending requests to process.</span></div></li>
- <li><div class="src-line"><a name="a609"></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="a610"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a611"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_process_login_notifications">sloodle_process_login_notifications</a><span class="src-sym">(</span><span class="src-var">$limit </span>= <span class="src-num">25</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a612"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a613"></a> <span class="src-key">global </span><span class="src-var">$CFG</span><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">// Validate the limit</span></div></li>
- <li><div class="src-line"><a name="a616"></a> <span class="src-var">$limit </span>= (int)<span class="src-var">$limit</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a617"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$limit </span>< <span class="src-num">1</span><span class="src-sym">) </span><span class="src-key">return</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a618"></a> </div></li>
- <li><div class="src-line"><a name="a619"></a> <span class="src-comm">// Go through each one</span></div></li>
- <li><div class="src-line"><a name="a620"></a> <span class="src-key">for </span><span class="src-sym">(</span><span class="src-var">$i </span>= <span class="src-num">0</span><span class="src-sym">; </span><span class="src-var">$i </span>< <span class="src-var">$limit</span><span class="src-sym">; </span><span class="src-var">$i</span>++<span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a621"></a> <span class="src-comm">// Obtain the first record</span></div></li>
- <li><div class="src-line"><a name="a622"></a> <span class="src-var">$recs </span>= <span class="src-id">get_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_login_notifications'</span><span class="src-sym">, </span><span class="src-str">''</span><span class="src-sym">, </span><span class="src-str">''</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span><span class="src-str">'*'</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">, </span><span class="src-var">$limit</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a623"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$recs</span><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="a624"></a> <a href="http://www.php.net/reset">reset</a><span class="src-sym">(</span><span class="src-var">$recs</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a625"></a> <span class="src-var">$rec </span>= <a href="http://www.php.net/current">current</a><span class="src-sym">(</span><span class="src-var">$recs</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a626"></a> </div></li>
- <li><div class="src-line"><a name="a627"></a> <span class="src-comm">// Determine the user ID of the person who requested this</span></div></li>
- <li><div class="src-line"><a name="a628"></a> <span class="src-var">$userid </span>= <span class="src-num">0</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a629"></a> <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">$sloodleuser </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_users'</span><span class="src-sym">, </span><span class="src-str">'uuid'</span><span class="src-sym">, </span><span class="src-var">$rec</span><span class="src-sym">-></span><span class="src-id">avatar</span><span class="src-sym">))) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a630"></a> <span class="src-comm">// Failed to the user - get the guest user instead</span></div></li>
- <li><div class="src-line"><a name="a631"></a> <span class="src-var">$guestdata </span>= <span class="src-id">guest_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="a632"></a> <span class="src-var">$userid </span>= <span class="src-var">$guestdata</span><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a633"></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="a634"></a> <span class="src-comm">// Got the data - store the user ID</span></div></li>
- <li><div class="src-line"><a name="a635"></a> <span class="src-var">$userid </span>= <span class="src-var">$sloodleuser</span><span class="src-sym">-></span><span class="src-id">userid</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a636"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a637"></a> </div></li>
- <li><div class="src-line"><a name="a638"></a> <span class="src-comm">// Send the notification</span></div></li>
- <li><div class="src-line"><a name="a639"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="../sloodle/_lib---general.php.html#functionsloodle_send_login_notification">sloodle_send_login_notification</a><span class="src-sym">(</span><span class="src-var">$rec</span><span class="src-sym">-></span><span class="src-id">destination</span><span class="src-sym">, </span><span class="src-var">$rec</span><span class="src-sym">-></span><span class="src-id">avatar</span><span class="src-sym">, </span><span class="src-var">$rec</span><span class="src-sym">-></span><span class="src-id">username</span><span class="src-sym">, </span><span class="src-var">$rec</span><span class="src-sym">-></span><span class="src-id">password</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a640"></a> <span class="src-comm">// Log the notification</span></div></li>
- <li><div class="src-line"><a name="a641"></a> <span class="src-id">add_to_log</span><span class="src-sym">(</span><span class="src-id">SITEID</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">, </span><span class="src-str">'view'</span><span class="src-sym">, </span><span class="src-str">''</span><span class="src-sym">, </span><span class="src-str">'Sent login details by email to avatar in-world'</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">, </span><span class="src-var">$userid</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a642"></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="a643"></a> <span class="src-comm">// Log the failed notification (but don't keep trying the same one)</span></div></li>
- <li><div class="src-line"><a name="a644"></a> <span class="src-id">add_to_log</span><span class="src-sym">(</span><span class="src-id">SITEID</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">, </span><span class="src-str">'view failed'</span><span class="src-sym">, </span><span class="src-str">''</span><span class="src-sym">, </span><span class="src-str">'Failed to send login details by email to avatar in-world'</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">, </span><span class="src-var">$userid</span><span class="src-sym">)</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> </div></li>
- <li><div class="src-line"><a name="a647"></a> <span class="src-comm">// Delete the record from the data</span></div></li>
- <li><div class="src-line"><a name="a648"></a> <span class="src-id">delete_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_login_notifications'</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span><span class="src-var">$rec</span><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a649"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a650"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a651"></a> </div></li>
- <li><div class="src-line"><a name="a652"></a> </div></li>
- <li><div class="src-line"><a name="a653"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a654"></a><span class="src-doc"> * Extracts a value from a name-value associative array if it is set.</span></div></li>
- <li><div class="src-line"><a name="a655"></a><span class="src-doc"> * (The array should associate name to value).</span></div></li>
- <li><div class="src-line"><a name="a656"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">$settings </span><span class="src-doc">The array of names and values</span></div></li>
- <li><div class="src-line"><a name="a657"></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">$name </span><span class="src-doc">The name of the value to retrieve</span></div></li>
- <li><div class="src-line"><a name="a658"></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">$default </span><span class="src-doc">The default value to return if the specified value was not found</span></div></li>
- <li><div class="src-line"><a name="a659"></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 value from the input array, or the $default parameter</span></div></li>
- <li><div class="src-line"><a name="a660"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a661"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_get_value">sloodle_get_value</a><span class="src-sym">(</span><span class="src-var">$settings</span><span class="src-sym">, </span><span class="src-var">$name</span><span class="src-sym">, </span><span class="src-var">$default </span>= <span class="src-id">null</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a662"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a663"></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">$settings</span><span class="src-sym">) </span>&& isset<span class="src-sym">(</span><span class="src-var">$settings</span><span class="src-sym">[</span><span class="src-var">$name</span><span class="src-sym">]</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-var">$settings</span><span class="src-sym">[</span><span class="src-var">$name</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a664"></a> <span class="src-key">return </span><span class="src-var">$default</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a665"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a666"></a> </div></li>
- <li><div class="src-line"><a name="a667"></a> </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-doc"> * Outputs the standard form elements for access levels in object configuration.</span></div></li>
- <li><div class="src-line"><a name="a670"></a><span class="src-doc"> * Each part can be optionally hidden, and default values can be provided.</span></div></li>
- <li><div class="src-line"><a name="a671"></a><span class="src-doc"> * (Note: the server access level must be communicated from the object back to Moodle... rubbish implementation, but it works!)</span></div></li>
- <li><div class="src-line"><a name="a672"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">$current_config </span><span class="src-doc">An associative array of setting names to values, containing defaults. (Ignored if null).</span></div></li>
- <li><div class="src-line"><a name="a673"></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">$show_use_object </span><span class="src-doc">Determines whether or not the "Use Object" setting is shown</span></div></li>
- <li><div class="src-line"><a name="a674"></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">$show_control_object </span><span class="src-doc">Determines whether or not the "Control Object" setting is shown</span></div></li>
- <li><div class="src-line"><a name="a675"></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">$show_server </span><span class="src-doc">Determines whether or not the server access setting is shown</span></div></li>
- <li><div class="src-line"><a name="a676"></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="a677"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a678"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_print_access_level_options">sloodle_print_access_level_options</a><span class="src-sym">(</span><span class="src-var">$current_config</span><span class="src-sym">, </span><span class="src-var">$show_use_object </span>= <span class="src-id">true</span><span class="src-sym">, </span><span class="src-var">$show_control_object </span>= <span class="src-id">true</span><span class="src-sym">, </span><span class="src-var">$show_server </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a679"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a680"></a> <span class="src-comm">// Quick-escape: if everything is being suppressed, then do nothing</span></div></li>
- <li><div class="src-line"><a name="a681"></a> <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">$show_use_object </span>|| <span class="src-var">$show_control_object </span>|| <span class="src-var">$show_server</span><span class="src-sym">)) </span><span class="src-key">return</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a682"></a> </div></li>
- <li><div class="src-line"><a name="a683"></a> <span class="src-comm">// Fetch default values from the configuration, if possible</span></div></li>
- <li><div class="src-line"><a name="a684"></a> <span class="src-var">$sloodleobjectaccessleveluse </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_get_value">sloodle_get_value</a><span class="src-sym">(</span><span class="src-var">$current_config</span><span class="src-sym">, </span><span class="src-str">'sloodleobjectaccessleveluse'</span><span class="src-sym">, </span><span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC">SLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC</a></span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a685"></a> <span class="src-var">$sloodleobjectaccesslevelctrl </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_get_value">sloodle_get_value</a><span class="src-sym">(</span><span class="src-var">$current_config</span><span class="src-sym">, </span><span class="src-str">'sloodleobjectaccesslevelctrl'</span><span class="src-sym">, </span><span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_OBJECT_ACCESS_LEVEL_OWNER">SLOODLE_OBJECT_ACCESS_LEVEL_OWNER</a></span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a686"></a> <span class="src-var">$sloodleserveraccesslevel </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_get_value">sloodle_get_value</a><span class="src-sym">(</span><span class="src-var">$current_config</span><span class="src-sym">, </span><span class="src-str">'sloodleserveraccesslevel'</span><span class="src-sym">, </span><span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_SERVER_ACCESS_LEVEL_PUBLIC">SLOODLE_SERVER_ACCESS_LEVEL_PUBLIC</a></span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a687"></a> </div></li>
- <li><div class="src-line"><a name="a688"></a> <span class="src-comm">// Define our object access level array</span></div></li>
- <li><div class="src-line"><a name="a689"></a> <span class="src-var">$object_access_levels </span>= <span class="src-key">array</span><span class="src-sym">( </span><span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC">SLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC</a> </span>=> <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevel:public'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a690"></a> <span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_OBJECT_ACCESS_LEVEL_GROUP">SLOODLE_OBJECT_ACCESS_LEVEL_GROUP</a> </span>=> <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevel:group'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a691"></a> <span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_OBJECT_ACCESS_LEVEL_OWNER">SLOODLE_OBJECT_ACCESS_LEVEL_OWNER</a> </span>=> <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevel:owner'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">) )</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a692"></a> <span class="src-comm">// Define our server access level array</span></div></li>
- <li><div class="src-line"><a name="a693"></a> <span class="src-var">$server_access_levels </span>= <span class="src-key">array</span><span class="src-sym">( </span><span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_SERVER_ACCESS_LEVEL_PUBLIC">SLOODLE_SERVER_ACCESS_LEVEL_PUBLIC</a> </span>=> <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevel:public'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a694"></a> <span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_SERVER_ACCESS_LEVEL_COURSE">SLOODLE_SERVER_ACCESS_LEVEL_COURSE</a> </span>=> <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevel:course'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a695"></a> <span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_SERVER_ACCESS_LEVEL_SITE">SLOODLE_SERVER_ACCESS_LEVEL_SITE</a> </span>=> <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevel:site'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">,</span></div></li>
- <li><div class="src-line"><a name="a696"></a> <span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_SERVER_ACCESS_LEVEL_STAFF">SLOODLE_SERVER_ACCESS_LEVEL_STAFF</a> </span>=> <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevel:staff'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">) )</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a697"></a> </div></li>
- <li><div class="src-line"><a name="a698"></a> <span class="src-comm">// Display box and a heading</span></div></li>
- <li><div class="src-line"><a name="a699"></a> <span class="src-id">print_box_start</span><span class="src-sym">(</span><span class="src-str">'generalbox boxaligncenter'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a700"></a> echo <span class="src-str">'<h3>'</span>.<span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevel'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">)</span>.<span class="src-str">'</h3>'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a701"></a> </div></li>
- <li><div class="src-line"><a name="a702"></a> <span class="src-comm">// Print the object settings</span></div></li>
- <li><div class="src-line"><a name="a703"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$show_use_object </span>|| <span class="src-var">$show_control_object</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a704"></a> </div></li>
- <li><div class="src-line"><a name="a705"></a> <span class="src-comm">// Object access</span></div></li>
- <li><div class="src-line"><a name="a706"></a> echo <span class="src-str">'<b>'</span>.<span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevelobject'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">)</span>.<span class="src-str">'</b><br><i>'</span>.<span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevelobject:desc'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">)</span>.<span class="src-str">'</i><br><br>'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a707"></a> <span class="src-comm">// Use object</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">$show_use_object</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a709"></a> echo <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevelobject:use'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">)</span>.<span class="src-str">': '</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a710"></a> <span class="src-id">choose_from_menu</span><span class="src-sym">(</span><span class="src-var">$object_access_levels</span><span class="src-sym">, </span><span class="src-str">'sloodleobjectaccessleveluse'</span><span class="src-sym">, </span><span class="src-var">$sloodleobjectaccessleveluse</span><span class="src-sym">, </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="a711"></a> echo <span class="src-str">'<br><br>'</span><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> <span class="src-comm">// Control object</span></div></li>
- <li><div class="src-line"><a name="a714"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$show_control_object</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a715"></a> echo <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevelobject:control'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">)</span>.<span class="src-str">': '</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a716"></a> <span class="src-id">choose_from_menu</span><span class="src-sym">(</span><span class="src-var">$object_access_levels</span><span class="src-sym">, </span><span class="src-str">'sloodleobjectaccesslevelctrl'</span><span class="src-sym">, </span><span class="src-var">$sloodleobjectaccesslevelctrl</span><span class="src-sym">, </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="a717"></a> echo <span class="src-str">'<br><br>'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a718"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a719"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a720"></a> </div></li>
- <li><div class="src-line"><a name="a721"></a> <span class="src-comm">// Print the server settings</span></div></li>
- <li><div class="src-line"><a name="a722"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$show_server</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a723"></a> <span class="src-comm">// Server access</span></div></li>
- <li><div class="src-line"><a name="a724"></a> echo <span class="src-str">'<b>'</span>.<span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevelserver'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">)</span>.<span class="src-str">'</b><br><i>'</span>.<span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevelserver:desc'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">)</span>.<span class="src-str">'</i><br><br>'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a725"></a> echo <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'accesslevel'</span><span class="src-sym">,</span><span class="src-str">'sloodle'</span><span class="src-sym">)</span>.<span class="src-str">': '</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a726"></a> <span class="src-id">choose_from_menu</span><span class="src-sym">(</span><span class="src-var">$server_access_levels</span><span class="src-sym">, </span><span class="src-str">'sloodleserveraccesslevel'</span><span class="src-sym">, </span><span class="src-var">$sloodleserveraccesslevel</span><span class="src-sym">, </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="a727"></a> echo <span class="src-str">'<br>'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a728"></a> <span class="src-sym">} </span></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-id">print_box_end</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="a731"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a732"></a> </div></li>
- <li><div class="src-line"><a name="a733"></a> </div></li>
- <li><div class="src-line"><a name="a734"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a735"></a><span class="src-doc"> * Returns a very approximate natural language description of a period of time (in minutes, hours, days, or weeks).</span></div></li>
- <li><div class="src-line"><a name="a736"></a><span class="src-doc"> * Can also be used to describe how long ago something happened, in which case anything less than 1 minute is treated as 'now'.</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">int </span><span class="src-doc-var">$secs </span><span class="src-doc">Number of seconds in period of time</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">bool </span><span class="src-doc-var">$ago </span><span class="src-doc">If true (not default), then the time will be described in past tense, e.g. "3 days ago", as opposed to simply "3 days".</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">string </span></div></li>
- <li><div class="src-line"><a name="a740"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a741"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_describe_approx_time">sloodle_describe_approx_time</a><span class="src-sym">(</span><span class="src-var">$secs</span><span class="src-sym">, </span><span class="src-var">$ago </span>= <span class="src-id">false</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a742"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a743"></a> <span class="src-comm">// Make sure the time is a positive integer</span></div></li>
- <li><div class="src-line"><a name="a744"></a> <span class="src-var">$secs </span>= (int)<span class="src-var">$secs</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a745"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$secs </span>< <span class="src-num">0</span><span class="src-sym">) </span><span class="src-var">$secs </span>*= -<span class="src-num">1</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a746"></a> </div></li>
- <li><div class="src-line"><a name="a747"></a> <span class="src-comm">// Less than a minute</span></div></li>
- <li><div class="src-line"><a name="a748"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$secs </span>< <span class="src-num">60</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">// If we are describing a past time, then approximate to 'now'</span></div></li>
- <li><div class="src-line"><a name="a750"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$ago</span><span class="src-sym">) </span><span class="src-key">return </span><a href="http://www.php.net/ucwords">ucwords</a><span class="src-sym">(</span><span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'now'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</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-comm">// Give the number of seconds</span></div></li>
- <li><div class="src-line"><a name="a752"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$secs </span>== <span class="src-num">1</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-str">'1 '</span>. <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'second'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a753"></a> <span class="src-key">return </span><span class="src-var">$secs</span>.<span class="src-str">' '</span>. <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'seconds'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a754"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a755"></a> </div></li>
- <li><div class="src-line"><a name="a756"></a> <span class="src-comm">// This variable will hold the time description</span></div></li>
- <li><div class="src-line"><a name="a757"></a> <span class="src-var">$desc </span>= <span class="src-str">''</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a758"></a> </div></li>
- <li><div class="src-line"><a name="a759"></a> <span class="src-comm">// Roughly 1 minute</span></div></li>
- <li><div class="src-line"><a name="a760"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$secs </span>< <span class="src-num">120</span><span class="src-sym">) </span><span class="src-var">$desc </span>= <span class="src-str">'1 '</span>. <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'minute'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a761"></a> <span class="src-comm">// Several minutes (up to 1 hour)</span></div></li>
- <li><div class="src-line"><a name="a762"></a> <span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$secs </span>< <span class="src-num">3600</span><span class="src-sym">) </span><span class="src-var">$desc </span>= <span class="src-sym">(</span>(string)(int)<span class="src-sym">(</span><span class="src-var">$secs </span>/ <span class="src-num">60</span><span class="src-sym">))</span>.<span class="src-str">' '</span>. <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'minutes'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a763"></a> <span class="src-comm">// Roughly 1 hour</span></div></li>
- <li><div class="src-line"><a name="a764"></a> <span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$secs </span>< <span class="src-num">7200</span><span class="src-sym">) </span><span class="src-var">$desc </span>= <span class="src-str">'1 '</span>. <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'hour'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a765"></a> <span class="src-comm">// Several hours (up to 1 day)</span></div></li>
- <li><div class="src-line"><a name="a766"></a> <span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$secs </span>< <span class="src-num">86400</span><span class="src-sym">) </span><span class="src-var">$desc </span>= <span class="src-sym">(</span>(string)(int)<span class="src-sym">(</span><span class="src-var">$secs </span>/ <span class="src-num">3600</span><span class="src-sym">))</span>.<span class="src-str">' '</span>. <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'hours'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a767"></a> <span class="src-comm">// Roughly 1 day</span></div></li>
- <li><div class="src-line"><a name="a768"></a> <span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$secs </span>< <span class="src-num">172800</span><span class="src-sym">) </span><span class="src-var">$desc </span>= <span class="src-str">'1 '</span>. <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'day'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a769"></a> <span class="src-comm">// Several days (up to 1 week)</span></div></li>
- <li><div class="src-line"><a name="a770"></a> <span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$secs </span>< <span class="src-num">604800</span><span class="src-sym">) </span><span class="src-var">$desc </span>= <span class="src-sym">(</span>(string)(int)<span class="src-sym">(</span><span class="src-var">$secs </span>/ <span class="src-num">86400</span><span class="src-sym">))</span>.<span class="src-str">' '</span>. <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'days'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a771"></a> <span class="src-comm">// Roughly 1 week</span></div></li>
- <li><div class="src-line"><a name="a772"></a> <span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$secs </span>< <span class="src-num">1209600</span><span class="src-sym">) </span><span class="src-var">$desc </span>= <span class="src-str">'1 '</span>. <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'week'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a773"></a> <span class="src-comm">// Several weeks (up to 2 months)</span></div></li>
- <li><div class="src-line"><a name="a774"></a> <span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$secs </span>< <span class="src-num">5184000</span><span class="src-sym">) </span><span class="src-var">$desc </span>= <span class="src-sym">(</span>(string)(int)<span class="src-sym">(</span><span class="src-var">$secs </span>/ <span class="src-num">604800</span><span class="src-sym">))</span>.<span class="src-str">' '</span>. <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'weeks'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a775"></a> <span class="src-comm">// Several months (up to 11 months)</span></div></li>
- <li><div class="src-line"><a name="a776"></a> <span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$secs </span>< <span class="src-num">29462400</span><span class="src-sym">) </span><span class="src-var">$desc </span>= <span class="src-sym">(</span>(string)(int)<span class="src-sym">(</span><span class="src-var">$secs </span>/ <span class="src-num">2592000</span><span class="src-sym">))</span>.<span class="src-str">' '</span>. <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'months'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a777"></a> <span class="src-comm">// 1 year</span></div></li>
- <li><div class="src-line"><a name="a778"></a> <span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$secs </span>< <span class="src-num">63072000</span><span class="src-sym">) </span><span class="src-var">$desc </span>= <span class="src-str">'1 '</span>. <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'year'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a779"></a> <span class="src-comm">// Several years</span></div></li>
- <li><div class="src-line"><a name="a780"></a> <span class="src-key">else </span><span class="src-var">$desc </span>= <span class="src-sym">(</span>(string)(int)<span class="src-sym">(</span><span class="src-var">$secs </span>/ <span class="src-num">31536000</span><span class="src-sym">))</span>.<span class="src-str">' '</span>. <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'years'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</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-comm">// Add 'ago' if necessary</span></div></li>
- <li><div class="src-line"><a name="a783"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$ago</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'timeago'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">, </span><span class="src-var">$desc</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a784"></a> <span class="src-key">return </span><span class="src-var">$desc</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a785"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a786"></a> </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-doc"> * Gets the basic URL of the current web-page being accessed.</span></div></li>
- <li><div class="src-line"><a name="a789"></a><span class="src-doc"> * Includes the protocol, hostname, and script path/name.</span></div></li>
- <li><div class="src-line"><a name="a790"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
- <li><div class="src-line"><a name="a791"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a792"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_get_web_path">sloodle_get_web_path</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a793"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a794"></a> <span class="src-comm">// Check for the protocol</span></div></li>
- <li><div class="src-line"><a name="a795"></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">$_SERVER</span><span class="src-sym">[</span><span class="src-str">'HTTPS'</span><span class="src-sym">]</span><span class="src-sym">) </span>|| <span class="src-var">$_SERVER</span><span class="src-sym">[</span><span class="src-str">'HTTPS'</span><span class="src-sym">] </span>== <span class="src-str">'off'</span><span class="src-sym">) </span><span class="src-var">$protocol </span>= <span class="src-str">"http"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a796"></a> <span class="src-key">else </span><span class="src-var">$protocol </span>= <span class="src-str">"https"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a797"></a> <span class="src-comm">// Get the host name (e.g. domain)</span></div></li>
- <li><div class="src-line"><a name="a798"></a> <span class="src-var">$host </span>= <span class="src-var">$_SERVER</span><span class="src-sym">[</span><span class="src-str">'SERVER_NAME'</span><span class="src-sym">]</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a799"></a> <span class="src-comm">// Finally, get the script path/name</span></div></li>
- <li><div class="src-line"><a name="a800"></a> <span class="src-var">$file </span>= <span class="src-var">$_SERVER</span><span class="src-sym">[</span><span class="src-str">'SCRIPT_NAME'</span><span class="src-sym">]</span><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-key">return </span><span class="src-var">$protocol</span>.<span class="src-str">'://'</span>.<span class="src-var">$host</span>.<span class="src-var">$file</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a803"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a804"></a> </div></li>
- <li><div class="src-line"><a name="a805"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a806"></a><span class="src-doc"> * Gets an array of subdirectories within the given directory.</span></div></li>
- <li><div class="src-line"><a name="a807"></a><span class="src-doc"> * Ignores anything which starts with a .</span></div></li>
- <li><div class="src-line"><a name="a808"></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">$dir </span><span class="src-doc">The directory to search WITHOUT a trailing slash. (Note: cannot search the current directory or higher in the file hierarchy)</span></div></li>
- <li><div class="src-line"><a name="a809"></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">$relative </span><span class="src-doc">If TRUE (default) the array of results will be relative to the input directory. Otherwise, they will include the input directory path.</span></div></li>
- <li><div class="src-line"><a name="a810"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array</span><span class="src-doc">|</span><span class="src-doc-type">false</span><span class="src-doc">A numeric array of subdirectory names sorted alphabetically, or false if an error occurred (such as the input value not being a directory)</span></div></li>
- <li><div class="src-line"><a name="a811"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a812"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_get_subdirectories">sloodle_get_subdirectories</a><span class="src-sym">(</span><span class="src-var">$dir</span><span class="src-sym">, </span><span class="src-var">$relative </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a813"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a814"></a> <span class="src-comm">// Make sure we have a valid directory</span></div></li>
- <li><div class="src-line"><a name="a815"></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">$dir</span><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="a816"></a> <span class="src-comm">// Open the directory</span></div></li>
- <li><div class="src-line"><a name="a817"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/is_dir">is_dir</a><span class="src-sym">(</span><span class="src-var">$dir</span><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="a818"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$dh </span>= <a href="http://www.php.net/opendir">opendir</a><span class="src-sym">(</span><span class="src-var">$dir</span><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="a819"></a> </div></li>
- <li><div class="src-line"><a name="a820"></a> <span class="src-comm">// Go through each item</span></div></li>
- <li><div class="src-line"><a name="a821"></a> <span class="src-var">$output </span>= <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="a822"></a> <span class="src-key">while </span><span class="src-sym">((</span><span class="src-var">$file </span>= <a href="http://www.php.net/readdir">readdir</a><span class="src-sym">(</span><span class="src-var">$dh</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="a823"></a> <span class="src-comm">// Ignore anything starting with a . and anything which isn't a directory</span></div></li>
- <li><div class="src-line"><a name="a824"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/strpos">strpos</a><span class="src-sym">(</span><span class="src-var">$file</span><span class="src-sym">, </span><span class="src-str">'.'</span><span class="src-sym">) </span>== <span class="src-num">0</span><span class="src-sym">) </span><span class="src-key">continue</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a825"></a> <span class="src-var">$filetype </span>= <span class="src-sym">@</span><a href="http://www.php.net/filetype">filetype</a><span class="src-sym">(</span><span class="src-var">$dir</span>.<span class="src-str">'/'</span>.<span class="src-var">$file</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a826"></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">$filetype</span><span class="src-sym">) </span>|| <span class="src-var">$filetype </span>!= <span class="src-str">'dir'</span><span class="src-sym">) </span><span class="src-key">continue</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a827"></a> </div></li>
- <li><div class="src-line"><a name="a828"></a> <span class="src-comm">// Store it</span></div></li>
- <li><div class="src-line"><a name="a829"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$relative</span><span class="src-sym">) </span><span class="src-var">$output</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-var">$file</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a830"></a> <span class="src-key">else </span><span class="src-var">$output</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-var">$dir</span>.<span class="src-str">'/'</span>.<span class="src-var">$file</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a831"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a832"></a> <a href="http://www.php.net/closedir">closedir</a><span class="src-sym">(</span><span class="src-var">$dh</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a833"></a> <a href="http://www.php.net/natcasesort">natcasesort</a><span class="src-sym">(</span><span class="src-var">$output</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a834"></a> <span class="src-key">return </span><span class="src-var">$output</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a835"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a836"></a> </div></li>
- <li><div class="src-line"><a name="a837"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a838"></a><span class="src-doc"> * Gets an array of files within the given directory.</span></div></li>
- <li><div class="src-line"><a name="a839"></a><span class="src-doc"> * Ignores anything which starts with a .</span></div></li>
- <li><div class="src-line"><a name="a840"></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">$dir </span><span class="src-doc">The directory to search WITHOUT a trailing slash. (Note: cannot search the current directory or higher in the file hierarchy)</span></div></li>
- <li><div class="src-line"><a name="a841"></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">$relative </span><span class="src-doc">If TRUE (default) the array of results will be relative to the input directory. Otherwise, they will include the input directory path.</span></div></li>
- <li><div class="src-line"><a name="a842"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array</span><span class="src-doc">|</span><span class="src-doc-type">false</span><span class="src-doc">A numeric array of file names sorted alphabetically, or false if an error occurred (such as the input value not being a directory)</span></div></li>
- <li><div class="src-line"><a name="a843"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a844"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_get_files">sloodle_get_files</a><span class="src-sym">(</span><span class="src-var">$dir</span><span class="src-sym">, </span><span class="src-var">$relative </span>= <span class="src-id">true</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a845"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a846"></a> <span class="src-comm">// Make sure we have a valid directory</span></div></li>
- <li><div class="src-line"><a name="a847"></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">$dir</span><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="a848"></a> <span class="src-comm">// Open the directory</span></div></li>
- <li><div class="src-line"><a name="a849"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/is_dir">is_dir</a><span class="src-sym">(</span><span class="src-var">$dir</span><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="a850"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$dh </span>= <a href="http://www.php.net/opendir">opendir</a><span class="src-sym">(</span><span class="src-var">$dir</span><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="a851"></a> </div></li>
- <li><div class="src-line"><a name="a852"></a> <span class="src-comm">// Go through each item</span></div></li>
- <li><div class="src-line"><a name="a853"></a> <span class="src-var">$output </span>= <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="a854"></a> <span class="src-key">while </span><span class="src-sym">((</span><span class="src-var">$file </span>= <a href="http://www.php.net/readdir">readdir</a><span class="src-sym">(</span><span class="src-var">$dh</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="a855"></a> <span class="src-comm">// Ignore anything starting with a . and anything which isn't a file</span></div></li>
- <li><div class="src-line"><a name="a856"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/strpos">strpos</a><span class="src-sym">(</span><span class="src-var">$file</span><span class="src-sym">, </span><span class="src-str">'.'</span><span class="src-sym">) </span>== <span class="src-num">0</span><span class="src-sym">) </span><span class="src-key">continue</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a857"></a> <span class="src-var">$filetype </span>= <span class="src-sym">@</span><a href="http://www.php.net/filetype">filetype</a><span class="src-sym">(</span><span class="src-var">$dir</span>.<span class="src-str">'/'</span>.<span class="src-var">$file</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a858"></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">$filetype</span><span class="src-sym">) </span>|| <span class="src-var">$filetype </span>!= <span class="src-str">'file'</span><span class="src-sym">) </span><span class="src-key">continue</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a859"></a> </div></li>
- <li><div class="src-line"><a name="a860"></a> <span class="src-comm">// Store it</span></div></li>
- <li><div class="src-line"><a name="a861"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$relative</span><span class="src-sym">) </span><span class="src-var">$output</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-var">$file</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a862"></a> <span class="src-key">else </span><span class="src-var">$output</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-var">$dir</span>.<span class="src-str">'/'</span>.<span class="src-var">$file</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a863"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a864"></a> <a href="http://www.php.net/closedir">closedir</a><span class="src-sym">(</span><span class="src-var">$dh</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a865"></a> <a href="http://www.php.net/natcasesort">natcasesort</a><span class="src-sym">(</span><span class="src-var">$output</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a866"></a> <span class="src-key">return </span><span class="src-var">$output</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a867"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a868"></a> </div></li>
- <li><div class="src-line"><a name="a869"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a870"></a><span class="src-doc"> * Extracts the object name and version number from an object identifier.</span></div></li>
- <li><div class="src-line"><a name="a871"></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">$objid </span><span class="src-doc">An object identifier, such as "chat-1.0"</span></div></li>
- <li><div class="src-line"><a name="a872"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span><span class="src-doc">A numeric array of name then version number.</span></div></li>
- <li><div class="src-line"><a name="a873"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a874"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_parse_object_identifier">sloodle_parse_object_identifier</a><span class="src-sym">(</span><span class="src-var">$objid</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a875"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a876"></a> <span class="src-comm">// Find the last dash character, and split the string around it.</span></div></li>
- <li><div class="src-line"><a name="a877"></a> <span class="src-var">$lastpos </span>= <a href="http://www.php.net/strrpos">strrpos</a><span class="src-sym">(</span><span class="src-var">$objid</span><span class="src-sym">, </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="a878"></a> <span class="src-comm">// Check for common problems</span></div></li>
- <li><div class="src-line"><a name="a879"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$lastpos </span>=== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-var">$objid</span><span class="src-sym">, </span><span class="src-str">''</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">// No dash</span></div></li>
- <li><div class="src-line"><a name="a880"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$lastpos </span>== <span class="src-num">0</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">''</span><span class="src-sym">, </span><a href="http://www.php.net/substr">substr</a><span class="src-sym">(</span><span class="src-var">$objid</span><span class="src-sym">, </span><span class="src-num">1</span><span class="src-sym">))</span><span class="src-sym">; </span><span class="src-comm">// Dash at start</span></div></li>
- <li><div class="src-line"><a name="a881"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$lastpos </span>== <span class="src-sym">(</span><a href="http://www.php.net/strlen">strlen</a><span class="src-sym">(</span><span class="src-var">$objid</span><span class="src-sym">) </span>- <span class="src-num">1</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-key">array</span><span class="src-sym">(</span><a href="http://www.php.net/substr">substr</a><span class="src-sym">(</span><span class="src-var">$objid</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">, </span>-<span class="src-num">1</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-str">''</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">// Dash at end</span></div></li>
- <li><div class="src-line"><a name="a882"></a> <span class="src-comm">// Split up the values</span></div></li>
- <li><div class="src-line"><a name="a883"></a> <span class="src-var">$name </span>= <a href="http://www.php.net/substr">substr</a><span class="src-sym">(</span><span class="src-var">$objid</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">, </span><span class="src-var">$lastpos</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a884"></a> <span class="src-var">$version </span>= <a href="http://www.php.net/substr">substr</a><span class="src-sym">(</span><span class="src-var">$objid</span><span class="src-sym">, </span><span class="src-var">$lastpos </span>+ <span class="src-num">1</span><span class="src-sym">, </span><a href="http://www.php.net/strlen">strlen</a><span class="src-sym">(</span><span class="src-var">$objid</span><span class="src-sym">) </span>- <span class="src-var">$lastpos </span>- <span class="src-num">1</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a885"></a> <span class="src-key">return </span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">, </span><span class="src-var">$version</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a886"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a887"></a> </div></li>
- <li><div class="src-line"><a name="a888"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a889"></a><span class="src-doc"> * Gets all object types and versions available in this installation.</span></div></li>
- <li><div class="src-line"><a name="a890"></a><span class="src-doc"> * Creates a 2-dimensional associative array.</span></div></li>
- <li><div class="src-line"><a name="a891"></a><span class="src-doc"> * The top level is the object name, and the second is the object version (both as strings).</span></div></li>
- <li><div class="src-line"><a name="a892"></a><span class="src-doc"> * The associated value is the path to the configuration form script, or boolean false</span></div></li>
- <li><div class="src-line"><a name="a893"></a><span class="src-doc"> * if the object has no configuration options.</span></div></li>
- <li><div class="src-line"><a name="a894"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array</span><span class="src-doc">|</span><span class="src-doc-type">false</span><span class="src-doc">Returns a 2d associative array if successful, or false if an error occurs</span></div></li>
- <li><div class="src-line"><a name="a895"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a896"></a> <span class="src-key">function </span><a href="../sloodle/_lib---general.php.html#functionsloodle_get_installed_object_types">sloodle_get_installed_object_types</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a897"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a898"></a> <span class="src-comm">// Fetch all sub-directories of the "mod" directory</span></div></li>
- <li><div class="src-line"><a name="a899"></a> <span class="src-var">$MODPATH </span>= <span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_DIRROOT">SLOODLE_DIRROOT</a></span>.<span class="src-str">'/mod'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a900"></a> <span class="src-var">$dirs </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_get_subdirectories">sloodle_get_subdirectories</a><span class="src-sym">(</span><span class="src-var">$MODPATH</span><span class="src-sym">, </span><span class="src-id">true</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a901"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$dirs</span><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="a902"></a> </div></li>
- <li><div class="src-line"><a name="a903"></a> <span class="src-comm">// Go through each object to parse names and version numbers.</span></div></li>
- <li><div class="src-line"><a name="a904"></a> <span class="src-comm">// Object names should have format "name-version" (e.g. "chat-1.0").</span></div></li>
- <li><div class="src-line"><a name="a905"></a> <span class="src-comm">// We will skip anything that does not match this format.</span></div></li>
- <li><div class="src-line"><a name="a906"></a> <span class="src-var">$mods </span>= <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="a907"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$dirs </span><span class="src-key">as </span><span class="src-var">$d</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a908"></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">$d</span><span class="src-sym">)) </span><span class="src-key">continue</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a909"></a> </div></li>
- <li><div class="src-line"><a name="a910"></a> <span class="src-comm">// Parse the object identifier</span></div></li>
- <li><div class="src-line"><a name="a911"></a> list<span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">, </span><span class="src-var">$version</span><span class="src-sym">) </span>= <a href="../sloodle/_lib---general.php.html#functionsloodle_parse_object_identifier">sloodle_parse_object_identifier</a><span class="src-sym">(</span><span class="src-var">$d</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a912"></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">$name</span><span class="src-sym">) </span>|| <span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$version</span><span class="src-sym">)) </span><span class="src-key">continue</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a913"></a> </div></li>
- <li><div class="src-line"><a name="a914"></a> <span class="src-comm">// Check if this object has a configuration script</span></div></li>
- <li><div class="src-line"><a name="a915"></a> <span class="src-var">$cfgscript </span>= <span class="src-str">"</span><span class="src-str"><span class="src-var">$MODPATH</span>/<span class="src-var">$d</span>/object_config.php</span><span class="src-str">"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a916"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/file_exists">file_exists</a><span class="src-sym">(</span><span class="src-var">$cfgscript</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a917"></a> <span class="src-var">$mods</span><span class="src-sym">[</span><span class="src-var">$name</span><span class="src-sym">]</span><span class="src-sym">[</span><span class="src-var">$version</span><span class="src-sym">] </span>= <span class="src-var">$cfgscript</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a918"></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="a919"></a> <span class="src-var">$mods</span><span class="src-sym">[</span><span class="src-var">$name</span><span class="src-sym">]</span><span class="src-sym">[</span><span class="src-var">$version</span><span class="src-sym">] </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a920"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a921"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a922"></a> </div></li>
- <li><div class="src-line"><a name="a923"></a> <span class="src-comm">// Sort the array by name of the object</span></div></li>
- <li><div class="src-line"><a name="a924"></a> <a href="http://www.php.net/ksort">ksort</a><span class="src-sym">(</span><span class="src-var">$mods</span><span class="src-sym">)</span><span class="src-sym">; </span></div></li>
- <li><div class="src-line"><a name="a925"></a> <span class="src-key">return </span><span class="src-var">$mods</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a926"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a927"></a> </div></li>
- <li><div class="src-line"><a name="a928"></a> </div></li>
- <li><div class="src-line"><a name="a929"></a><span class="src-php">?></span></div></li>
- </ol></div>
- </div>
- <p class="notes" id="credit">
- Documentation generated on Mon, 07 Jul 2008 12:32:27 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </body>
- </html>
|