| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434 |
- <?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 lib.php</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- </head>
- <body>
-
<h1>Source for file lib.php</h1>
- <p>Documentation is available at <a href="../sloodle/_lib.php.html">lib.php</a></p>
- <div class="src-code">
- <div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
- <li><div class="src-line"><a name="a2"></a> </div></li>
- <li><div class="src-line"><a name="a3"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a4"></a><span class="src-doc"> * Sloodle module core library functionality.</span></div></li>
- <li><div class="src-line"><a name="a5"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a6"></a><span class="src-doc"> * This script is required by Moodle to contain certain key functionality for the module.</span></div></li>
- <li><div class="src-line"><a name="a7"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a8"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> sloodle</span></div></li>
- <li><div class="src-line"><a name="a9"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright (c) 2007 Sloodle (various contributors)</span></div></li>
- <li><div class="src-line"><a name="a10"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3</span></div></li>
- <li><div class="src-line"><a name="a11"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a12"></a><span class="src-doc"> * </span><span class="src-doc-tag">@contributor</span><span class="src-doc"> Peter R. Bloomfield</span></div></li>
- <li><div class="src-line"><a name="a13"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a14"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a15"></a> </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-var">$CFG</span><span class="src-sym">-></span><span class="src-id">dirroot</span>.<span class="src-str">'/mod/sloodle/sl_config.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-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="a18"></a> </div></li>
- <li><div class="src-line"><a name="a19"></a> </div></li>
- <li><div class="src-line"><a name="a20"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a21"></a><span class="src-doc"> * Processes the module configuration options prior to saving them.</span></div></li>
- <li><div class="src-line"><a name="a22"></a><span class="src-doc"> * Only used when the "config.html" file is used for module configuration.</span></div></li>
- <li><div class="src-line"><a name="a23"></a><span class="src-doc"> * Moodle 1.9 now prefers the "settings.php" file.</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-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">object </span><span class="src-doc-var">&$config </span><span class="src-doc">Reference to an object containing the configuration settings (can be edited)</span></div></li>
- <li><div class="src-line"><a name="a26"></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="a27"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a28"></a> <span class="src-key">function </span><a href="../sloodle/_lib.php.html#functionsloodle_process_options">sloodle_process_options</a><span class="src-sym">(</span><span class="src-sym">&</span><span class="src-var">$config</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a29"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a30"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a31"></a> </div></li>
- <li><div class="src-line"><a name="a32"></a> </div></li>
- <li><div class="src-line"><a name="a33"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a34"></a><span class="src-doc"> * Given an object containing all the necessary data,</span></div></li>
- <li><div class="src-line"><a name="a35"></a><span class="src-doc"> * (defined by the form in mod.html) this function</span></div></li>
- <li><div class="src-line"><a name="a36"></a><span class="src-doc"> * will create a new instance and return the id number</span></div></li>
- <li><div class="src-line"><a name="a37"></a><span class="src-doc"> * of the new instance.</span></div></li>
- <li><div class="src-line"><a name="a38"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a39"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">object </span><span class="src-doc-var">$instance </span><span class="src-doc">An object from the form in mod.html</span></div></li>
- <li><div class="src-line"><a name="a40"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">int </span><span class="src-doc">The id of the newly inserted sloodle record</span></div></li>
- <li><div class="src-line"><a name="a41"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a42"></a> <span class="src-key">function </span><a href="../sloodle/_lib.php.html#functionsloodle_add_instance">sloodle_add_instance</a><span class="src-sym">(</span><span class="src-var">$sloodle</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a43"></a> <span class="src-key">global </span><span class="src-var">$CFG</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a44"></a> </div></li>
- <li><div class="src-line"><a name="a45"></a> <span class="src-comm">// Set the creation and modification times</span></div></li>
- <li><div class="src-line"><a name="a46"></a> <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">timecreated </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="a47"></a> <span class="src-var">$sloodle</span><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="a48"></a> </div></li>
- <li><div class="src-line"><a name="a49"></a> <span class="src-comm">// Prefix the full type name on the instance name</span></div></li>
- <li><div class="src-line"><a name="a50"></a> <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">name </span>= <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">"</span><span class="src-str">moduletype:{<span class="src-var">$sloodle</span></span><span class="src-sym">-></span><span class="src-id">type</span><span class="src-str"></span><span class="src-sym">}</span></span><span class="src-str">"</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">) </span>. <span class="src-str">': ' </span>. <span class="src-var">$sloodle</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="a51"></a> </div></li>
- <li><div class="src-line"><a name="a52"></a> <span class="src-comm">// Attempt to insert the new Sloodle record</span></div></li>
- <li><div class="src-line"><a name="a53"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$sloodle</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'</span><span class="src-sym">, </span><span class="src-var">$sloodle</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a54"></a> <span class="src-id">error</span><span class="src-sym">(</span><span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'failedaddinstance'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a55"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a56"></a> </div></li>
- <li><div class="src-line"><a name="a57"></a> <span class="src-comm">// We need to create a new secondary table for this module</span></div></li>
- <li><div class="src-line"><a name="a58"></a> <span class="src-var">$sec_table </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="a59"></a> <span class="src-var">$sec_table</span><span class="src-sym">-></span><span class="src-id">sloodleid </span>= <span class="src-var">$sloodle</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="a60"></a> </div></li>
- <li><div class="src-line"><a name="a61"></a> <span class="src-comm">// Check the type of this module</span></div></li>
- <li><div class="src-line"><a name="a62"></a> <span class="src-var">$result </span>= <span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a63"></a> <span class="src-var">$errormsg </span>= <span class="src-str">''</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a64"></a> <span class="src-key">switch </span><span class="src-sym">(</span><span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">type</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a65"></a> <span class="src-key">case </span><span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_TYPE_CTRL">SLOODLE_TYPE_CTRL</a></span>:</div></li>
- <li><div class="src-line"><a name="a66"></a> <span class="src-comm">// Create a new controller record</span></div></li>
- <li><div class="src-line"><a name="a67"></a> <span class="src-key">if </span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">controller_enabled</span><span class="src-sym">) </span>&& <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">controller_enabled</span><span class="src-sym">) </span><span class="src-var">$sec_table</span><span class="src-sym">-></span><span class="src-id">enabled </span>= <span class="src-num">1</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a68"></a> <span class="src-key">else </span><span class="src-var">$sec_table</span><span class="src-sym">-></span><span class="src-id">enabled </span>= <span class="src-num">0</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a69"></a> <span class="src-var">$sec_table</span><span class="src-sym">-></span><span class="src-id">password </span>= <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">controller_password</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a70"></a> </div></li>
- <li><div class="src-line"><a name="a71"></a> <span class="src-comm">// Attempt to add it to the database</span></div></li>
- <li><div class="src-line"><a name="a72"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-id">insert_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_controller'</span><span class="src-sym">, </span><span class="src-var">$sec_table</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a73"></a> <span class="src-var">$errormsg </span>= <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'failedaddsecondarytable'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a74"></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="a75"></a> <span class="src-var">$result </span>= <span class="src-id">TRUE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a76"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a77"></a> <span class="src-key">break</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a78"></a> </div></li>
- <li><div class="src-line"><a name="a79"></a> <span class="src-key">case </span><span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_TYPE_DISTRIB">SLOODLE_TYPE_DISTRIB</a></span>:</div></li>
- <li><div class="src-line"><a name="a80"></a> <span class="src-comm">// Add in a default blank channel number and update time</span></div></li>
- <li><div class="src-line"><a name="a81"></a> <span class="src-var">$sec_table</span><span class="src-sym">-></span><span class="src-id">channel </span>= <span class="src-str">''</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a82"></a> <span class="src-var">$sec_table</span><span class="src-sym">-></span><span class="src-id">timeupdated </span>= <span class="src-num">0</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a83"></a> </div></li>
- <li><div class="src-line"><a name="a84"></a> <span class="src-comm">// Attempt to add it to the database</span></div></li>
- <li><div class="src-line"><a name="a85"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-id">insert_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_distributor'</span><span class="src-sym">, </span><span class="src-var">$sec_table</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a86"></a> <span class="src-var">$errormsg </span>= <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'failedaddsecondarytable'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a87"></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="a88"></a> <span class="src-var">$result </span>= <span class="src-id">TRUE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a89"></a> <span class="src-sym">} </span></div></li>
- <li><div class="src-line"><a name="a90"></a> <span class="src-key">break</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a91"></a> </div></li>
- <li><div class="src-line"><a name="a92"></a> <span class="src-comm">// ADD FURTHER MODULE TYPES HERE!</span></div></li>
- <li><div class="src-line"><a name="a93"></a> </div></li>
- <li><div class="src-line"><a name="a94"></a> <span class="src-key">default</span>:</div></li>
- <li><div class="src-line"><a name="a95"></a> <span class="src-comm">// Type not recognised</span></div></li>
- <li><div class="src-line"><a name="a96"></a> <span class="src-var">$errormsg </span>= <span class="src-id">error</span><span class="src-sym">(</span><span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'moduletypeunknown'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a97"></a> <span class="src-key">break</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a98"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a99"></a> </div></li>
- <li><div class="src-line"><a name="a100"></a> <span class="src-comm">// Was there a problem?</span></div></li>
- <li><div class="src-line"><a name="a101"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$result</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a102"></a> <span class="src-comm">// Yes</span></div></li>
- <li><div class="src-line"><a name="a103"></a> <span class="src-comm">// Delete the Sloodle instance</span></div></li>
- <li><div class="src-line"><a name="a104"></a> <span class="src-id">delete_records</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">$sloodle</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="a105"></a> </div></li>
- <li><div class="src-line"><a name="a106"></a> <span class="src-comm">// Show the error message (if there was one)</span></div></li>
- <li><div class="src-line"><a name="a107"></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">$errormsg</span><span class="src-sym">)) </span><span class="src-id">error</span><span class="src-sym">(</span><span class="src-var">$errormsg</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a108"></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="a109"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a110"></a> </div></li>
- <li><div class="src-line"><a name="a111"></a> <span class="src-comm">// Success!</span></div></li>
- <li><div class="src-line"><a name="a112"></a> <span class="src-key">return </span><span class="src-var">$sloodle</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="a113"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a114"></a> </div></li>
- <li><div class="src-line"><a name="a115"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a116"></a><span class="src-doc"> * Given an object containing all the necessary data,</span></div></li>
- <li><div class="src-line"><a name="a117"></a><span class="src-doc"> * (defined by the form in mod.html) this function</span></div></li>
- <li><div class="src-line"><a name="a118"></a><span class="src-doc"> * will update an existing instance with new data.</span></div></li>
- <li><div class="src-line"><a name="a119"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a120"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">object </span><span class="src-doc-var">$instance </span><span class="src-doc">An object from the form in mod.html</span></div></li>
- <li><div class="src-line"><a name="a121"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span><span class="src-doc">Success/Fail</span></div></li>
- <li><div class="src-line"><a name="a122"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a123"></a> <span class="src-key">function </span><a href="../sloodle/_lib.php.html#functionsloodle_update_instance">sloodle_update_instance</a><span class="src-sym">(</span><span class="src-var">$sloodle</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a124"></a> <span class="src-key">global </span><span class="src-var">$CFG</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a125"></a> </div></li>
- <li><div class="src-line"><a name="a126"></a> <span class="src-comm">// Update the modification time</span></div></li>
- <li><div class="src-line"><a name="a127"></a> <span class="src-var">$sloodle</span><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="a128"></a> <span class="src-comm">// Make sure the ID is correct for update</span></div></li>
- <li><div class="src-line"><a name="a129"></a> <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">id </span>= <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">instance</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a130"></a> </div></li>
- <li><div class="src-line"><a name="a131"></a> <span class="src-comm">// Make sure the type is the same as the existing record</span></div></li>
- <li><div class="src-line"><a name="a132"></a> <span class="src-var">$existing_record </span>= <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">$sloodle</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="a133"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$existing_record</span><span class="src-sym">) </span><span class="src-id">error</span><span class="src-sym">(</span><span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'modulenotfound'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a134"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$existing_record</span><span class="src-sym">-></span><span class="src-id">type </span>!= <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">type</span><span class="src-sym">) </span><span class="src-id">error</span><span class="src-sym">(</span><span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'moduletypemismatch'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a135"></a> </div></li>
- <li><div class="src-line"><a name="a136"></a> <span class="src-comm">// Check the type of this module</span></div></li>
- <li><div class="src-line"><a name="a137"></a> <span class="src-key">switch </span><span class="src-sym">(</span><span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">type</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a138"></a> <span class="src-key">case </span><span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_TYPE_CTRL">SLOODLE_TYPE_CTRL</a></span>:</div></li>
- <li><div class="src-line"><a name="a139"></a> <span class="src-comm">// Attempt to fetch the controller record</span></div></li>
- <li><div class="src-line"><a name="a140"></a> <span class="src-var">$ctrl </span>= <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">$sloodle</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="a141"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$ctrl</span><span class="src-sym">) </span><span class="src-id">error</span><span class="src-sym">(</span><span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'secondarytablenotfound'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a142"></a> </div></li>
- <li><div class="src-line"><a name="a143"></a> <span class="src-comm">// Add the updated 'enabled' value</span></div></li>
- <li><div class="src-line"><a name="a144"></a> <span class="src-key">if </span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">controller_enabled</span><span class="src-sym">) </span>&& <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">controller_enabled</span><span class="src-sym">) </span><span class="src-var">$ctrl</span><span class="src-sym">-></span><span class="src-id">enabled </span>= <span class="src-num">1</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a145"></a> <span class="src-key">else </span><span class="src-var">$ctrl</span><span class="src-sym">-></span><span class="src-id">enabled </span>= <span class="src-num">0</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a146"></a> <span class="src-comm">// Add the updated password</span></div></li>
- <li><div class="src-line"><a name="a147"></a> <span class="src-var">$ctrl</span><span class="src-sym">-></span><span class="src-id">password </span>= <span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">controller_password</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a148"></a> </div></li>
- <li><div class="src-line"><a name="a149"></a> </div></li>
- <li><div class="src-line"><a name="a150"></a> <span class="src-comm">// Update the database</span></div></li>
- <li><div class="src-line"><a name="a151"></a> <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">$ctrl</span><span class="src-sym">)</span><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-key">break</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a154"></a> </div></li>
- <li><div class="src-line"><a name="a155"></a> <span class="src-key">case </span><span class="src-id"><a href="../sloodle/_sl_config.php.html#defineSLOODLE_TYPE_DISTRIB">SLOODLE_TYPE_DISTRIB</a></span>:</div></li>
- <li><div class="src-line"><a name="a156"></a> <span class="src-comm">// Attempt to fetch the distributor record</span></div></li>
- <li><div class="src-line"><a name="a157"></a> <span class="src-var">$distrib </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_distributor'</span><span class="src-sym">, </span><span class="src-str">'sloodleid'</span><span class="src-sym">, </span><span class="src-var">$sloodle</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="a158"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$distrib</span><span class="src-sym">) </span><span class="src-id">error</span><span class="src-sym">(</span><span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'secondarytablenotfound'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a159"></a> </div></li>
- <li><div class="src-line"><a name="a160"></a> <span class="src-comm">// Has a reset been requested?</span></div></li>
- <li><div class="src-line"><a name="a161"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$sloodle</span><span class="src-sym">-></span><span class="src-id">distributor_reset</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a162"></a> <span class="src-comm">// Yes - clear the distributor channel</span></div></li>
- <li><div class="src-line"><a name="a163"></a> <span class="src-var">$distrib</span><span class="src-sym">-></span><span class="src-id">channel </span>= <span class="src-str">''</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a164"></a> </div></li>
- <li><div class="src-line"><a name="a165"></a> <span class="src-comm">// Delete all objects associated with the Distributor</span></div></li>
- <li><div class="src-line"><a name="a166"></a> <span class="src-id">delete_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_distributor_entry'</span><span class="src-sym">, </span><span class="src-str">'distributorid'</span><span class="src-sym">, </span><span class="src-var">$distrib</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="a167"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a168"></a> </div></li>
- <li><div class="src-line"><a name="a169"></a> </div></li>
- <li><div class="src-line"><a name="a170"></a> <span class="src-comm">// Update the database</span></div></li>
- <li><div class="src-line"><a name="a171"></a> <span class="src-id">update_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_distributor'</span><span class="src-sym">, </span><span class="src-var">$distrib</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a172"></a> </div></li>
- <li><div class="src-line"><a name="a173"></a> <span class="src-key">break</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a174"></a> </div></li>
- <li><div class="src-line"><a name="a175"></a> <span class="src-comm">// ADD FURTHER MODULE TYPES HERE!</span></div></li>
- <li><div class="src-line"><a name="a176"></a> </div></li>
- <li><div class="src-line"><a name="a177"></a> <span class="src-key">default</span>:</div></li>
- <li><div class="src-line"><a name="a178"></a> <span class="src-comm">// Type not recognised</span></div></li>
- <li><div class="src-line"><a name="a179"></a> <span class="src-id">error</span><span class="src-sym">(</span><span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'moduletypeunknown'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a180"></a> <span class="src-key">break</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a181"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a182"></a> </div></li>
- <li><div class="src-line"><a name="a183"></a> <span class="src-comm">// Attempt the update</span></div></li>
- <li><div class="src-line"><a name="a184"></a> <span class="src-key">return </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">$sloodle</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a185"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a186"></a> </div></li>
- <li><div class="src-line"><a name="a187"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a188"></a><span class="src-doc"> * Given an ID of an instance of this module,</span></div></li>
- <li><div class="src-line"><a name="a189"></a><span class="src-doc"> * this function will permanently delete the instance</span></div></li>
- <li><div class="src-line"><a name="a190"></a><span class="src-doc"> * and any data that depends on it.</span></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"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc-var">$id </span><span class="src-doc">Id of the module instance</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">boolean </span><span class="src-doc">Success/Failure</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/_lib.php.html#functionsloodle_delete_instance">sloodle_delete_instance</a><span class="src-sym">(</span><span class="src-var">$id</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a196"></a> </div></li>
- <li><div class="src-line"><a name="a197"></a> <span class="src-comm">// Determine our success or otherwise</span></div></li>
- <li><div class="src-line"><a name="a198"></a> <span class="src-var">$result </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a199"></a> </div></li>
- <li><div class="src-line"><a name="a200"></a> <span class="src-comm">// Attempt to delete the main Sloodle instance</span></div></li>
- <li><div class="src-line"><a name="a201"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-id">delete_records</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">$id</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a202"></a> <span class="src-var">$result </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a203"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a204"></a> </div></li>
- <li><div class="src-line"><a name="a205"></a> <span class="src-comm">// Delete any secondary controller tables</span></div></li>
- <li><div class="src-line"><a name="a206"></a> <span class="src-id">delete_records</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">$id</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a207"></a> </div></li>
- <li><div class="src-line"><a name="a208"></a> <span class="src-comm">// Attempt to get any secondary distributor tables</span></div></li>
- <li><div class="src-line"><a name="a209"></a> <span class="src-var">$distribs </span>= <span class="src-id">get_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_distributor'</span><span class="src-sym">, </span><span class="src-str">'sloodleid'</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="a210"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_array">is_array</a><span class="src-sym">(</span><span class="src-var">$distribs</span><span class="src-sym">) </span>&& <a href="http://www.php.net/count">count</a><span class="src-sym">(</span><span class="src-var">$distribs</span><span class="src-sym">) </span>> <span class="src-num">0</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a211"></a> <span class="src-comm">// Go through each distributor</span></div></li>
- <li><div class="src-line"><a name="a212"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$distribs </span><span class="src-key">as </span><span class="src-var">$d</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a213"></a> <span class="src-comm">// Delete any related distributor entries</span></div></li>
- <li><div class="src-line"><a name="a214"></a> <span class="src-id">delete_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_distributor_entry'</span><span class="src-sym">, </span><span class="src-str">'distributorid'</span><span class="src-sym">, </span><span class="src-var">$d</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="a215"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a216"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a217"></a> <span class="src-comm">// Delete all the distributors</span></div></li>
- <li><div class="src-line"><a name="a218"></a> <span class="src-id">delete_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_distributor'</span><span class="src-sym">, </span><span class="src-str">'sloodleid'</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="a219"></a> </div></li>
- <li><div class="src-line"><a name="a220"></a> </div></li>
- <li><div class="src-line"><a name="a221"></a> <span class="src-comm">// ADD FURTHER MODULE TYPES HERE!</span></div></li>
- <li><div class="src-line"><a name="a222"></a> </div></li>
- <li><div class="src-line"><a name="a223"></a> </div></li>
- <li><div class="src-line"><a name="a224"></a> <span class="src-key">return </span><span class="src-var">$result</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a225"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a226"></a> </div></li>
- <li><div class="src-line"><a name="a227"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a228"></a><span class="src-doc"> * Return a small object with summary information about what a</span></div></li>
- <li><div class="src-line"><a name="a229"></a><span class="src-doc"> * user has done with a given particular instance of this module</span></div></li>
- <li><div class="src-line"><a name="a230"></a><span class="src-doc"> * Used for user activity reports.</span></div></li>
- <li><div class="src-line"><a name="a231"></a><span class="src-doc"> * $return->time = the time they did it</span></div></li>
- <li><div class="src-line"><a name="a232"></a><span class="src-doc"> * $return->info = a short text description</span></div></li>
- <li><div class="src-line"><a name="a233"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a234"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">null </span></div></li>
- <li><div class="src-line"><a name="a235"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Do we need this function to do anything?</span></div></li>
- <li><div class="src-line"><a name="a236"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a237"></a> <span class="src-key">function </span><a href="../sloodle/_lib.php.html#functionsloodle_user_outline">sloodle_user_outline</a><span class="src-sym">(</span><span class="src-var">$course</span><span class="src-sym">, </span><span class="src-var">$user</span><span class="src-sym">, </span><span class="src-var">$mod</span><span class="src-sym">, </span><span class="src-var">$sloodle</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a238"></a> <span class="src-key">return </span><span class="src-id">NULL</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a239"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a240"></a> </div></li>
- <li><div class="src-line"><a name="a241"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a242"></a><span class="src-doc"> * Print a detailed representation of what a user has done with</span></div></li>
- <li><div class="src-line"><a name="a243"></a><span class="src-doc"> * a given particular instance of this module, for user activity reports.</span></div></li>
- <li><div class="src-line"><a name="a244"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a245"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span></div></li>
- <li><div class="src-line"><a name="a246"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Do we need this function to do anything?</span></div></li>
- <li><div class="src-line"><a name="a247"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a248"></a> <span class="src-key">function </span><a href="../sloodle/_lib.php.html#functionsloodle_user_complete">sloodle_user_complete</a><span class="src-sym">(</span><span class="src-var">$course</span><span class="src-sym">, </span><span class="src-var">$user</span><span class="src-sym">, </span><span class="src-var">$mod</span><span class="src-sym">, </span><span class="src-var">$sloodle</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a249"></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="a250"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a251"></a> </div></li>
- <li><div class="src-line"><a name="a252"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a253"></a><span class="src-doc"> * Given a course and a time, this module should find recent activity</span></div></li>
- <li><div class="src-line"><a name="a254"></a><span class="src-doc"> * that has occurred in sloodle activities and print it out.</span></div></li>
- <li><div class="src-line"><a name="a255"></a><span class="src-doc"> * Return true if there was output, or false is there was none.</span></div></li>
- <li><div class="src-line"><a name="a256"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a257"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@uses</span><span class="src-doc"> $CFG</span></div></li>
- <li><div class="src-line"><a name="a258"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span></div></li>
- <li><div class="src-line"><a name="a259"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Figure out if we need this function to do anything!</span></div></li>
- <li><div class="src-line"><a name="a260"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a261"></a> <span class="src-key">function </span><a href="../sloodle/_lib.php.html#functionsloodle_print_recent_activity">sloodle_print_recent_activity</a><span class="src-sym">(</span><span class="src-var">$course</span><span class="src-sym">, </span><span class="src-var">$isteacher</span><span class="src-sym">, </span><span class="src-var">$timestart</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a262"></a> <span class="src-key">global </span><span class="src-var">$CFG</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a263"></a> </div></li>
- <li><div class="src-line"><a name="a264"></a> <span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">; </span><span class="src-comm">// True if anything was printed, otherwise false </span></div></li>
- <li><div class="src-line"><a name="a265"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a266"></a> </div></li>
- <li><div class="src-line"><a name="a267"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a268"></a><span class="src-doc"> * Function to be run periodically according to the Moodle cron.</span></div></li>
- <li><div class="src-line"><a name="a269"></a><span class="src-doc"> * Clears out expired pending user entries, session keys, etc.</span></div></li>
- <li><div class="src-line"><a name="a270"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a271"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span></div></li>
- <li><div class="src-line"><a name="a272"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Delete expired user entries</span></div></li>
- <li><div class="src-line"><a name="a273"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Use a custom delay for expiries of users/objects</span></div></li>
- <li><div class="src-line"><a name="a274"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a275"></a> <span class="src-key">function </span><a href="../sloodle/_lib.php.html#functionsloodle_cron">sloodle_cron</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="a276"></a> echo <span class="src-str">"\nProcessing Sloodle cron tasks:\n"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a277"></a> </div></li>
- <li><div class="src-line"><a name="a278"></a> <span class="src-comm">// Delete any pending user entries which have expired (more than 30 minutes old)</span></div></li>
- <li><div class="src-line"><a name="a279"></a> <span class="src-var">$expirytime </span>= <a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">) </span>- <span class="src-num">1800</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a280"></a> echo <span class="src-str">"Removing expired pending avatar entries...\n"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a281"></a> <span class="src-id">delete_records_select</span><span class="src-sym">(</span><span class="src-str">'sloodle_pending_avatars'</span><span class="src-sym">, </span><span class="src-str">"</span><span class="src-str">timeupdated < <span class="src-var">$expirytime</span></span><span class="src-str">"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a282"></a> </div></li>
- <li><div class="src-line"><a name="a283"></a> <span class="src-comm">// Delete any LoginZone allocations which have expired (more than 15 minutes old)</span></div></li>
- <li><div class="src-line"><a name="a284"></a> <span class="src-var">$expirytime </span>= <a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">) </span>- <span class="src-num">900</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a285"></a> echo <span class="src-str">"Removing expired LoginZone allocations...\n"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a286"></a> <span class="src-id">delete_records_select</span><span class="src-sym">(</span><span class="src-str">'sloodle_loginzone_allocation'</span><span class="src-sym">, </span><span class="src-str">"</span><span class="src-str">timecreated < <span class="src-var">$expirytime</span></span><span class="src-str">"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a287"></a> </div></li>
- <li><div class="src-line"><a name="a288"></a> <span class="src-comm">// Fetch our configuration settings, if they exist</span></div></li>
- <li><div class="src-line"><a name="a289"></a> <span class="src-var">$active_object_days </span>= <span class="src-num">7</span><span class="src-sym">; </span><span class="src-comm">// Give active objects a week by default</span></div></li>
- <li><div class="src-line"><a name="a290"></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">$CFG</span><span class="src-sym">-></span><span class="src-id">sloodle_active_object_lifetime</span><span class="src-sym">)) </span><span class="src-var">$active_object_days </span>= <span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">sloodle_active_object_lifetime</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a291"></a> <span class="src-var">$user_object_days </span>= <span class="src-num">21</span><span class="src-sym">; </span><span class="src-comm">// Give user objects 3 weeks by default</span></div></li>
- <li><div class="src-line"><a name="a292"></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">$CFG</span><span class="src-sym">-></span><span class="src-id">sloodle_user_object_lifetime</span><span class="src-sym">)) </span><span class="src-var">$user_object_days </span>= <span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">sloodle_user_object_lifetime</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a293"></a> </div></li>
- <li><div class="src-line"><a name="a294"></a> <span class="src-comm">// Delete any active objects and session keys which have expired</span></div></li>
- <li><div class="src-line"><a name="a295"></a> <span class="src-comm">// Deletes any authorised objects which have not checked-in for more than X days (where X is specified in module config)</span></div></li>
- <li><div class="src-line"><a name="a296"></a> <span class="src-comm">// Deletes any unauthorised objects which have not checked-in for more than 1 hour</span></div></li>
- <li><div class="src-line"><a name="a297"></a> <span class="src-var">$expirytime_auth </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><span class="src-num">86400 </span>* <span class="src-var">$active_object_days</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a298"></a> <span class="src-var">$expirytime_unauth </span>= <a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">) </span>- <span class="src-num">3600</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a299"></a> echo <span class="src-str">"Searching for expired active objects...\n"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a300"></a> <span class="src-var">$recs </span>= <span class="src-id">get_records_select</span><span class="src-sym">(</span><span class="src-str">'sloodle_active_object'</span><span class="src-sym">, </span><span class="src-str">"</span><span class="src-str">(((controllerid = 0 AND userid = 0) OR type = '') AND timeupdated < <span class="src-var">$expirytime_unauth</span>) OR timeupdated < <span class="src-var">$expirytime_auth</span></span><span class="src-str">"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a301"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$recs</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a302"></a> <span class="src-comm">// Go through each object</span></div></li>
- <li><div class="src-line"><a name="a303"></a> echo <span class="src-str">"Removing " </span>. <a href="http://www.php.net/count">count</a><span class="src-sym">(</span><span class="src-var">$recs</span><span class="src-sym">) </span>. <span class="src-str">" expired active objects and associated configuration settings...\n"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a304"></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="a305"></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">$r</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="a306"></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">$r</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="a307"></a> <span class="src-sym">} </span></div></li>
- <li><div class="src-line"><a name="a308"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a309"></a> </div></li>
- <li><div class="src-line"><a name="a310"></a> <span class="src-comm">// Delete any user-authorised objects which have expired</span></div></li>
- <li><div class="src-line"><a name="a311"></a> <span class="src-comm">// (will eventually use custom expiry times, chosen in the configuration)</span></div></li>
- <li><div class="src-line"><a name="a312"></a> <span class="src-comm">// Deletes any authorised objects which have not checked-in for more than X days (where X is specified in module config)</span></div></li>
- <li><div class="src-line"><a name="a313"></a> <span class="src-comm">// Deletes any unauthorised objects which have not checked-in for more than 1 hour</span></div></li>
- <li><div class="src-line"><a name="a314"></a> <span class="src-var">$expirytime_auth </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><span class="src-num">86400 </span>* <span class="src-var">$user_object_days</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a315"></a> <span class="src-var">$expirytime_unauth </span>= <a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">) </span>- <span class="src-num">3600</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a316"></a> echo <span class="src-str">"Deleting expired user objects...\n"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a317"></a> <span class="src-id">delete_records_select</span><span class="src-sym">(</span><span class="src-str">'sloodle_user_object'</span><span class="src-sym">, </span><span class="src-str">"</span><span class="src-str">(authorised = 0 AND timeupdated < <span class="src-var">$expirytime_unauth</span>) OR timeupdated < <span class="src-var">$expirytime_auth</span></span><span class="src-str">"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a318"></a> </div></li>
- <li><div class="src-line"><a name="a319"></a> <span class="src-comm">// More stuff?</span></div></li>
- <li><div class="src-line"><a name="a320"></a> <span class="src-comm">//...</span></div></li>
- <li><div class="src-line"><a name="a321"></a> </div></li>
- <li><div class="src-line"><a name="a322"></a> <span class="src-comm">// Email login details to auto-registered avatars in-world</span></div></li>
- <li><div class="src-line"><a name="a323"></a> echo <span class="src-str">"Sending out login notifications...\n"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a324"></a> <a href="../sloodle/_lib---general.php.html#functionsloodle_process_login_notifications">sloodle_process_login_notifications</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="a325"></a> </div></li>
- <li><div class="src-line"><a name="a326"></a> echo <span class="src-str">"Done processing Sloodle cron tasks.\n\n"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a327"></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="a328"></a> <span class="src-sym">}</span></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"> * Must return an array of grades for a given instance of this module,</span></div></li>
- <li><div class="src-line"><a name="a332"></a><span class="src-doc"> * indexed by user. It also returns a maximum allowed grade.</span></div></li>
- <li><div class="src-line"><a name="a333"></a><span class="src-doc"> * </span></div></li>
- <li><div class="src-line"><a name="a334"></a><span class="src-doc"> * Example:</span></div></li>
- <li><div class="src-line"><a name="a335"></a><span class="src-doc"> * $return->grades = array of grades;</span></div></li>
- <li><div class="src-line"><a name="a336"></a><span class="src-doc"> * $return->maxgrade = maximum allowed grade;</span></div></li>
- <li><div class="src-line"><a name="a337"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a338"></a><span class="src-doc"> * return $return;</span></div></li>
- <li><div class="src-line"><a name="a339"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a340"></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">$sloodleid </span><span class="src-doc">ID of an instance of this module</span></div></li>
- <li><div class="src-line"><a name="a341"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">Null or object with an array of grades and with the maximum grade</span></div></li>
- <li><div class="src-line"><a name="a342"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a343"></a> <span class="src-key">function </span><a href="../sloodle/_lib.php.html#functionsloodle_grades">sloodle_grades</a><span class="src-sym">(</span><span class="src-var">$sloodleid</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a344"></a> <span class="src-key">return </span><span class="src-id">NULL</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a345"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a346"></a> </div></li>
- <li><div class="src-line"><a name="a347"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a348"></a><span class="src-doc"> * Must return an array of user records (all data) who are participants</span></div></li>
- <li><div class="src-line"><a name="a349"></a><span class="src-doc"> * for a given instance of sloodle. Must include every user involved</span></div></li>
- <li><div class="src-line"><a name="a350"></a><span class="src-doc"> * in the instance, independient of his role (student, teacher, admin...)</span></div></li>
- <li><div class="src-line"><a name="a351"></a><span class="src-doc"> * See other modules as example.</span></div></li>
- <li><div class="src-line"><a name="a352"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a353"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc-var">$sloodleid </span><span class="src-doc">ID of an instance of this module</span></div></li>
- <li><div class="src-line"><a name="a354"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">boolean/array of students</span></div></li>
- <li><div class="src-line"><a name="a355"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Possibly make it return a list of users registered via the Sloodle instance?</span></div></li>
- <li><div class="src-line"><a name="a356"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a357"></a> <span class="src-key">function </span><a href="../sloodle/_lib.php.html#functionsloodle_get_participants">sloodle_get_participants</a><span class="src-sym">(</span><span class="src-var">$sloodleid</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a358"></a> <span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a359"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a360"></a> </div></li>
- <li><div class="src-line"><a name="a361"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a362"></a><span class="src-doc"> * This function returns if a scale is being used by one sloodle</span></div></li>
- <li><div class="src-line"><a name="a363"></a><span class="src-doc"> * it it has support for grading and scales. Commented code should be</span></div></li>
- <li><div class="src-line"><a name="a364"></a><span class="src-doc"> * modified if necessary. See forum, glossary or journal modules</span></div></li>
- <li><div class="src-line"><a name="a365"></a><span class="src-doc"> * as reference.</span></div></li>
- <li><div class="src-line"><a name="a366"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a367"></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">$sloodleid </span><span class="src-doc">ID of an instance of this module</span></div></li>
- <li><div class="src-line"><a name="a368"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span></div></li>
- <li><div class="src-line"><a name="a369"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a370"></a> <span class="src-key">function </span><a href="../sloodle/_lib.php.html#functionsloodle_scale_used">sloodle_scale_used</a> <span class="src-sym">(</span><span class="src-var">$sloodleid</span><span class="src-sym">,</span><span class="src-var">$scaleid</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a371"></a> <span class="src-var">$return </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a372"></a> </div></li>
- <li><div class="src-line"><a name="a373"></a> <span class="src-key">return </span><span class="src-var">$return</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a374"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a375"></a> </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"> * Gets the different sub-types of Sloodle module available as a list for the "Add Activity..." menu.</span></div></li>
- <li><div class="src-line"><a name="a379"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a380"></a><span class="src-doc"> * $return array Entries for the "Add Activity..." sub-menu for Sloodle</span></div></li>
- <li><div class="src-line"><a name="a381"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a382"></a> </div></li>
- <li><div class="src-line"><a name="a383"></a> <span class="src-key">function </span><a href="../sloodle/_lib.php.html#functionsloodle_get_types">sloodle_get_types</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="a384"></a> <span class="src-key">global </span><span class="src-var">$CFG</span><span class="src-sym">, </span><span class="src-var">$SLOODLE_TYPES</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a385"></a> <span class="src-var">$types </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="a386"></a> </div></li>
- <li><div class="src-line"><a name="a387"></a> <span class="src-comm">// Start the group</span></div></li>
- <li><div class="src-line"><a name="a388"></a> <span class="src-var">$type </span>= <span class="src-key">new </span><span class="src-id">object</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="a389"></a> <span class="src-var">$type</span><span class="src-sym">-></span><span class="src-id">modclass </span>= <span class="src-id">MOD_CLASS_ACTIVITY</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a390"></a> <span class="src-var">$type</span><span class="src-sym">-></span><span class="src-id">type </span>= <span class="src-str">"sloodle_group_start"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a391"></a> <span class="src-var">$type</span><span class="src-sym">-></span><span class="src-id">typestr </span>= <span class="src-str">'--'</span>.<span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">'modulenameplural'</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a392"></a> <span class="src-var">$types</span><span class="src-sym">[</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="a393"></a> </div></li>
- <li><div class="src-line"><a name="a394"></a> <span class="src-comm">// Go through each Sloodle module type, and add it</span></div></li>
- <li><div class="src-line"><a name="a395"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$SLOODLE_TYPES </span><span class="src-key">as </span><span class="src-var">$st</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a396"></a> <span class="src-var">$type </span>= <span class="src-key">new </span><span class="src-id">object</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="a397"></a> <span class="src-var">$type</span><span class="src-sym">-></span><span class="src-id">modclass </span>= <span class="src-id">MOD_CLASS_ACTIVITY</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a398"></a> <span class="src-var">$type</span><span class="src-sym">-></span><span class="src-id">type </span>= <span class="src-str">"</span><span class="src-str">sloodle&amp;type=<span class="src-var">$st</span></span><span class="src-str">"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a399"></a> <span class="src-var">$type</span><span class="src-sym">-></span><span class="src-id">typestr </span>= <span class="src-id">get_string</span><span class="src-sym">(</span><span class="src-str">"</span><span class="src-str">moduletype:<span class="src-var">$st</span></span><span class="src-str">"</span><span class="src-sym">, </span><span class="src-str">'sloodle'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a400"></a> <span class="src-var">$types</span><span class="src-sym">[</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="a401"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a402"></a> </div></li>
- <li><div class="src-line"><a name="a403"></a> <span class="src-comm">// End the group</span></div></li>
- <li><div class="src-line"><a name="a404"></a> <span class="src-var">$type </span>= <span class="src-key">new </span><span class="src-id">object</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="a405"></a> <span class="src-var">$type</span><span class="src-sym">-></span><span class="src-id">modclass </span>= <span class="src-id">MOD_CLASS_ACTIVITY</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a406"></a> <span class="src-var">$type</span><span class="src-sym">-></span><span class="src-id">type </span>= <span class="src-str">"sloodle_group_end"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a407"></a> <span class="src-var">$type</span><span class="src-sym">-></span><span class="src-id">typestr </span>= <span class="src-str">'--'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a408"></a> <span class="src-var">$types</span><span class="src-sym">[</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="a409"></a> </div></li>
- <li><div class="src-line"><a name="a410"></a> <span class="src-key">return </span><span class="src-var">$types</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a411"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a412"></a> </div></li>
- <li><div class="src-line"><a name="a413"></a> </div></li>
- <li><div class="src-line"><a name="a414"></a> </div></li>
- <li><div class="src-line"><a name="a415"></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:36 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </body>
- </html>
|