| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566 |
- <?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 controller.php</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- </head>
- <body>
-
<h1>Source for file controller.php</h1>
- <p>Documentation is available at <a href="../sloodle/_lib---controller.php.html">controller.php</a></p>
- <div class="src-code">
- <div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
- <li><div class="src-line"><a name="a2"></a> <span class="src-comm">// This file is part of the Sloodle project (www.sloodle.org)</span></div></li>
- <li><div class="src-line"><a name="a3"></a> </div></li>
- <li><div class="src-line"><a name="a4"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a5"></a><span class="src-doc"> * This file defines the Sloodle Controller module sub-type.</span></div></li>
- <li><div class="src-line"><a name="a6"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a7"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> sloodle</span></div></li>
- <li><div class="src-line"><a name="a8"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright (c) 2008 Sloodle (various contributors)</span></div></li>
- <li><div class="src-line"><a name="a9"></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="a10"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a11"></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="a12"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a13"></a> </div></li>
- <li><div class="src-line"><a name="a14"></a> </div></li>
- <li><div class="src-line"><a name="a15"></a> <span class="src-doc">/** General Sloodle functionality. */</span></div></li>
- <li><div class="src-line"><a name="a16"></a> <span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">SLOODLE_LIBROOT</span>.<span class="src-str">'/general.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a17"></a> <span class="src-doc">/** The active object structure. */</span></div></li>
- <li><div class="src-line"><a name="a18"></a> <span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">SLOODLE_LIBROOT</span>.<span class="src-str">'/active_object.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a19"></a> </div></li>
- <li><div class="src-line"><a name="a20"></a> </div></li>
- <li><div class="src-line"><a name="a21"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a22"></a><span class="src-doc"> * Represents a Sloodle Controller, including data such as prim password.</span></div></li>
- <li><div class="src-line"><a name="a23"></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="a24"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a25"></a> <span class="src-key">class </span><a href="../sloodle/SloodleController.html">SloodleController</a></div></li>
- <li><div class="src-line"><a name="a26"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a27"></a> <span class="src-comm">// DATA //</span></div></li>
- <li><div class="src-line"><a name="a28"></a> </div></li>
- <li><div class="src-line"><a name="a29"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a30"></a><span class="src-doc"> * Internal for Moodle only - course module instance.</span></div></li>
- <li><div class="src-line"><a name="a31"></a><span class="src-doc"> * Corresponds to one record from the Moodle 'course_modules' table.</span></div></li>
- <li><div class="src-line"><a name="a32"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">object </span></div></li>
- <li><div class="src-line"><a name="a33"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a34"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a35"></a> <span class="src-key">var </span><a href="../sloodle/SloodleController.html#var$cm">$cm</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a36"></a> </div></li>
- <li><div class="src-line"><a name="a37"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a38"></a><span class="src-doc"> * Internal only - Sloodle module instance database object.</span></div></li>
- <li><div class="src-line"><a name="a39"></a><span class="src-doc"> * Corresponds to one record from the Moodle 'sloodle' table.</span></div></li>
- <li><div class="src-line"><a name="a40"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">object </span></div></li>
- <li><div class="src-line"><a name="a41"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a42"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a43"></a> <span class="src-key">var </span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">$sloodle_module_instance</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a44"></a> </div></li>
- <li><div class="src-line"><a name="a45"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a46"></a><span class="src-doc"> * Internal only - Sloodle Controller instance database object.</span></div></li>
- <li><div class="src-line"><a name="a47"></a><span class="src-doc"> * Corresponds to one record from the Moodle 'sloodle_controller' table.</span></div></li>
- <li><div class="src-line"><a name="a48"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">object </span></div></li>
- <li><div class="src-line"><a name="a49"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a50"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a51"></a> <span class="src-key">var </span><a href="../sloodle/SloodleController.html#var$sloodle_controller_instance">$sloodle_controller_instance</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a52"></a> </div></li>
- <li><div class="src-line"><a name="a53"></a> </div></li>
- <li><div class="src-line"><a name="a54"></a> <span class="src-comm">// FUNCTIONS //</span></div></li>
- <li><div class="src-line"><a name="a55"></a> </div></li>
- <li><div class="src-line"><a name="a56"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a57"></a><span class="src-doc"> * Constructor</span></div></li>
- <li><div class="src-line"><a name="a58"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a59"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodSloodleController">SloodleController</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a60"></a> <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> </div></li>
- <li><div class="src-line"><a name="a63"></a> </div></li>
- <li><div class="src-line"><a name="a64"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a65"></a><span class="src-doc"> * Loads data from the database.</span></div></li>
- <li><div class="src-line"><a name="a66"></a><span class="src-doc"> * Note: even if the function fails, it may still have overwritten some or all existing data in the object.</span></div></li>
- <li><div class="src-line"><a name="a67"></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">$id </span><span class="src-doc">The site-wide unique identifier for all modules. Type depends on VLE. On Moodle, it is an integer course module identifier ('id' field of 'course_modules' table)</span></div></li>
- <li><div class="src-line"><a name="a68"></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="a69"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a70"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodload">load</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="a71"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a72"></a> <span class="src-comm">// Make sure the ID is valid</span></div></li>
- <li><div class="src-line"><a name="a73"></a> <span class="src-var">$id </span>= (int)<span class="src-var">$id</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a74"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$id </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="a75"></a> </div></li>
- <li><div class="src-line"><a name="a76"></a> <span class="src-comm">// Fetch the course module data</span></div></li>
- <li><div class="src-line"><a name="a77"></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">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$cm">cm</a> = <span class="src-id">get_coursemodule_from_id</span><span class="src-sym">(</span><span class="src-str">'sloodle'</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="a78"></a> <a href="../sloodle/_sl_config.php.html#functionsloodle_debug">sloodle_debug</a><span class="src-sym">(</span><span class="src-str">"Failed to load controler course module.<br>"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a79"></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="a80"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a81"></a> </div></li>
- <li><div class="src-line"><a name="a82"></a> <span class="src-comm">// Load from the primary table: Sloodle instance</span></div></li>
- <li><div class="src-line"><a name="a83"></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">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">sloodle_module_instance</a> = <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle'</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$cm">cm</a><span class="src-sym">-></span><span class="src-id">instance</span><span class="src-sym">))) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a84"></a> <a href="../sloodle/_sl_config.php.html#functionsloodle_debug">sloodle_debug</a><span class="src-sym">(</span><span class="src-str">"Failed to load controller Sloodle module instance.<br>"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a85"></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="a86"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a87"></a> <span class="src-comm">// Check that it is the correct type</span></div></li>
- <li><div class="src-line"><a name="a88"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">sloodle_module_instance</a><span class="src-sym">-></span><span class="src-id">type </span>!= <span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_TYPE_CTRL">SLOODLE_TYPE_CTRL</a></span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a89"></a> <a href="../sloodle/_sl_config.php.html#functionsloodle_debug">sloodle_debug</a><span class="src-sym">(</span><span class="src-str">"Loaded Sloodle module instance is not a controller.<br>"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a90"></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="a91"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a92"></a> </div></li>
- <li><div class="src-line"><a name="a93"></a> <span class="src-comm">// Load from the secondary table: Controller instance</span></div></li>
- <li><div class="src-line"><a name="a94"></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">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_controller_instance">sloodle_controller_instance</a> = <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_controller'</span><span class="src-sym">, </span><span class="src-str">'sloodleid'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$cm">cm</a><span class="src-sym">-></span><span class="src-id">instance</span><span class="src-sym">))) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a95"></a> <a href="../sloodle/_sl_config.php.html#functionsloodle_debug">sloodle_debug</a><span class="src-sym">(</span><span class="src-str">"Failed to load controller secondary data table.<br>"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a96"></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="a97"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a98"></a> </div></li>
- <li><div class="src-line"><a name="a99"></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="a100"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a101"></a> </div></li>
- <li><div class="src-line"><a name="a102"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a103"></a><span class="src-doc"> * Updates the currently loaded entry in the database.</span></div></li>
- <li><div class="src-line"><a name="a104"></a><span class="src-doc"> * Note: the data *must* have been previously loaded using </span><span class="src-doc-inlinetag">{@link load_from_db()}</span><span class="src-doc">.</span></div></li>
- <li><div class="src-line"><a name="a105"></a><span class="src-doc"> * This function cannot be used to create new entries.</span></div></li>
- <li><div class="src-line"><a name="a106"></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="a107"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a108"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodwrite">write</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a109"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a110"></a> <span class="src-comm">// Make sure we have all the necessary data</span></div></li>
- <li><div class="src-line"><a name="a111"></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">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">sloodle_module_instance</a><span class="src-sym">) </span>|| <span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_controller_instance">sloodle_controller_instance</a><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a112"></a> <span class="src-comm">// Attempt to update the primary table</span></div></li>
- <li><div class="src-line"><a name="a113"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">sloodle_module_instance</a><span class="src-sym">-></span><span class="src-id">timemodified </span>= <a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a114"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-id">update_record</span><span class="src-sym">(</span><span class="src-str">'sloodle'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">sloodle_module_instance</a><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a115"></a> <span class="src-comm">// Attempt to update the secondary table</span></div></li>
- <li><div class="src-line"><a name="a116"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-id">update_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_controller'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_controller_instance">sloodle_controller_instance</a><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a117"></a> </div></li>
- <li><div class="src-line"><a name="a118"></a> <span class="src-comm">// Everything seems OK</span></div></li>
- <li><div class="src-line"><a name="a119"></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="a120"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a121"></a> </div></li>
- <li><div class="src-line"><a name="a122"></a> </div></li>
- <li><div class="src-line"><a name="a123"></a> <span class="src-comm">// ACCESSORS //</span></div></li>
- <li><div class="src-line"><a name="a124"></a> </div></li>
- <li><div class="src-line"><a name="a125"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a126"></a><span class="src-doc"> * Determines whether or not this controller is loaded.</span></div></li>
- <li><div class="src-line"><a name="a127"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
- <li><div class="src-line"><a name="a128"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a129"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodis_loaded">is_loaded</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a130"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a131"></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">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$cm">cm</a><span class="src-sym">) </span>|| <span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">sloodle_module_instance</a><span class="src-sym">) </span>|| <span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_controller_instance">sloodle_controller_instance</a><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a132"></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="a133"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a134"></a> </div></li>
- <li><div class="src-line"><a name="a135"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a136"></a><span class="src-doc"> * Gets the site-wide unique identifier for this module.</span></div></li>
- <li><div class="src-line"><a name="a137"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">Identifier. Type is dependent on VLE. On Moodle, it is an integer course module identifier.</span></div></li>
- <li><div class="src-line"><a name="a138"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a139"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodget_id">get_id</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a140"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a141"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$cm">cm</a><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="a142"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a143"></a> </div></li>
- <li><div class="src-line"><a name="a144"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a145"></a><span class="src-doc"> * Gets the identifier for controller (unique among all Sloodle controlers - may be the same as </span><span class="src-doc-inlinetag">{@link get_id()}</span><span class="src-doc"> in some environments</span></div></li>
- <li><div class="src-line"><a name="a146"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">Identifier. Type is dependent on VLE. On Moodle, it is an integer relating to the 'id' field of the 'sloodle_controller' table</span></div></li>
- <li><div class="src-line"><a name="a147"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a148"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodget_controller_id">get_controller_id</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a149"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a150"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_controller_instance">sloodle_controller_instance</a><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="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-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a154"></a><span class="src-doc"> * Gets the name of this controller.</span></div></li>
- <li><div class="src-line"><a name="a155"></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 name of this controller</span></div></li>
- <li><div class="src-line"><a name="a156"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a157"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodget_name">get_name</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a158"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a159"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">sloodle_module_instance</a><span class="src-sym">-></span><span class="src-id">name</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a160"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a161"></a> </div></li>
- <li><div class="src-line"><a name="a162"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a163"></a><span class="src-doc"> * Sets the name of this controller.</span></div></li>
- <li><div class="src-line"><a name="a164"></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 new name for this controller - ignored if empty</span></div></li>
- <li><div class="src-line"><a name="a165"></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="a166"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a167"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodset_name">set_name</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="a168"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a169"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">)) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">sloodle_module_instance</a><span class="src-sym">-></span><span class="src-id">name </span>= <span class="src-var">$name</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a170"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a171"></a> </div></li>
- <li><div class="src-line"><a name="a172"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a173"></a><span class="src-doc"> * Gets the intro description of this controller.</span></div></li>
- <li><div class="src-line"><a name="a174"></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 intro description of this controller</span></div></li>
- <li><div class="src-line"><a name="a175"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a176"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodget_intro">get_intro</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a177"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a178"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">sloodle_module_instance</a><span class="src-sym">-></span><span class="src-id">intro</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a179"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a180"></a> </div></li>
- <li><div class="src-line"><a name="a181"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a182"></a><span class="src-doc"> * Sets the intro description of this controller.</span></div></li>
- <li><div class="src-line"><a name="a183"></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">$intro </span><span class="src-doc">The new intro for this controller - ignored if empty</span></div></li>
- <li><div class="src-line"><a name="a184"></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="a185"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a186"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodset_intro">set_intro</a><span class="src-sym">(</span><span class="src-var">$intro</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a187"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a188"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$intro</span><span class="src-sym">)) </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">sloodle_module_instance</a><span class="src-sym">-></span><span class="src-id">intro </span>= <span class="src-var">$intro</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a189"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a190"></a> </div></li>
- <li><div class="src-line"><a name="a191"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a192"></a><span class="src-doc"> * Gets the identifier of the course this controller belongs to.</span></div></li>
- <li><div class="src-line"><a name="a193"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</span></div></li>
- <li><div class="src-line"><a name="a194"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a195"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodget_course_id">get_course_id</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a196"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a197"></a> <span class="src-key">return </span>(int)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">sloodle_module_instance</a><span class="src-sym">-></span><span class="src-id">course</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a198"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a199"></a> </div></li>
- <li><div class="src-line"><a name="a200"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a201"></a><span class="src-doc"> * Gets the time at which this controller was created.</span></div></li>
- <li><div class="src-line"><a name="a202"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">int </span><span class="src-doc">Timestamp</span></div></li>
- <li><div class="src-line"><a name="a203"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a204"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodget_creation_time">get_creation_time</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a205"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a206"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">sloodle_module_instance</a><span class="src-sym">-></span><span class="src-id">timecreated</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"> * Gets the time at which this controller was last modified.</span></div></li>
- <li><div class="src-line"><a name="a211"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">int </span><span class="src-doc">Timestamp</span></div></li>
- <li><div class="src-line"><a name="a212"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a213"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodget_modification_time">get_modification_time</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a214"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a215"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_module_instance">sloodle_module_instance</a><span class="src-sym">-></span><span class="src-id">timemodified</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> </div></li>
- <li><div class="src-line"><a name="a218"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a219"></a><span class="src-doc"> * Determines whether or not this controller is available (i.e. not hidden).</span></div></li>
- <li><div class="src-line"><a name="a220"></a><span class="src-doc"> * Note: this is separate from being enabled or disabled.</span></div></li>
- <li><div class="src-line"><a name="a221"></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 controller is available.</span></div></li>
- <li><div class="src-line"><a name="a222"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a223"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodis_available">is_available</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a224"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a225"></a> <span class="src-key">return </span>(bool)<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$cm">cm</a><span class="src-sym">-></span><span class="src-id">visible</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-sym">}</span></div></li>
- <li><div class="src-line"><a name="a227"></a> </div></li>
- <li><div class="src-line"><a name="a228"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a229"></a><span class="src-doc"> * Determines if this controller is enabled or not.</span></div></li>
- <li><div class="src-line"><a name="a230"></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 controller is enabled, or false otherwise.</span></div></li>
- <li><div class="src-line"><a name="a231"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a232"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodis_enabled">is_enabled</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a233"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a234"></a> <span class="src-key">return </span>(bool)<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_controller_instance">sloodle_controller_instance</a><span class="src-sym">-></span><span class="src-id">enabled</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a235"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a236"></a> </div></li>
- <li><div class="src-line"><a name="a237"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a238"></a><span class="src-doc"> * Enables this controller</span></div></li>
- <li><div class="src-line"><a name="a239"></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="a240"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a241"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodenable">enable</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a242"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a243"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_controller_instance">sloodle_controller_instance</a><span class="src-sym">-></span><span class="src-id">enabled </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a244"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a245"></a> </div></li>
- <li><div class="src-line"><a name="a246"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a247"></a><span class="src-doc"> * Disables this controller</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">void </span></div></li>
- <li><div class="src-line"><a name="a249"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a250"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methoddisable">disable</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a251"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a252"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_controller_instance">sloodle_controller_instance</a><span class="src-sym">-></span><span class="src-id">enabled </span>= <span class="src-id">false</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> </div></li>
- <li><div class="src-line"><a name="a255"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a256"></a><span class="src-doc"> * Gets the prim password of this controller.</span></div></li>
- <li><div class="src-line"><a name="a257"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc">The current prim password.</span></div></li>
- <li><div class="src-line"><a name="a258"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a259"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodget_password">get_password</a><span class="src-sym">(</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-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_controller_instance">sloodle_controller_instance</a><span class="src-sym">-></span><span class="src-id">password</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"> * Sets the prim password of this controller.</span></div></li>
- <li><div class="src-line"><a name="a266"></a><span class="src-doc"> * Also checks for validity before storing.</span></div></li>
- <li><div class="src-line"><a name="a267"></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 new prim password</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">bool </span><span class="src-doc">True if successfully stored, or false if the password is invalid</span></div></li>
- <li><div class="src-line"><a name="a269"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a270"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodset_password">set_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="a271"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a272"></a> <span class="src-comm">// Check validity</span></div></li>
- <li><div class="src-line"><a name="a273"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</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><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="a274"></a> <span class="src-comm">// Store it</span></div></li>
- <li><div class="src-line"><a name="a275"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$sloodle_controller_instance">sloodle_controller_instance</a><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="a276"></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="a277"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a278"></a> </div></li>
- <li><div class="src-line"><a name="a279"></a> </div></li>
- <li><div class="src-line"><a name="a280"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a281"></a><span class="src-doc"> * Registers a new active object (or renew an existing authorisation) with this controller.</span></div></li>
- <li><div class="src-line"><a name="a282"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$uuid </span><span class="src-doc">The UUID of the object to be registered</span></div></li>
- <li><div class="src-line"><a name="a283"></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">Name of the object to be registered</span></div></li>
- <li><div class="src-line"><a name="a284"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">SloodleUser </span><span class="src-doc-var">$user </span><span class="src-doc">The user who is authorising the object</span></div></li>
- <li><div class="src-line"><a name="a285"></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 for the object</span></div></li>
- <li><div class="src-line"><a name="a286"></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">$type </span><span class="src-doc">Type identifier of the object to be registered</span></div></li>
- <li><div class="src-line"><a name="a287"></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">$timestamp </span><span class="src-doc">The timestamp of the object's registration, or null to use the current time.</span></div></li>
- <li><div class="src-line"><a name="a288"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">int</span><span class="src-doc">|</span><span class="src-doc-type">bool</span><span class="src-doc">The new authorisation ID if successful, or false if not</span></div></li>
- <li><div class="src-line"><a name="a289"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a290"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodregister_object">register_object</a><span class="src-sym">(</span><span class="src-var">$uuid</span><span class="src-sym">, </span><span class="src-var">$name</span><span class="src-sym">, </span><span class="src-var">$user</span><span class="src-sym">, </span><span class="src-var">$password</span><span class="src-sym">, </span><span class="src-var">$type </span>= <span class="src-str">''</span><span class="src-sym">, </span><span class="src-var">$timestamp </span>= <span class="src-id">null</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a291"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a292"></a> <span class="src-comm">// Use the current timestamp if necessary</span></div></li>
- <li><div class="src-line"><a name="a293"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$timestamp </span>== <span class="src-id">null</span><span class="src-sym">) </span><span class="src-var">$timestamp </span>= <a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a294"></a> <span class="src-comm">// Extract the user ID, if available</span></div></li>
- <li><div class="src-line"><a name="a295"></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="a296"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$user</span><span class="src-sym">-></span><span class="src-id">is_user_loaded</span><span class="src-sym">(</span><span class="src-sym">)) </span><span class="src-var">$userid </span>= <span class="src-var">$user</span><span class="src-sym">-></span><span class="src-id">get_user_id</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a297"></a> </div></li>
- <li><div class="src-line"><a name="a298"></a> <span class="src-comm">// Check to see if an entry already exists for this object</span></div></li>
- <li><div class="src-line"><a name="a299"></a> <span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'uuid'</span><span class="src-sym">, </span><span class="src-var">$uuid</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a300"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$entry</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a301"></a> <span class="src-comm">// Create a new entry</span></div></li>
- <li><div class="src-line"><a name="a302"></a> <span class="src-var">$entry </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="a303"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">controllerid </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$cm">cm</a><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="a304"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">uuid </span>= <span class="src-var">$uuid</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a305"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">name </span>= <span class="src-var">$name</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a306"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">userid </span>= <span class="src-var">$userid</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a307"></a> <span class="src-var">$entry</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="a308"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">type </span>= <span class="src-var">$type</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a309"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">timeupdated </span>= <span class="src-var">$timestamp</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a310"></a> <span class="src-comm">// Attempt to insert the entry</span></div></li>
- <li><div class="src-line"><a name="a311"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">id </span>= <span class="src-id">insert_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-var">$entry</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a312"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">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="a313"></a> </div></li>
- <li><div class="src-line"><a name="a314"></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="a315"></a> <span class="src-comm">// Update the existing entry</span></div></li>
- <li><div class="src-line"><a name="a316"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">controllerid </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#var$cm">cm</a><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="a317"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">name </span>= <span class="src-var">$name</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a318"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">userid </span>= <span class="src-var">$userid</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a319"></a> <span class="src-var">$entry</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="a320"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">type </span>= <span class="src-var">$type</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a321"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">timeupdated </span>= <span class="src-var">$timestamp</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a322"></a> <span class="src-comm">// Attempt to update the database</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-id">update_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-var">$entry</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> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a325"></a> </div></li>
- <li><div class="src-line"><a name="a326"></a> <span class="src-key">return </span><span class="src-var">$entry</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="a327"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a328"></a> </div></li>
- <li><div class="src-line"><a name="a329"></a> </div></li>
- <li><div class="src-line"><a name="a330"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a331"></a><span class="src-doc"> * Registers a new unauthorised object.</span></div></li>
- <li><div class="src-line"><a name="a332"></a><span class="src-doc"> * (Can be called statically).</span></div></li>
- <li><div class="src-line"><a name="a333"></a><span class="src-doc"> * Creates a new active object entry, not linked to any user or controller.</span></div></li>
- <li><div class="src-line"><a name="a334"></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">$uuid </span><span class="src-doc">The UUID of the object to be registered</span></div></li>
- <li><div class="src-line"><a name="a335"></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">Name of the object to be registered</span></div></li>
- <li><div class="src-line"><a name="a336"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$password </span><span class="src-doc">The password for the object</span></div></li>
- <li><div class="src-line"><a name="a337"></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">$type </span><span class="src-doc">Type identifier of the object to be registered</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">int </span><span class="src-doc-var">$timestamp </span><span class="src-doc">The timestamp of the object's registration, or null to use the current time.</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">int</span><span class="src-doc">|</span><span class="src-doc-type">bool</span><span class="src-doc">The integer ID of the active object entry, or false if not</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/SloodleController.html#methodregister_unauth_object">register_unauth_object</a><span class="src-sym">(</span><span class="src-var">$uuid</span><span class="src-sym">, </span><span class="src-var">$name</span><span class="src-sym">, </span><span class="src-var">$password</span><span class="src-sym">, </span><span class="src-var">$type </span>= <span class="src-str">''</span><span class="src-sym">, </span><span class="src-var">$timestamp </span>= <span class="src-id">null</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">// Use the current timestamp if necessary</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-var">$timestamp </span>== <span class="src-id">null</span><span class="src-sym">) </span><span class="src-var">$timestamp </span>= <a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a345"></a> </div></li>
- <li><div class="src-line"><a name="a346"></a> <span class="src-comm">// Check to see if an entry already exists for this object</span></div></li>
- <li><div class="src-line"><a name="a347"></a> <span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'uuid'</span><span class="src-sym">, </span><span class="src-var">$uuid</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a348"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$entry</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a349"></a> <span class="src-comm">// Create a new entry</span></div></li>
- <li><div class="src-line"><a name="a350"></a> <span class="src-var">$entry </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="a351"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">controllerid </span>= <span class="src-num">0</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a352"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">uuid </span>= <span class="src-var">$uuid</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a353"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">name </span>= <span class="src-var">$name</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a354"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">userid </span>= <span class="src-num">0</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a355"></a> <span class="src-var">$entry</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="a356"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">type </span>= <span class="src-var">$type</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a357"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">timeupdated </span>= <span class="src-var">$timestamp</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a358"></a> <span class="src-comm">// Attempt to insert the entry</span></div></li>
- <li><div class="src-line"><a name="a359"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">id </span>= <span class="src-id">insert_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-var">$entry</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a360"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">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="a361"></a> </div></li>
- <li><div class="src-line"><a name="a362"></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="a363"></a> <span class="src-comm">// Update the existing entry</span></div></li>
- <li><div class="src-line"><a name="a364"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">controllerid </span>= <span class="src-num">0</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a365"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">name </span>= <span class="src-var">$name</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a366"></a> <span class="src-var">$entry</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="a367"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">type </span>= <span class="src-var">$type</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a368"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">userid </span>= <span class="src-num">0</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a369"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">timeupdated </span>= <span class="src-var">$timestamp</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a370"></a> <span class="src-comm">// Attempt to update the database</span></div></li>
- <li><div class="src-line"><a name="a371"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-id">update_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-var">$entry</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="a372"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a373"></a> </div></li>
- <li><div class="src-line"><a name="a374"></a> <span class="src-key">return </span><span class="src-var">$entry</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="a375"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a376"></a> </div></li>
- <li><div class="src-line"><a name="a377"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a378"></a><span class="src-doc"> * Updates the type of a given active object to the specified type.</span></div></li>
- <li><div class="src-line"><a name="a379"></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">$uuid </span><span class="src-doc">The UUID of the object being updated</span></div></li>
- <li><div class="src-line"><a name="a380"></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">$type </span><span class="src-doc">Name of the new type identifier</span></div></li>
- <li><div class="src-line"><a name="a381"></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 not</span></div></li>
- <li><div class="src-line"><a name="a382"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a383"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodupdate_object_type">update_object_type</a><span class="src-sym">(</span><span class="src-var">$uuid</span><span class="src-sym">, </span><span class="src-var">$type</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a384"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a385"></a> <span class="src-comm">// Attempt to find an entry for the object</span></div></li>
- <li><div class="src-line"><a name="a386"></a> <span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'uuid'</span><span class="src-sym">, </span><span class="src-var">$uuid</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a387"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$entry</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="a388"></a> <span class="src-comm">// Update the type and time</span></div></li>
- <li><div class="src-line"><a name="a389"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">type </span>= <span class="src-var">$type</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a390"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">timeupdated </span>= <a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a391"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-id">update_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-var">$entry</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="a392"></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="a393"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a394"></a> </div></li>
- <li><div class="src-line"><a name="a395"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a396"></a><span class="src-doc"> * Authorises an otherwise unauthorised active object against the given user and the current controller.</span></div></li>
- <li><div class="src-line"><a name="a397"></a><span class="src-doc"> * (NOTE: the object must previously have been registered using </span><span class="src-doc-inlinetag">{@link register_object()}</span><span class="src-doc">).</span></div></li>
- <li><div class="src-line"><a name="a398"></a><span class="src-doc"> * <b>Must not be called statically.</b></span></div></li>
- <li><div class="src-line"><a name="a399"></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">$uuid </span><span class="src-doc">The UUID of the object being updated</span></div></li>
- <li><div class="src-line"><a name="a400"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">SloodleUser </span><span class="src-doc-var">$user </span><span class="src-doc">The user to authorise the object against</span></div></li>
- <li><div class="src-line"><a name="a401"></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">$type </span><span class="src-doc">(Optional). Specifies the type to store for this object. Ignored if null.</span></div></li>
- <li><div class="src-line"><a name="a402"></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 not</span></div></li>
- <li><div class="src-line"><a name="a403"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a404"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodauthorise_object">authorise_object</a><span class="src-sym">(</span><span class="src-var">$uuid</span><span class="src-sym">, </span><span class="src-var">$user</span><span class="src-sym">, </span><span class="src-var">$type </span>= <span class="src-id">null</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> <span class="src-comm">// Attempt to find an unauthorised entry for the object</span></div></li>
- <li><div class="src-line"><a name="a407"></a> <span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'uuid'</span><span class="src-sym">, </span><span class="src-var">$uuid</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a408"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$entry</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="a409"></a> <span class="src-comm">// Update the controller, user and time</span></div></li>
- <li><div class="src-line"><a name="a410"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">controllerid </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#methodget_id">get_id</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a411"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">userid </span>= <span class="src-var">$user</span><span class="src-sym">-></span><span class="src-id">get_user_id</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a412"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$type</span><span class="src-sym">)) </span><span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">type </span>= <span class="src-var">$type</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a413"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">timeupdated </span>= <a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a414"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-id">update_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-var">$entry</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="a415"></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="a416"></a> <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-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a419"></a><span class="src-doc"> * Checks if the specified object is authorised for this controller with the given password.</span></div></li>
- <li><div class="src-line"><a name="a420"></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">$uuid </span><span class="src-doc">The UUID of the object to check</span></div></li>
- <li><div class="src-line"><a name="a421"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$password </span><span class="src-doc">The password to check</span></div></li>
- <li><div class="src-line"><a name="a422"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if object is authorised, or false if not</span></div></li>
- <li><div class="src-line"><a name="a423"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a424"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodcheck_authorisation">check_authorisation</a><span class="src-sym">(</span><span class="src-var">$uuid</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="a425"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a426"></a> <span class="src-comm">// Attempt to find an entry for the object</span></div></li>
- <li><div class="src-line"><a name="a427"></a> <span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'controllerid'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#methodget_id">get_id</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-str">'uuid'</span><span class="src-sym">, </span><span class="src-var">$uuid</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a428"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$entry</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="a429"></a> <span class="src-comm">// Make sure we have the type data</span></div></li>
- <li><div class="src-line"><a name="a430"></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">$entry</span><span class="src-sym">-></span><span class="src-id">type</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="a431"></a> </div></li>
- <li><div class="src-line"><a name="a432"></a> <span class="src-comm">// Verify the password</span></div></li>
- <li><div class="src-line"><a name="a433"></a> <span class="src-key">return </span><span class="src-sym">(</span><span class="src-var">$password </span>== <span class="src-var">$entry</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="a434"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a435"></a> </div></li>
- <li><div class="src-line"><a name="a436"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a437"></a><span class="src-doc"> * Gets the ID of the user who authorised the specified object.</span></div></li>
- <li><div class="src-line"><a name="a438"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed</span><span class="src-doc">|</span><span class="src-doc-type">bool</span><span class="src-doc">Returns the user ID if successful, or FALSE if not</span></div></li>
- <li><div class="src-line"><a name="a439"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a440"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodget_authorizing_user">get_authorizing_user</a><span class="src-sym">(</span><span class="src-var">$uuid</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a441"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a442"></a> <span class="src-comm">// Attempt to find an entry for the object</span></div></li>
- <li><div class="src-line"><a name="a443"></a> <span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'controllerid'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#methodget_id">get_id</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-str">'uuid'</span><span class="src-sym">, </span><span class="src-var">$uuid</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a444"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$entry</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="a445"></a> <span class="src-key">return </span>(int)<span class="src-var">$entry</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="a446"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a447"></a> </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-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a450"></a><span class="src-doc"> * Removes an active object and all its related items.</span></div></li>
- <li><div class="src-line"><a name="a451"></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">$id </span><span class="src-doc">If it is an integer, then it is treated as the active object ID. If a string, it is treated as the object UUID.</span></div></li>
- <li><div class="src-line"><a name="a452"></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="a453"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a454"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodremove_object">remove_object</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="a455"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a456"></a> <span class="src-comm">// Check what type the ID is</span></div></li>
- <li><div class="src-line"><a name="a457"></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">$id</span><span class="src-sym">)) </span><span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'uuid'</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="a458"></a> <span class="src-key">else </span><span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span>(int)<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="a459"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$entry</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="a460"></a> </div></li>
- <li><div class="src-line"><a name="a461"></a> <span class="src-comm">// Delete all config entries and the object record itself</span></div></li>
- <li><div class="src-line"><a name="a462"></a> <span class="src-id">delete_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_object_config'</span><span class="src-sym">, </span><span class="src-str">'object'</span><span class="src-sym">, </span><span class="src-var">$entry</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="a463"></a> <span class="src-id">delete_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span><span class="src-var">$entry</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="a464"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a465"></a> </div></li>
- <li><div class="src-line"><a name="a466"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a467"></a><span class="src-doc"> * Gets data about an active object.</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">mixed </span><span class="src-doc-var">$id </span><span class="src-doc">If an integer, it is the ID of an active object. If it is a string it is the object's UUID.</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">SloodleActiveObject</span><span class="src-doc">|</span><span class="src-doc-type">bool</span><span class="src-doc">Returns false on failure</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/SloodleController.html#methodget_object">get_object</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="a472"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a473"></a> <span class="src-comm">// Check what type the ID is</span></div></li>
- <li><div class="src-line"><a name="a474"></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">$id</span><span class="src-sym">)) </span><span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'uuid'</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="a475"></a> <span class="src-key">else </span><span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span>(int)<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="a476"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$entry</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="a477"></a> </div></li>
- <li><div class="src-line"><a name="a478"></a> <span class="src-comm">// Create a dummy SloodleSession</span></div></li>
- <li><div class="src-line"><a name="a479"></a> <span class="src-var">$sloodle </span>= <span class="src-key">new </span><span class="src-id"><a href="../sloodle/SloodleSession.html">SloodleSession</a></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="a480"></a> </div></li>
- <li><div class="src-line"><a name="a481"></a> <span class="src-comm">// Construct a structure</span></div></li>
- <li><div class="src-line"><a name="a482"></a> <span class="src-var">$obj </span>= <span class="src-key">new </span><span class="src-id"><a href="../sloodle/SloodleActiveObject.html">SloodleActiveObject</a></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="a483"></a> <span class="src-var">$obj</span><span class="src-sym">-></span><span class="src-id">uuid </span>= <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">uuid</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a484"></a> <span class="src-var">$obj</span><span class="src-sym">-></span><span class="src-id">name </span>= <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">name</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a485"></a> <span class="src-var">$obj</span><span class="src-sym">-></span><span class="src-id">password </span>= <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">password</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a486"></a> <span class="src-var">$obj</span><span class="src-sym">-></span><span class="src-id">type </span>= <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">type</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a487"></a> </div></li>
- <li><div class="src-line"><a name="a488"></a> <span class="src-var">$obj</span><span class="src-sym">-></span><span class="src-id">course </span>= <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">course</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a489"></a> <span class="src-var">$obj</span><span class="src-sym">-></span><span class="src-id">course</span><span class="src-sym">-></span><span class="src-id">load_by_controller</span><span class="src-sym">(</span><span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">controllerid</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a490"></a> </div></li>
- <li><div class="src-line"><a name="a491"></a> <span class="src-var">$obj</span><span class="src-sym">-></span><span class="src-id">user </span>= <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">user</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a492"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">id </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="a493"></a> <span class="src-var">$obj</span><span class="src-sym">-></span><span class="src-id">user</span><span class="src-sym">-></span><span class="src-id">load_user</span><span class="src-sym">(</span><span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">userid</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a494"></a> <span class="src-var">$obj</span><span class="src-sym">-></span><span class="src-id">user</span><span class="src-sym">-></span><span class="src-id">load_linked_avatar</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a495"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a496"></a> </div></li>
- <li><div class="src-line"><a name="a497"></a> <span class="src-key">return </span><span class="src-var">$obj</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a498"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a499"></a> </div></li>
- <li><div class="src-line"><a name="a500"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a501"></a><span class="src-doc"> * Gets an array of object configuration settings.</span></div></li>
- <li><div class="src-line"><a name="a502"></a><span class="src-doc"> * (Can be called statically).</span></div></li>
- <li><div class="src-line"><a name="a503"></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">$id </span><span class="src-doc">If an integer, it is the ID of an active object. If it is a string it is the object's UUID.</span></div></li>
- <li><div class="src-line"><a name="a504"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span><span class="src-doc">Associative array of setting names to values. (Returns an empty array if unsuccessful.)</span></div></li>
- <li><div class="src-line"><a name="a505"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a506"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodget_object_configuration">get_object_configuration</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="a507"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a508"></a> <span class="src-comm">// If the ID is empty, then we have no configuration settings to get</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-key">empty</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-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="a510"></a> </div></li>
- <li><div class="src-line"><a name="a511"></a> <span class="src-comm">// Check what type the ID is and fetch the object</span></div></li>
- <li><div class="src-line"><a name="a512"></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">$id</span><span class="src-sym">)) </span><span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'uuid'</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="a513"></a> <span class="src-key">else </span><span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span>(int)<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="a514"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$entry</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-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a515"></a> </div></li>
- <li><div class="src-line"><a name="a516"></a> <span class="src-comm">// Fetch the values</span></div></li>
- <li><div class="src-line"><a name="a517"></a> <span class="src-var">$recs </span>= <span class="src-id">get_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_object_config'</span><span class="src-sym">, </span><span class="src-str">'object'</span><span class="src-sym">, </span><span class="src-var">$entry</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="a518"></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="a519"></a> <span class="src-comm">// Construct our associative array</span></div></li>
- <li><div class="src-line"><a name="a520"></a> <span class="src-var">$config </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="a521"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$recs </span><span class="src-key">as </span><span class="src-var">$r</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a522"></a> <span class="src-var">$config</span><span class="src-sym">[</span><span class="src-var">$r</span><span class="src-sym">-></span><span class="src-id">name</span><span class="src-sym">] </span>= <span class="src-var">$r</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="a523"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a524"></a> <span class="src-key">return </span><span class="src-var">$config</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a525"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a526"></a> </div></li>
- <li><div class="src-line"><a name="a527"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a528"></a><span class="src-doc"> * Updates the last active timer on an object.</span></div></li>
- <li><div class="src-line"><a name="a529"></a><span class="src-doc"> * (Cannot be called statically... object must be authorised for this controller).</span></div></li>
- <li><div class="src-line"><a name="a530"></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">$id </span><span class="src-doc">If an integer, it is the ID of an active object. If it is a string it is the object's UUID.</span></div></li>
- <li><div class="src-line"><a name="a531"></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 not.</span></div></li>
- <li><div class="src-line"><a name="a532"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a533"></a> <span class="src-key">function </span><a href="../sloodle/SloodleController.html#methodping_object">ping_object</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="a534"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a535"></a> <span class="src-comm">// Check what type the ID is and fetch the object</span></div></li>
- <li><div class="src-line"><a name="a536"></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">$id</span><span class="src-sym">)) </span><span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'controllerid'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#methodget_id">get_id</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-str">'uuid'</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="a537"></a> <span class="src-key">else </span><span class="src-var">$entry </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">'controllerid'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#methodget_id">get_id</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span>(int)<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="a538"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$entry</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="a539"></a> </div></li>
- <li><div class="src-line"><a name="a540"></a> <span class="src-comm">// Update the record</span></div></li>
- <li><div class="src-line"><a name="a541"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">timeupdated </span>= <a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a542"></a> <span class="src-key">return </span><span class="src-id">update_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-var">$entry</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-sym">}</span></div></li>
- <li><div class="src-line"><a name="a544"></a> </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-php">?></span></div></li>
- </ol></div>
- </div>
- <p class="notes" id="credit">
- Documentation generated on Mon, 07 Jul 2008 12:32:19 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </body>
- </html>
|