| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246 |
- <?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-comm">// Process the configuration options for the Sloodle module</span></div></li>
- <li><div class="src-line"><a name="a17"></a><span class="src-comm">// $config is a reference to the submitted configuration settings</span></div></li>
- <li><div class="src-line"><a name="a18"></a><span class="src-comm">// We can perform validation and other processing here as necessary</span></div></li>
- <li><div class="src-line"><a name="a19"></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="a20"></a><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a21"></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="a22"></a> </div></li>
- <li><div class="src-line"><a name="a23"></a> <span class="src-comm">// Determine the page which we should re-direct to if validation fails</span></div></li>
- <li><div class="src-line"><a name="a24"></a> <span class="src-var">$redirect </span>= <span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">wwwroot </span>. <span class="src-str">'/admin/module.php?module=sloodle'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a25"></a> </div></li>
- <li><div class="src-line"><a name="a26"></a> <span class="src-comm">// This string will contain error codes to supply to the configuration page if validation fails</span></div></li>
- <li><div class="src-line"><a name="a27"></a> <span class="src-var">$error_codes </span>= <span class="src-str">""</span><span class="src-sym">;</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-comm">// Make sure the prim password is valid</span></div></li>
- <li><div class="src-line"><a name="a30"></a> <span class="src-var">$sloodle_pwd </span>= <span class="src-var">$config</span><span class="src-sym">-></span><span class="src-id">prim_password</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a31"></a> <span class="src-comm">// Is is an appropriate length?</span></div></li>
- <li><div class="src-line"><a name="a32"></a> <span class="src-var">$len </span>= <a href="http://www.php.net/strlen">strlen</a><span class="src-sym">(</span><span class="src-var">$sloodle_pwd</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a33"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$len </span>< <span class="src-num">5</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a34"></a> <span class="src-var">$error_codes </span>.= <span class="src-str">"&sloodlepwdshort=yes"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a35"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$len </span>> <span class="src-num">9</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a36"></a> <span class="src-var">$error_codes </span>.= <span class="src-str">"&sloodlepwdlong=yes"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a37"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a38"></a> <span class="src-comm">// Is it numeric only?</span></div></li>
- <li><div class="src-line"><a name="a39"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/ctype_digit">ctype_digit</a><span class="src-sym">(</span><span class="src-var">$sloodle_pwd</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a40"></a> <span class="src-var">$error_codes </span>.= <span class="src-str">"&sloodlepwdnonnum=yes"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a41"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a42"></a> <span class="src-comm">// Does it have a leading zero?</span></div></li>
- <li><div class="src-line"><a name="a43"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$len </span>>= <span class="src-num">1 </span>&& <a href="http://www.php.net/substr">substr</a><span class="src-sym">(</span><span class="src-var">$sloodle_pwd</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">, </span><span class="src-num">1</span><span class="src-sym">) </span>== <span class="src-str">"0"</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a44"></a> <span class="src-var">$error_codes </span>.= <span class="src-str">"&sloodlepwdleadzero=yes"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a45"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a46"></a> </div></li>
- <li><div class="src-line"><a name="a47"></a> <span class="src-comm">// Is the flag for allowing teachers to edit user data valid?</span></div></li>
- <li><div class="src-line"><a name="a48"></a> <span class="src-key">if </span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$config</span><span class="src-sym">-></span><span class="src-id">allow_user_edit_by_teachers</span><span class="src-sym">) </span>== <span class="src-id">FALSE </span>|| <span class="src-sym">(</span><span class="src-var">$config</span><span class="src-sym">-></span><span class="src-id">allow_user_edit_by_teachers </span>!= <span class="src-str">'true' </span>&& <span class="src-var">$config</span><span class="src-sym">-></span><span class="src-id">allow_user_edit_by_teachers </span>!= <span class="src-str">'false'</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a49"></a> <span class="src-comm">// Force it to a default value</span></div></li>
- <li><div class="src-line"><a name="a50"></a> <span class="src-var">$config</span><span class="src-sym">-></span><span class="src-id">allow_user_edit_by_teachers </span>= <span class="src-str">'false'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a51"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a52"></a> </div></li>
- <li><div class="src-line"><a name="a53"></a> <span class="src-comm">// Is the auth method recognised?</span></div></li>
- <li><div class="src-line"><a name="a54"></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">$config</span><span class="src-sym">-></span><span class="src-id">auth_method </span>== <span class="src-str">"web" </span>|| <span class="src-var">$config</span><span class="src-sym">-></span><span class="src-id">auth_method </span>== <span class="src-str">"autoregister"</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-var">$error_codes </span>.= <span class="src-str">"&sloodleauthinvalid=yes"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a56"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a57"></a> </div></li>
- <li><div class="src-line"><a name="a58"></a> <span class="src-comm">// Were there any error messages?</span></div></li>
- <li><div class="src-line"><a name="a59"></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">$error_codes</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a60"></a> <span class="src-comm">// Append our parameters to the error codes string</span></div></li>
- <li><div class="src-line"><a name="a61"></a> <span class="src-var">$error_codes </span>.= <span class="src-str">"</span><span class="src-str">&sloodlepwd={<span class="src-var">$config</span></span><span class="src-sym">-></span><span class="src-id">prim_password</span><span class="src-str"></span><span class="src-sym">}</span>&sloodleauth={<span class="src-var">$config</span></span><span class="src-sym">-></span><span class="src-id">auth_method</span><span class="src-str"></span><span class="src-sym">}</span></span><span class="src-str">"</span><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> <span class="src-comm">// Redirect back to the configuration page</span></div></li>
- <li><div class="src-line"><a name="a64"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><a href="http://www.php.net/headers_sent">headers_sent</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="a65"></a> <a href="http://www.php.net/header">header</a><span class="src-sym">(</span><span class="src-str">"Location: " </span>. <span class="src-var">$redirect </span>. <span class="src-var">$error_codes </span>. <span class="src-str">"&header_redirect=true"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a66"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a67"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a68"></a> <span class="src-id">redirect</span><span class="src-sym">(</span><span class="src-var">$redirect </span>. <span class="src-var">$error_codes </span>. <span class="src-str">"&header_redirect=false"</span><span class="src-sym">, </span><span class="src-str">"There was an error in the configuration. Please try again."</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a69"></a> <span class="src-key">exit</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a70"></a> <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> </div></li>
- <li><div class="src-line"><a name="a73"></a> </div></li>
- <li><div class="src-line"><a name="a74"></a><span class="src-comm">// Placeholder functions</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-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a77"></a><span class="src-doc"> * Given an object containing all the necessary data,</span></div></li>
- <li><div class="src-line"><a name="a78"></a><span class="src-doc"> * (defined by the form in mod.html) this function</span></div></li>
- <li><div class="src-line"><a name="a79"></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="a80"></a><span class="src-doc"> * of the new instance.</span></div></li>
- <li><div class="src-line"><a name="a81"></a><span class="src-doc"> * <b>Note:</b> this function is not yet used by Sloodle. Will hopefully be used in version 0.3!</span></div></li>
- <li><div class="src-line"><a name="a82"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a83"></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="a84"></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="a85"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a86"></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="a87"></a> </div></li>
- <li><div class="src-line"><a name="a88"></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="a89"></a><span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a90"></a> </div></li>
- <li><div class="src-line"><a name="a91"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a92"></a><span class="src-doc"> * Given an object containing all the necessary data,</span></div></li>
- <li><div class="src-line"><a name="a93"></a><span class="src-doc"> * (defined by the form in mod.html) this function</span></div></li>
- <li><div class="src-line"><a name="a94"></a><span class="src-doc"> * will update an existing instance with new data.</span></div></li>
- <li><div class="src-line"><a name="a95"></a><span class="src-doc"> * <b>Note:</b> this function is not yet used by Sloodle. Will hopefully be used in version 0.3!</span></div></li>
- <li><div class="src-line"><a name="a96"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a97"></a><span class="src-doc"> * </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="a98"></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="a99"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a100"></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="a101"></a> </div></li>
- <li><div class="src-line"><a name="a102"></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="a103"></a><span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a104"></a> </div></li>
- <li><div class="src-line"><a name="a105"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a106"></a><span class="src-doc"> * Given an ID of an instance of this module,</span></div></li>
- <li><div class="src-line"><a name="a107"></a><span class="src-doc"> * this function will permanently delete the instance</span></div></li>
- <li><div class="src-line"><a name="a108"></a><span class="src-doc"> * and any data that depends on it.</span></div></li>
- <li><div class="src-line"><a name="a109"></a><span class="src-doc"> * <b>Note:</b> this function is not yet used by Sloodle. Will hopefully be used in version 0.3!</span></div></li>
- <li><div class="src-line"><a name="a110"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a111"></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="a112"></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="a113"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a114"></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="a115"></a> </div></li>
- <li><div class="src-line"><a name="a116"></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="a117"></a><span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a118"></a> </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"> * Return a small object with summary information about what a</span></div></li>
- <li><div class="src-line"><a name="a121"></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="a122"></a><span class="src-doc"> * Used for user activity reports.</span></div></li>
- <li><div class="src-line"><a name="a123"></a><span class="src-doc"> * $return->time = the time they did it</span></div></li>
- <li><div class="src-line"><a name="a124"></a><span class="src-doc"> * $return->info = a short text description</span></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"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">null </span></div></li>
- <li><div class="src-line"><a name="a127"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Finish documenting this function</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/_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="a130"></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="a131"></a><span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a132"></a> </div></li>
- <li><div class="src-line"><a name="a133"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a134"></a><span class="src-doc"> * Print a detailed representation of what a user has done with</span></div></li>
- <li><div class="src-line"><a name="a135"></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="a136"></a><span class="src-doc"> *</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">boolean </span></div></li>
- <li><div class="src-line"><a name="a138"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Finish documenting this function</span></div></li>
- <li><div class="src-line"><a name="a139"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a140"></a><span class="src-key">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="a141"></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="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"> * Given a course and a time, this module should find recent activity</span></div></li>
- <li><div class="src-line"><a name="a146"></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="a147"></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="a148"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a149"></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="a150"></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="a151"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Finish documenting this function</span></div></li>
- <li><div class="src-line"><a name="a152"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a153"></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="a154"></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="a155"></a> </div></li>
- <li><div class="src-line"><a name="a156"></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="a157"></a><span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a158"></a> </div></li>
- <li><div class="src-line"><a name="a159"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a160"></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="a161"></a><span class="src-doc"> * This function searches for things that need to be done, such</span></div></li>
- <li><div class="src-line"><a name="a162"></a><span class="src-doc"> * as sending out mail, toggling flags etc ...</span></div></li>
- <li><div class="src-line"><a name="a163"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a164"></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="a165"></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="a166"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Finish documenting this function</span></div></li>
- <li><div class="src-line"><a name="a167"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a168"></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="a169"></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="a170"></a> </div></li>
- <li><div class="src-line"><a name="a171"></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="a172"></a><span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a173"></a> </div></li>
- <li><div class="src-line"><a name="a174"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a175"></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="a176"></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="a177"></a><span class="src-doc"> * </span></div></li>
- <li><div class="src-line"><a name="a178"></a><span class="src-doc"> * Example:</span></div></li>
- <li><div class="src-line"><a name="a179"></a><span class="src-doc"> * $return->grades = array of grades;</span></div></li>
- <li><div class="src-line"><a name="a180"></a><span class="src-doc"> * $return->maxgrade = maximum allowed grade;</span></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"> * return $return;</span></div></li>
- <li><div class="src-line"><a name="a183"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a184"></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="a185"></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="a186"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a187"></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="a188"></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="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"> * Must return an array of user records (all data) who are participants</span></div></li>
- <li><div class="src-line"><a name="a193"></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="a194"></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="a195"></a><span class="src-doc"> * See other modules as example.</span></div></li>
- <li><div class="src-line"><a name="a196"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a197"></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="a198"></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="a199"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a200"></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="a201"></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="a202"></a><span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a203"></a> </div></li>
- <li><div class="src-line"><a name="a204"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a205"></a><span class="src-doc"> * This function returns if a scale is being used by one sloodle</span></div></li>
- <li><div class="src-line"><a name="a206"></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="a207"></a><span class="src-doc"> * modified if necessary. See forum, glossary or journal modules</span></div></li>
- <li><div class="src-line"><a name="a208"></a><span class="src-doc"> * as reference.</span></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"> * </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="a211"></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="a212"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Finish documenting this function</span></div></li>
- <li><div class="src-line"><a name="a213"></a><span class="src-doc"> ***/</span></div></li>
- <li><div class="src-line"><a name="a214"></a><span class="src-key">function </span><a href="../sloodle/_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="a215"></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="a216"></a> </div></li>
- <li><div class="src-line"><a name="a217"></a> <span class="src-comm">//$rec = get_record("sloodle","id","$sloodleid","scale","-$scaleid");</span></div></li>
- <li><div class="src-line"><a name="a218"></a> <span class="src-comm">//</span></div></li>
- <li><div class="src-line"><a name="a219"></a> <span class="src-comm">//if (!empty($rec) && !empty($scaleid)) {</span></div></li>
- <li><div class="src-line"><a name="a220"></a> <span class="src-comm">// $return = true;</span></div></li>
- <li><div class="src-line"><a name="a221"></a> <span class="src-comm">//}</span></div></li>
- <li><div class="src-line"><a name="a222"></a> </div></li>
- <li><div class="src-line"><a name="a223"></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="a224"></a><span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a225"></a> </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-php">?></span></div></li>
- </ol></div>
- </div>
- <p class="notes" id="credit">
- Documentation generated on Tue, 04 Mar 2008 15:08:34 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </body>
- </html>
|