| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668 |
- <?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 course.php</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- </head>
- <body>
-
<h1>Source for file course.php</h1>
- <p>Documentation is available at <a href="../sloodle/_sloodle---lib---course.php.html">course.php</a></p>
- <div class="src-code">
- <div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
- <li><div class="src-line"><a name="a2"></a> <span class="src-comm">// This file is part of the Sloodle project (www.sloodle.org)</span></div></li>
- <li><div class="src-line"><a name="a3"></a> </div></li>
- <li><div class="src-line"><a name="a4"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a5"></a><span class="src-doc"> * This file defines a structure for Sloodle data about a particular Moodle course.</span></div></li>
- <li><div class="src-line"><a name="a6"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a7"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> sloodle</span></div></li>
- <li><div class="src-line"><a name="a8"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright (c) 2008 Sloodle (various contributors)</span></div></li>
- <li><div class="src-line"><a name="a9"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3</span></div></li>
- <li><div class="src-line"><a name="a10"></a><span class="src-doc"> *</span></div></li>
- <li><div class="src-line"><a name="a11"></a><span class="src-doc"> * </span><span class="src-doc-tag">@contributor</span><span class="src-doc"> Peter R. Bloomfield</span></div></li>
- <li><div class="src-line"><a name="a12"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a13"></a> </div></li>
- <li><div class="src-line"><a name="a14"></a> </div></li>
- <li><div class="src-line"><a name="a15"></a> <span class="src-doc">/** Include the general Sloodle library. */</span></div></li>
- <li><div class="src-line"><a name="a16"></a> <span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">SLOODLE_LIBROOT</span>.<span class="src-str">'/general.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a17"></a> <span class="src-doc">/** Include the Sloodle controller structure. */</span></div></li>
- <li><div class="src-line"><a name="a18"></a> <span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">SLOODLE_LIBROOT</span>.<span class="src-str">'/controller.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a19"></a> <span class="src-doc">/** Include the layout profile management stuff. */</span></div></li>
- <li><div class="src-line"><a name="a20"></a> <span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-id">SLOODLE_LIBROOT</span>.<span class="src-str">'/layout_profile.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a21"></a> </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-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a24"></a><span class="src-doc"> * The Sloodle course data class</span></div></li>
- <li><div class="src-line"><a name="a25"></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="a26"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a27"></a> <span class="src-key">class </span><a href="../sloodle/SloodleCourse.html">SloodleCourse</a></div></li>
- <li><div class="src-line"><a name="a28"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a29"></a> <span class="src-comm">// DATA //</span></div></li>
- <li><div class="src-line"><a name="a30"></a> </div></li>
- <li><div class="src-line"><a name="a31"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a32"></a><span class="src-doc"> * The database object of the course to which this object relates.</span></div></li>
- <li><div class="src-line"><a name="a33"></a><span class="src-doc"> * Corresponds to the "course" table in Moodle.</span></div></li>
- <li><div class="src-line"><a name="a34"></a><span class="src-doc"> * Is null if not yet set</span></div></li>
- <li><div class="src-line"><a name="a35"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">object </span></div></li>
- <li><div class="src-line"><a name="a36"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> private</span></div></li>
- <li><div class="src-line"><a name="a37"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a38"></a> <span class="src-key">var </span><a href="../sloodle/SloodleCourse.html#var$course_object">$course_object</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a39"></a> </div></li>
- <li><div class="src-line"><a name="a40"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a41"></a><span class="src-doc"> * The Sloodle course data object, if it exists.</span></div></li>
- <li><div class="src-line"><a name="a42"></a><span class="src-doc"> * Is null if not yet set.</span></div></li>
- <li><div class="src-line"><a name="a43"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">object </span></div></li>
- <li><div class="src-line"><a name="a44"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">private </span></div></li>
- <li><div class="src-line"><a name="a45"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a46"></a> <span class="src-key">var </span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">$sloodle_course_data</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a47"></a> </div></li>
- <li><div class="src-line"><a name="a48"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a49"></a><span class="src-doc"> * The </span><span class="src-doc-inlinetag">{@link SloodleController}</span><span class="src-doc"> object being used to access this course, if available.</span></div></li>
- <li><div class="src-line"><a name="a50"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">SloodleController </span></div></li>
- <li><div class="src-line"><a name="a51"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">public </span></div></li>
- <li><div class="src-line"><a name="a52"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a53"></a> <span class="src-key">var </span><a href="../sloodle/SloodleCourse.html#var$controller">$controller</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a54"></a> </div></li>
- <li><div class="src-line"><a name="a55"></a> </div></li>
- <li><div class="src-line"><a name="a56"></a> <span class="src-comm">// FUNCTIONS //</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-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a59"></a><span class="src-doc"> * Constructor</span></div></li>
- <li><div class="src-line"><a name="a60"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a61"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodSloodleCourse">SloodleCourse</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a62"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a63"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$controller">controller</a> = <span class="src-key">new </span><span class="src-id"><a href="../sloodle/SloodleController.html">SloodleController</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a64"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a65"></a> </div></li>
- <li><div class="src-line"><a name="a66"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a67"></a><span class="src-doc"> * Determines whether or not course data has been loaded.</span></div></li>
- <li><div class="src-line"><a name="a68"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
- <li><div class="src-line"><a name="a69"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a70"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodis_loaded">is_loaded</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a71"></a> <span class="src-sym">{</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-key">empty</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">) </span>|| <span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a73"></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="a74"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a75"></a> </div></li>
- <li><div class="src-line"><a name="a76"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a77"></a><span class="src-doc"> * Gets the identifier of the course in the VLE.</span></div></li>
- <li><div class="src-line"><a name="a78"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</span></div></li>
- <li><div class="src-line"><a name="a79"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a80"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodget_course_id">get_course_id</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a81"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a82"></a> <span class="src-key">return </span>(int)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a83"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a84"></a> </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-doc"> * Gets the VLE course object.</span></div></li>
- <li><div class="src-line"><a name="a87"></a><span class="src-doc"> * WARNING: this should only be used when ABSOLUTELY necessary.</span></div></li>
- <li><div class="src-line"><a name="a88"></a><span class="src-doc"> * The contents are specific to the VLE.</span></div></li>
- <li><div class="src-line"><a name="a89"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc">Type and content depends upon VLE. In Moodle, it is an object representing a record from the 'course' table.</span></div></li>
- <li><div class="src-line"><a name="a90"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a91"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodget_course_object">get_course_object</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a92"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a93"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a94"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a95"></a> </div></li>
- <li><div class="src-line"><a name="a96"></a> </div></li>
- <li><div class="src-line"><a name="a97"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a98"></a><span class="src-doc"> * Gets the short name of this course in the VLE.</span></div></li>
- <li><div class="src-line"><a name="a99"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc">Shortname of this course.</span></div></li>
- <li><div class="src-line"><a name="a100"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a101"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodget_short_name">get_short_name</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a102"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a103"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">-></span><span class="src-id">shortname</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a104"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a105"></a> </div></li>
- <li><div class="src-line"><a name="a106"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a107"></a><span class="src-doc"> * Gets the full name of this course in the VLE.</span></div></li>
- <li><div class="src-line"><a name="a108"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc">Fullname of this course.</span></div></li>
- <li><div class="src-line"><a name="a109"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a110"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodget_full_name">get_full_name</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a111"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a112"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">-></span><span class="src-id">fullname</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"> * Is auto registration permitted on this site AND course?</span></div></li>
- <li><div class="src-line"><a name="a117"></a><span class="src-doc"> * Takes into account the site-wide setting as well.</span></div></li>
- <li><div class="src-line"><a name="a118"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
- <li><div class="src-line"><a name="a119"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a120"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodcheck_autoreg">check_autoreg</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a121"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a122"></a> <span class="src-comm">// Check the site *and* the course value</span></div></li>
- <li><div class="src-line"><a name="a123"></a> <span class="src-key">return </span><span class="src-sym">(</span>(bool)<a href="../sloodle/_sloodle---lib---general.php.html#functionsloodle_autoreg_enabled_site">sloodle_autoreg_enabled_site</a><span class="src-sym">(</span><span class="src-sym">) </span>&& (bool)<span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#methodget_autoreg">get_autoreg</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="a124"></a> <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-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a127"></a><span class="src-doc"> * Gets the autoregistration value for this course only.</span></div></li>
- <li><div class="src-line"><a name="a128"></a><span class="src-doc"> * (Ignores the site setting).</span></div></li>
- <li><div class="src-line"><a name="a129"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
- <li><div class="src-line"><a name="a130"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a131"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodget_autoreg">get_autoreg</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a132"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a133"></a> <span class="src-key">return </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">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">autoreg</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-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-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a137"></a><span class="src-doc"> * Enables auto-registration for this course.</span></div></li>
- <li><div class="src-line"><a name="a138"></a><span class="src-doc"> * NOTE: it may still be disabled at site-level.</span></div></li>
- <li><div class="src-line"><a name="a139"></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="a140"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a141"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodenable_autoreg">enable_autoreg</a><span class="src-sym">(</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> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">autoreg </span>= <span class="src-num">1</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a144"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a145"></a> </div></li>
- <li><div class="src-line"><a name="a146"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a147"></a><span class="src-doc"> * Disables auto-registration for this course.</span></div></li>
- <li><div class="src-line"><a name="a148"></a><span class="src-doc"> * NOTE: does not affect the site setting.</span></div></li>
- <li><div class="src-line"><a name="a149"></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="a150"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a151"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methoddisable_autoreg">disable_autoreg</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a152"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a153"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">autoreg </span>= <span class="src-num">0</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a154"></a> <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> </div></li>
- <li><div class="src-line"><a name="a157"></a> </div></li>
- <li><div class="src-line"><a name="a158"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a159"></a><span class="src-doc"> * Is auto enrolment permitted on this site AND course?</span></div></li>
- <li><div class="src-line"><a name="a160"></a><span class="src-doc"> * Takes into account the site-wide setting as well.</span></div></li>
- <li><div class="src-line"><a name="a161"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
- <li><div class="src-line"><a name="a162"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a163"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodcheck_autoenrol">check_autoenrol</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a164"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a165"></a> <span class="src-comm">// Check the site *and* the course value</span></div></li>
- <li><div class="src-line"><a name="a166"></a> <span class="src-key">return </span><span class="src-sym">(</span>(bool)<a href="../sloodle/_sloodle---lib---general.php.html#functionsloodle_autoenrol_enabled_site">sloodle_autoenrol_enabled_site</a><span class="src-sym">(</span><span class="src-sym">) </span>&& <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#methodget_autoenrol">get_autoenrol</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="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> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a170"></a><span class="src-doc"> * Gets the auto enrolment value for this course only.</span></div></li>
- <li><div class="src-line"><a name="a171"></a><span class="src-doc"> * (Ignores the site setting).</span></div></li>
- <li><div class="src-line"><a name="a172"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
- <li><div class="src-line"><a name="a173"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a174"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodget_autoenrol">get_autoenrol</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a175"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a176"></a> <span class="src-key">return </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">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">autoenrol</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a177"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a178"></a> </div></li>
- <li><div class="src-line"><a name="a179"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a180"></a><span class="src-doc"> * Enables auto-enrolment for this course.</span></div></li>
- <li><div class="src-line"><a name="a181"></a><span class="src-doc"> * NOTE: it may still be disabled at site-level.</span></div></li>
- <li><div class="src-line"><a name="a182"></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="a183"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a184"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodenable_autoenrol">enable_autoenrol</a><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> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">autoenrol </span>= <span class="src-num">1</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a187"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a188"></a> </div></li>
- <li><div class="src-line"><a name="a189"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a190"></a><span class="src-doc"> * Disables auto-enrolment for this course.</span></div></li>
- <li><div class="src-line"><a name="a191"></a><span class="src-doc"> * NOTE: does not affect the site setting.</span></div></li>
- <li><div class="src-line"><a name="a192"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">void </span></div></li>
- <li><div class="src-line"><a name="a193"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a194"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methoddisable_autoenrol">disable_autoenrol</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a195"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a196"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">autoenrol </span>= <span class="src-num">0</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a197"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a198"></a> </div></li>
- <li><div class="src-line"><a name="a199"></a> </div></li>
- <li><div class="src-line"><a name="a200"></a> </div></li>
- <li><div class="src-line"><a name="a201"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a202"></a><span class="src-doc"> * Determines whether or not the course is available.</span></div></li>
- <li><div class="src-line"><a name="a203"></a><span class="src-doc"> * Checks that the course has not been disabled or hidden etc..</span></div></li>
- <li><div class="src-line"><a name="a204"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if the course is available</span></div></li>
- <li><div class="src-line"><a name="a205"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a206"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodis_available">is_available</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a207"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a208"></a> <span class="src-comm">// Check visbility</span></div></li>
- <li><div class="src-line"><a name="a209"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">-></span><span class="src-id">visible</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a210"></a> </div></li>
- <li><div class="src-line"><a name="a211"></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="a212"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a213"></a> </div></li>
- <li><div class="src-line"><a name="a214"></a> </div></li>
- <li><div class="src-line"><a name="a215"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a216"></a><span class="src-doc"> * Gets the position of the loginzone as a string vector <x,y,z></span></div></li>
- <li><div class="src-line"><a name="a217"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
- <li><div class="src-line"><a name="a218"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a219"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodget_loginzone_position">get_loginzone_position</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a220"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a221"></a> <span class="src-key">if </span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonepos</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonepos</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a222"></a> <span class="src-key">return </span><span class="src-str">''</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a223"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a224"></a> </div></li>
- <li><div class="src-line"><a name="a225"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a226"></a><span class="src-doc"> * Sets the position of the loginzone as a string vector <x,y,z></span></div></li>
- <li><div class="src-line"><a name="a227"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$pos </span><span class="src-doc">A string position vector <x,y,z></span></div></li>
- <li><div class="src-line"><a name="a228"></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="a229"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Update to handle arrays as well</span></div></li>
- <li><div class="src-line"><a name="a230"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a231"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodset_loginzone_position">set_loginzone_position</a><span class="src-sym">(</span><span class="src-var">$pos</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a232"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a233"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonepos </span>= <span class="src-var">$pos</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a234"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a235"></a> </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-doc"> * Sets the position of the loginzone as a set of components</span></div></li>
- <li><div class="src-line"><a name="a238"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">float </span><span class="src-doc-var">$x </span></div></li>
- <li><div class="src-line"><a name="a239"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">float </span><span class="src-doc-var">$y </span></div></li>
- <li><div class="src-line"><a name="a240"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">float </span><span class="src-doc-var">$z </span></div></li>
- <li><div class="src-line"><a name="a241"></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="a242"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a243"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodset_loginzone_position_xyz">set_loginzone_position_xyz</a><span class="src-sym">(</span><span class="src-var">$x</span><span class="src-sym">, </span><span class="src-var">$y</span><span class="src-sym">, </span><span class="src-var">$z</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a244"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a245"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonepos </span>= <span class="src-str">"</span><span class="src-str"><<span class="src-var">$x</span>,<span class="src-var">$y</span>,<span class="src-var">$z</span>></span><span class="src-str">"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a246"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a247"></a> </div></li>
- <li><div class="src-line"><a name="a248"></a> </div></li>
- <li><div class="src-line"><a name="a249"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a250"></a><span class="src-doc"> * Gets the size of the loginzone as a string vector <x,y,z></span></div></li>
- <li><div class="src-line"><a name="a251"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
- <li><div class="src-line"><a name="a252"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a253"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodget_loginzone_size">get_loginzone_size</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a254"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a255"></a> <span class="src-key">if </span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonesize</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonesize</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a256"></a> <span class="src-key">return </span><span class="src-str">''</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a257"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a258"></a> </div></li>
- <li><div class="src-line"><a name="a259"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a260"></a><span class="src-doc"> * Sets the size of the loginzone as a string vector <x,y,z></span></div></li>
- <li><div class="src-line"><a name="a261"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$size </span><span class="src-doc">A string size vector <x,y,z></span></div></li>
- <li><div class="src-line"><a name="a262"></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="a263"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@todo</span><span class="src-doc"> Update to handle arrays as well</span></div></li>
- <li><div class="src-line"><a name="a264"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a265"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodset_loginzone_size">set_loginzone_size</a><span class="src-sym">(</span><span class="src-var">$size</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a266"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a267"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonesize </span>= <span class="src-var">$size</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a268"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a269"></a> </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"> * Sets the size of the loginzone as a set of components</span></div></li>
- <li><div class="src-line"><a name="a272"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">float </span><span class="src-doc-var">$x </span></div></li>
- <li><div class="src-line"><a name="a273"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">float </span><span class="src-doc-var">$y </span></div></li>
- <li><div class="src-line"><a name="a274"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">float </span><span class="src-doc-var">$z </span></div></li>
- <li><div class="src-line"><a name="a275"></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="a276"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a277"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodset_loginzone_size_xyz">set_loginzone_size_xyz</a><span class="src-sym">(</span><span class="src-var">$x</span><span class="src-sym">, </span><span class="src-var">$y</span><span class="src-sym">, </span><span class="src-var">$z</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a278"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a279"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonesize </span>= <span class="src-str">"</span><span class="src-str"><<span class="src-var">$x</span>,<span class="src-var">$y</span>,<span class="src-var">$z</span>></span><span class="src-str">"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a280"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a281"></a> </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-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a284"></a><span class="src-doc"> * Gets the region of the loginzone</span></div></li>
- <li><div class="src-line"><a name="a285"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
- <li><div class="src-line"><a name="a286"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a287"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodget_loginzone_region">get_loginzone_region</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a288"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a289"></a> <span class="src-key">if </span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzoneregion</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzoneregion</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a290"></a> <span class="src-key">return </span><span class="src-str">''</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a291"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a292"></a> </div></li>
- <li><div class="src-line"><a name="a293"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a294"></a><span class="src-doc"> * Sets the region of the loginzone</span></div></li>
- <li><div class="src-line"><a name="a295"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$region </span><span class="src-doc">A string naming a region</span></div></li>
- <li><div class="src-line"><a name="a296"></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="a297"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a298"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodset_loginzone_region">set_loginzone_region</a><span class="src-sym">(</span><span class="src-var">$region</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a299"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a300"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzoneregion </span>= <span class="src-var">$region</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a301"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a302"></a> </div></li>
- <li><div class="src-line"><a name="a303"></a> </div></li>
- <li><div class="src-line"><a name="a304"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a305"></a><span class="src-doc"> * Gets the timestamp of the last time the loginzone was updated</span></div></li>
- <li><div class="src-line"><a name="a306"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">int </span></div></li>
- <li><div class="src-line"><a name="a307"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a308"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodget_loginzone_time_updated">get_loginzone_time_updated</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a309"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a310"></a> <span class="src-key">if </span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzoneupdated</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzoneupdated</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a311"></a> <span class="src-key">return </span><span class="src-num">0</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a312"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a313"></a> </div></li>
- <li><div class="src-line"><a name="a314"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a315"></a><span class="src-doc"> * Sets the timestamp of the last time the loginzone was updated</span></div></li>
- <li><div class="src-line"><a name="a316"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc-var">$timestamp </span><span class="src-doc">A unix timestamp. If null, the current timestamp is used</span></div></li>
- <li><div class="src-line"><a name="a317"></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="a318"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a319"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodset_loginzone_time_updated">set_loginzone_time_updated</a><span class="src-sym">(</span><span class="src-var">$timestamp </span>= <span class="src-id">null</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a320"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a321"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$timestamp </span>== <span class="src-id">null</span><span class="src-sym">) </span><span class="src-var">$timestamp </span>= <a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a322"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzoneupdated </span>= <span class="src-var">$timestamp</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a323"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a324"></a> </div></li>
- <li><div class="src-line"><a name="a325"></a> </div></li>
- <li><div class="src-line"><a name="a326"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a327"></a><span class="src-doc"> * Generates a new LoginZone allocation for the specified user.</span></div></li>
- <li><div class="src-line"><a name="a328"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">SloodleUser </span><span class="src-doc-var">$user </span><span class="src-doc">The user for whom this allocation should be made</span></div></li>
- <li><div class="src-line"><a name="a329"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string</span><span class="src-doc">|</span><span class="src-doc-type">false</span><span class="src-doc">A SLurl for the allocation, or false if it was unsuccessful</span></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-key">function </span><a href="../sloodle/SloodleCourse.html#methodgenerate_loginzone_allocation">generate_loginzone_allocation</a><span class="src-sym">(</span><span class="src-var">$user</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a332"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a333"></a> <span class="src-comm">// Make sure the necessary data is available</span></div></li>
- <li><div class="src-line"><a name="a334"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonepos</span><span class="src-sym">) </span>&& isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonesize</span><span class="src-sym">) </span>&& isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzoneregion</span><span class="src-sym">))) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a335"></a> <span class="src-comm">// Delete any existing LoginZone allocation for this user</span></div></li>
- <li><div class="src-line"><a name="a336"></a> <span class="src-id">delete_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_loginzone_allocation'</span><span class="src-sym">, </span><span class="src-str">'userid'</span><span class="src-sym">, </span><span class="src-var">$user</span><span class="src-sym">-></span><span class="src-id">get_user_id</span><span class="src-sym">(</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a337"></a> </div></li>
- <li><div class="src-line"><a name="a338"></a> <span class="src-comm">// We will try up to 10 times to find a new available position</span></div></li>
- <li><div class="src-line"><a name="a339"></a> <span class="src-var">$loginzonesize </span>= <a href="../sloodle/_sloodle---lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonesize</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a340"></a> <span class="src-var">$maxtries </span>= <span class="src-num">10</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a341"></a> <span class="src-var">$success </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a342"></a> <span class="src-key">for </span><span class="src-sym">(</span><span class="src-var">$i </span>= <span class="src-num">0</span><span class="src-sym">; </span><span class="src-var">$i </span>< <span class="src-var">$maxtries </span>&& <span class="src-var">$success </span>== <span class="src-id">false</span><span class="src-sym">; </span><span class="src-var">$i</span>++<span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a343"></a> <span class="src-comm">// Generate a new random position</span></div></li>
- <li><div class="src-line"><a name="a344"></a> <span class="src-var">$rndpos_arr </span>= <a href="../sloodle/_sloodle---lib---general.php.html#functionsloodle_random_position_in_zone">sloodle_random_position_in_zone</a><span class="src-sym">(</span><span class="src-var">$loginzonesize</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a345"></a> <span class="src-var">$rndpos_str </span>= <a href="../sloodle/_sloodle---lib---general.php.html#functionsloodle_array_to_vector">sloodle_array_to_vector</a><span class="src-sym">(</span><span class="src-var">$rndpos_arr</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a346"></a> <span class="src-comm">// Is the position already taken?</span></div></li>
- <li><div class="src-line"><a name="a347"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_loginzone_allocation'</span><span class="src-sym">, </span><span class="src-str">'course'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#methodget_course_id">get_course_id</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-str">'position'</span><span class="src-sym">, </span><span class="src-var">$rndpos_str</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a348"></a> <span class="src-comm">// Nobody has the position</span></div></li>
- <li><div class="src-line"><a name="a349"></a> <span class="src-var">$success </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a350"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a351"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a352"></a> <span class="src-comm">// Did we succeed in generating it?</span></div></li>
- <li><div class="src-line"><a name="a353"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$success</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a354"></a> </div></li>
- <li><div class="src-line"><a name="a355"></a> <span class="src-comm">// Create a new one</span></div></li>
- <li><div class="src-line"><a name="a356"></a> <span class="src-var">$alloc </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="a357"></a> <span class="src-var">$alloc</span><span class="src-sym">-></span><span class="src-id">course </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#methodget_course_id">get_course_id</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a358"></a> <span class="src-var">$alloc</span><span class="src-sym">-></span><span class="src-id">userid </span>= <span class="src-var">$user</span><span class="src-sym">-></span><span class="src-id">get_user_id</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a359"></a> <span class="src-var">$alloc</span><span class="src-sym">-></span><span class="src-id">position </span>= <span class="src-var">$rndpos_str</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a360"></a> <span class="src-var">$alloc</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="a361"></a> <span class="src-comm">// Attempt to insert it into the database</span></div></li>
- <li><div class="src-line"><a name="a362"></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_loginzone_allocation'</span><span class="src-sym">, </span><span class="src-var">$alloc</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a363"></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="a364"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a365"></a> </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"> * Gets the SLurl for the specified user's loginzone alloation</span></div></li>
- <li><div class="src-line"><a name="a368"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">SloodleUser </span><span class="src-doc-var">$user </span><span class="src-doc">The user whose allocation is to be retrieved</span></div></li>
- <li><div class="src-line"><a name="a369"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string</span><span class="src-doc">|</span><span class="src-doc-type">bool</span><span class="src-doc">The SLurl string if successful, or false if the user has no allocation or the loginzone does not exist</span></div></li>
- <li><div class="src-line"><a name="a370"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a371"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodget_loginzone_allocation">get_loginzone_allocation</a><span class="src-sym">(</span><span class="src-var">$user</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a372"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a373"></a> <span class="src-comm">// Make sure the necessary data is available</span></div></li>
- <li><div class="src-line"><a name="a374"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonepos</span><span class="src-sym">) </span>&& isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonesize</span><span class="src-sym">) </span>&& isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzoneregion</span><span class="src-sym">))) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a375"></a> <span class="src-comm">// Attempt to fetch the data</span></div></li>
- <li><div class="src-line"><a name="a376"></a> <span class="src-var">$alloc </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_loginzone_allocation'</span><span class="src-sym">, </span><span class="src-str">'course'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#methodget_course_id">get_course_id</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-str">'userid'</span><span class="src-sym">, </span><span class="src-var">$user</span><span class="src-sym">-></span><span class="src-id">get_user_id</span><span class="src-sym">(</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a377"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$alloc</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a378"></a> <span class="src-var">$relpos </span>= <a href="../sloodle/_sloodle---lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array</a><span class="src-sym">(</span><span class="src-var">$alloc</span><span class="src-sym">-></span><span class="src-id">position</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a379"></a> <span class="src-comm">// Calculate the absolute position of the allocation</span></div></li>
- <li><div class="src-line"><a name="a380"></a> <span class="src-var">$loginzonepos</span>= <a href="../sloodle/_sloodle---lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonepos</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a381"></a> <span class="src-var">$abspos </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'x'</span>=><span class="src-var">$loginzonepos</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">] </span>+ <span class="src-var">$relpos</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">]</span><span class="src-sym">, </span><span class="src-str">'y'</span>=><span class="src-var">$loginzonepos</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">] </span>+ <span class="src-var">$relpos</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">]</span><span class="src-sym">, </span><span class="src-str">'z'</span>=><span class="src-var">$loginzonepos</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">] </span>+ <span class="src-var">$relpos</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">]</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a382"></a> </div></li>
- <li><div class="src-line"><a name="a383"></a> <span class="src-comm">// Construct and return the SLurl</span></div></li>
- <li><div class="src-line"><a name="a384"></a> <span class="src-key">return </span><span class="src-str">"</span><span class="src-str">secondlife://{<span class="src-var">$this</span></span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzoneregion</span><span class="src-str"></span><span class="src-sym">}</span>/{<span class="src-var">$abspos</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">]</span><span class="src-sym">}</span>/{<span class="src-var">$abspos</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">]</span><span class="src-sym">}</span>/{<span class="src-var">$abspos</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">]</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="a385"></a> <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-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a388"></a><span class="src-doc"> * Finds the user identified by LoginZone allocation, and loads it into the given user object.</span></div></li>
- <li><div class="src-line"><a name="a389"></a><span class="src-doc"> * Note: does not delete the allocation.</span></div></li>
- <li><div class="src-line"><a name="a390"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$pos </span><span class="src-doc">Absolute position vector (relative to sim, not to LoginZone)</span></div></li>
- <li><div class="src-line"><a name="a391"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">SloodleUser </span><span class="src-doc-var">&$user </span><span class="src-doc">The user object which will be manipulated (by reference)</span></div></li>
- <li><div class="src-line"><a name="a392"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if successful, or false otherwise</span></div></li>
- <li><div class="src-line"><a name="a393"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a394"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodload_user_by_loginzone">load_user_by_loginzone</a><span class="src-sym">(</span><span class="src-var">$pos</span><span class="src-sym">, </span><span class="src-sym">&</span><span class="src-var">$user</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a395"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a396"></a> <span class="src-comm">// Calculate the relative position of the allocation</span></div></li>
- <li><div class="src-line"><a name="a397"></a> <span class="src-var">$abspos </span>= <a href="../sloodle/_sloodle---lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array</a><span class="src-sym">(</span><span class="src-var">$pos</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a398"></a> <span class="src-var">$loginzonepos</span>= <a href="../sloodle/_sloodle---lib---general.php.html#functionsloodle_vector_to_array">sloodle_vector_to_array</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonepos</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a399"></a> <span class="src-var">$relpos </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'x'</span>=><span class="src-var">$abspos</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">] </span>- <span class="src-var">$loginzonepos</span><span class="src-sym">[</span><span class="src-str">'x'</span><span class="src-sym">]</span><span class="src-sym">, </span><span class="src-str">'y'</span>=><span class="src-var">$abspos</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">] </span>- <span class="src-var">$loginzonepos</span><span class="src-sym">[</span><span class="src-str">'y'</span><span class="src-sym">]</span><span class="src-sym">, </span><span class="src-str">'z'</span>=><span class="src-var">$abspos</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">] </span>- <span class="src-var">$loginzonepos</span><span class="src-sym">[</span><span class="src-str">'z'</span><span class="src-sym">]</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a400"></a> <span class="src-var">$relpos </span>= <a href="../sloodle/_sloodle---lib---general.php.html#functionsloodle_array_to_vector">sloodle_array_to_vector</a><span class="src-sym">(</span><span class="src-var">$relpos</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a401"></a> </div></li>
- <li><div class="src-line"><a name="a402"></a> <span class="src-comm">// Attempt to find a matching LoginZone position in the database</span></div></li>
- <li><div class="src-line"><a name="a403"></a> <span class="src-var">$rec </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_loginzone_allocation'</span><span class="src-sym">, </span><span class="src-str">'course'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#methodget_course_id">get_course_id</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-str">'position'</span><span class="src-sym">, </span><span class="src-var">$relpos</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a404"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$rec</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a405"></a> <span class="src-comm">// Load the user</span></div></li>
- <li><div class="src-line"><a name="a406"></a> <span class="src-key">return </span><span class="src-var">$user</span><span class="src-sym">-></span><span class="src-id">load_user</span><span class="src-sym">(</span><span class="src-var">$rec</span><span class="src-sym">-></span><span class="src-id">userid</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a407"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a408"></a> </div></li>
- <li><div class="src-line"><a name="a409"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a410"></a><span class="src-doc"> * Deletes any loginzone allocations for the given user</span></div></li>
- <li><div class="src-line"><a name="a411"></a><span class="src-doc"> * If there are multiple for the same user (which there should never be) it will delete them all.</span></div></li>
- <li><div class="src-line"><a name="a412"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">SloodleUser </span><span class="src-doc-var">$user </span><span class="src-doc">The user whose allocation is to be deleted</span></div></li>
- <li><div class="src-line"><a name="a413"></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="a414"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a415"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methoddelete_loginzone_allocation">delete_loginzone_allocation</a><span class="src-sym">(</span><span class="src-var">$user</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a416"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a417"></a> <span class="src-id">delete_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_loginzone_allocation'</span><span class="src-sym">, </span><span class="src-str">'userid'</span><span class="src-sym">, </span><span class="src-var">$user</span><span class="src-sym">-></span><span class="src-id">get_user_id</span><span class="src-sym">(</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a418"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a419"></a> </div></li>
- <li><div class="src-line"><a name="a420"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a421"></a><span class="src-doc"> * Determines whether or not LoginZone data exists for this course.</span></div></li>
- <li><div class="src-line"><a name="a422"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if there is complete data, or false otherwise</span></div></li>
- <li><div class="src-line"><a name="a423"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a424"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodhas_loginzone_data">has_loginzone_data</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a425"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a426"></a> <span class="src-key">return </span><span class="src-sym">(</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">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonepos</span><span class="src-sym">) </span>|| <span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonesize</span><span class="src-sym">) </span>|| <span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzoneregion</span><span class="src-sym">)))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a427"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a428"></a> </div></li>
- <li><div class="src-line"><a name="a429"></a> </div></li>
- <li><div class="src-line"><a name="a430"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a431"></a><span class="src-doc"> * Reads fresh data into the structure from the database.</span></div></li>
- <li><div class="src-line"><a name="a432"></a><span class="src-doc"> * Fetches Moodle and Sloodle data about the course specified.</span></div></li>
- <li><div class="src-line"><a name="a433"></a><span class="src-doc"> * If necessary, it creates a new Sloodle entry with default settings.</span></div></li>
- <li><div class="src-line"><a name="a434"></a><span class="src-doc"> * Returns true if successful, or false on failure.</span></div></li>
- <li><div class="src-line"><a name="a435"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$course </span><span class="src-doc">Either a unique course ID, or a course data object. If the former, then VLE course data is read from the database. Otherwise, the data object is used as-is.</span></div></li>
- <li><div class="src-line"><a name="a436"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span></div></li>
- <li><div class="src-line"><a name="a437"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a438"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodload">load</a><span class="src-sym">(</span><span class="src-var">$course</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a439"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a440"></a> <span class="src-comm">// Reset everything</span></div></li>
- <li><div class="src-line"><a name="a441"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a442"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a443"></a> </div></li>
- <li><div class="src-line"><a name="a444"></a> <span class="src-comm">// Check what we are dealing with</span></div></li>
- <li><div class="src-line"><a name="a445"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_int">is_int</a><span class="src-sym">(</span><span class="src-var">$course</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a446"></a> <span class="src-comm">// It is a course ID - make sure it's valid</span></div></li>
- <li><div class="src-line"><a name="a447"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$course </span><= <span class="src-num">0</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a448"></a> <span class="src-comm">// Load the course data</span></div></li>
- <li><div class="src-line"><a name="a449"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a> = <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'course'</span><span class="src-sym">, </span><span class="src-str">'id'</span><span class="src-sym">, </span><span class="src-var">$course</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a450"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a451"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a452"></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="a453"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a454"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/is_object">is_object</a><span class="src-sym">(</span><span class="src-var">$course</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a455"></a> <span class="src-comm">// It is an object - make sure it has an ID</span></div></li>
- <li><div class="src-line"><a name="a456"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span>isset<span class="src-sym">(</span><span class="src-var">$course</span><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">)) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a457"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a> = <span class="src-var">$course</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a458"></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="a459"></a> <span class="src-comm">// Don't know what it is - do nothing</span></div></li>
- <li><div class="src-line"><a name="a460"></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="a461"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a462"></a> </div></li>
- <li><div class="src-line"><a name="a463"></a> <span class="src-comm">// Fetch the Sloodle course data</span></div></li>
- <li><div class="src-line"><a name="a464"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a> = <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_course'</span><span class="src-sym">, </span><span class="src-str">'course'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><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="a465"></a> <span class="src-comm">// Did it fail?</span></div></li>
- <li><div class="src-line"><a name="a466"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a467"></a> <span class="src-comm">// Create the new entry</span></div></li>
- <li><div class="src-line"><a name="a468"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a> = <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="a469"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">course </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a470"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">autoreg </span>= <span class="src-num">0</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a471"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonepos </span>= <span class="src-str">''</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a472"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzonesize </span>= <span class="src-str">''</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a473"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">loginzoneregion </span>= <span class="src-str">''</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a474"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><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_course'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a475"></a> <span class="src-comm">// Did something go wrong?</span></div></li>
- <li><div class="src-line"><a name="a476"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><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="a477"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a478"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a479"></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="a480"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a481"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a482"></a> </div></li>
- <li><div class="src-line"><a name="a483"></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="a484"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a485"></a> </div></li>
- <li><div class="src-line"><a name="a486"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a487"></a><span class="src-doc"> * Loads course and controller data by the unqiue site-wide identifier of a Sloodle controller.</span></div></li>
- <li><div class="src-line"><a name="a488"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$controllerid </span><span class="src-doc">The unique site-wide identifier for a Sloodle Controller. (For Moodle, an integer cmi)</span></div></li>
- <li><div class="src-line"><a name="a489"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if successful, or false on failure.</span></div></li>
- <li><div class="src-line"><a name="a490"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a491"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodload_by_controller">load_by_controller</a><span class="src-sym">(</span><span class="src-var">$controllerid</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a492"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a493"></a> <span class="src-comm">// Clear out all our data</span></div></li>
- <li><div class="src-line"><a name="a494"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a495"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a> = <span class="src-id">null</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a496"></a> </div></li>
- <li><div class="src-line"><a name="a497"></a> <span class="src-comm">// Construct a new controller object, and attempt to load its data</span></div></li>
- <li><div class="src-line"><a name="a498"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$controller">controller</a> = <span class="src-key">new </span><span class="src-id"><a href="../sloodle/SloodleController.html">SloodleController</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a499"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$controller">controller</a><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#methodload">load</a><span class="src-sym">(</span><span class="src-var">$controllerid</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a500"></a> <a href="../sloodle/_sloodle---sl_config.php.html#functionsloodle_debug">sloodle_debug</a><span class="src-sym">(</span><span class="src-str">"Failed to load controller.<br>"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a501"></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="a502"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a503"></a> </div></li>
- <li><div class="src-line"><a name="a504"></a> <span class="src-comm">// Now attempt to load all the course data</span></div></li>
- <li><div class="src-line"><a name="a505"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#methodload">load</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$controller">controller</a><span class="src-sym">-></span><a href="../sloodle/SloodleController.html#methodget_course_id">get_course_id</a><span class="src-sym">(</span><span class="src-sym">))) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a506"></a> <a href="../sloodle/_sloodle---sl_config.php.html#functionsloodle_debug">sloodle_debug</a><span class="src-sym">(</span><span class="src-str">"Failed to load course data.<br>"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a507"></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="a508"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a509"></a> </div></li>
- <li><div class="src-line"><a name="a510"></a> <span class="src-key">return </span><span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a511"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a512"></a> </div></li>
- <li><div class="src-line"><a name="a513"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a514"></a><span class="src-doc"> * Writes current Sloodle course data back to the database.</span></div></li>
- <li><div class="src-line"><a name="a515"></a><span class="src-doc"> * Requires that a course structure has already been retrieved.</span></div></li>
- <li><div class="src-line"><a name="a516"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if successful, or false on failure</span></div></li>
- <li><div class="src-line"><a name="a517"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a518"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodwrite">write</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a519"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a520"></a> <span class="src-comm">// Make sure the course data is valid</span></div></li>
- <li><div class="src-line"><a name="a521"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">) </span>|| <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">-></span><span class="src-id">id </span><= <span class="src-num">0</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a522"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">) </span>|| <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">-></span><span class="src-id">id </span><= <span class="src-num">0</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a523"></a> <span class="src-comm">// Update the Sloodle data</span></div></li>
- <li><div class="src-line"><a name="a524"></a> <span class="src-key">return </span><span class="src-id">update_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_course'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$sloodle_course_data">sloodle_course_data</a><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a525"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a526"></a> </div></li>
- <li><div class="src-line"><a name="a527"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a528"></a><span class="src-doc"> * Gets an array associating layout ID's to names</span></div></li>
- <li><div class="src-line"><a name="a529"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span></div></li>
- <li><div class="src-line"><a name="a530"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a531"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodget_layout_names">get_layout_names</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a532"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a533"></a> <span class="src-comm">// Fetch the layout records</span></div></li>
- <li><div class="src-line"><a name="a534"></a> <span class="src-var">$layouts </span>= <span class="src-id">get_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_layout'</span><span class="src-sym">, </span><span class="src-str">'course'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">, </span><span class="src-str">'name'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a535"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$layouts</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a536"></a> <span class="src-comm">// Construct the array of names</span></div></li>
- <li><div class="src-line"><a name="a537"></a> <span class="src-var">$layout_names </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="a538"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$layouts </span><span class="src-key">as </span><span class="src-var">$l</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a539"></a> <span class="src-var">$layout_names</span><span class="src-sym">[</span><span class="src-var">$l</span><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">] </span>= <span class="src-var">$l</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="a540"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a541"></a> </div></li>
- <li><div class="src-line"><a name="a542"></a> <span class="src-key">return </span><span class="src-var">$layout_names</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a543"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a544"></a> </div></li>
- <li><div class="src-line"><a name="a545"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a546"></a><span class="src-doc"> * Gets all the entries in the named layout.</span></div></li>
- <li><div class="src-line"><a name="a547"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$name </span><span class="src-doc">The name of the layout to query</span></div></li>
- <li><div class="src-line"><a name="a548"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array</span><span class="src-doc">|</span><span class="src-doc-type">bool</span><span class="src-doc">A numeric array of </span><span class="src-doc-inlinetag">{@link SloodleLayoutEntry}</span><span class="src-doc"> objects if successful, or false if the layout does not exist</span></div></li>
- <li><div class="src-line"><a name="a549"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a550"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodget_layout_entries">get_layout_entries</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a551"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a552"></a> <span class="src-comm">// Attempt to find the relevant layout</span></div></li>
- <li><div class="src-line"><a name="a553"></a> <span class="src-var">$layout </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_layout'</span><span class="src-sym">, </span><span class="src-str">'course'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">, </span><span class="src-str">'name'</span><span class="src-sym">, </span><span class="src-var">$name</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a554"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$layout</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a555"></a> </div></li>
- <li><div class="src-line"><a name="a556"></a> <span class="src-comm">// Fetch all entries</span></div></li>
- <li><div class="src-line"><a name="a557"></a> <span class="src-var">$recs </span>= <span class="src-id">get_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_layout_entry'</span><span class="src-sym">, </span><span class="src-str">'layout'</span><span class="src-sym">, </span><span class="src-var">$layout</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="a558"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$recs</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-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="a559"></a> </div></li>
- <li><div class="src-line"><a name="a560"></a> <span class="src-comm">// Construct the array of SloodleLayoutEntry objects</span></div></li>
- <li><div class="src-line"><a name="a561"></a> <span class="src-var">$entries </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="a562"></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="a563"></a> <span class="src-var">$entry </span>= <span class="src-key">new </span><span class="src-id"><a href="../sloodle/SloodleLayoutEntry.html">SloodleLayoutEntry</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a564"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">name </span>= <span class="src-var">$r</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="a565"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">position </span>= <span class="src-var">$r</span><span class="src-sym">-></span><span class="src-id">position</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a566"></a> <span class="src-var">$entry</span><span class="src-sym">-></span><span class="src-id">rotation </span>= <span class="src-var">$r</span><span class="src-sym">-></span><span class="src-id">rotation</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a567"></a> <span class="src-var">$entries</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-var">$entry</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a568"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a569"></a> </div></li>
- <li><div class="src-line"><a name="a570"></a> <span class="src-key">return </span><span class="src-var">$entries</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a571"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a572"></a> </div></li>
- <li><div class="src-line"><a name="a573"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a574"></a><span class="src-doc"> * Deletes the named layout.</span></div></li>
- <li><div class="src-line"><a name="a575"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$name </span><span class="src-doc">The name of the layout to delete</span></div></li>
- <li><div class="src-line"><a name="a576"></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="a577"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a578"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methoddelete_layout">delete_layout</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a579"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a580"></a> <span class="src-comm">// Attempt to find the relevant layout</span></div></li>
- <li><div class="src-line"><a name="a581"></a> <span class="src-var">$layout </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_layout'</span><span class="src-sym">, </span><span class="src-str">'course'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">, </span><span class="src-str">'name'</span><span class="src-sym">, </span><span class="src-var">$name</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a582"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$layout</span><span class="src-sym">) </span><span class="src-key">return</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a583"></a> </div></li>
- <li><div class="src-line"><a name="a584"></a> <span class="src-comm">// Delete all related entries</span></div></li>
- <li><div class="src-line"><a name="a585"></a> <span class="src-id">delete_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_layout_entry'</span><span class="src-sym">, </span><span class="src-str">'layout'</span><span class="src-sym">, </span><span class="src-var">$layout</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="a586"></a> <span class="src-comm">// Delete the layout itself</span></div></li>
- <li><div class="src-line"><a name="a587"></a> <span class="src-id">delete_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_layout'</span><span class="src-sym">, </span><span class="src-str">'course'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">, </span><span class="src-str">'name'</span><span class="src-sym">, </span><span class="src-var">$name</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a588"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a589"></a> </div></li>
- <li><div class="src-line"><a name="a590"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a591"></a><span class="src-doc"> * Save the given entries in the named profile.</span></div></li>
- <li><div class="src-line"><a name="a592"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$name </span><span class="src-doc">The name of the layout to query</span></div></li>
- <li><div class="src-line"><a name="a593"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">$entries </span><span class="src-doc">A numeric array of </span><span class="src-doc-inlinetag">{@link SloodleLayoutEntry}</span><span class="src-doc"> objects to store</span></div></li>
- <li><div class="src-line"><a name="a594"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">bool </span><span class="src-doc-var">$add </span><span class="src-doc">(Default: false) If true, then the entries will be added to the layout instead of replacing existing entries</span></div></li>
- <li><div class="src-line"><a name="a595"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if successful, or false otherwise</span></div></li>
- <li><div class="src-line"><a name="a596"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a597"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodsave_layout">save_layout</a><span class="src-sym">(</span><span class="src-var">$name</span><span class="src-sym">, </span><span class="src-var">$entries</span><span class="src-sym">, </span><span class="src-var">$add </span>= <span class="src-id">false</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a598"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a599"></a> <span class="src-comm">// Attempt to find the relevant layout</span></div></li>
- <li><div class="src-line"><a name="a600"></a> <span class="src-var">$layout </span>= <span class="src-id">get_record</span><span class="src-sym">(</span><span class="src-str">'sloodle_layout'</span><span class="src-sym">, </span><span class="src-str">'course'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">, </span><span class="src-str">'name'</span><span class="src-sym">, </span><span class="src-var">$name</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a601"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$layout</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a602"></a> <span class="src-comm">// Does not exist - create it</span></div></li>
- <li><div class="src-line"><a name="a603"></a> <span class="src-var">$layout </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="a604"></a> <span class="src-var">$layout</span><span class="src-sym">-></span><span class="src-id">name </span>= <span class="src-var">$name</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a605"></a> <span class="src-var">$layout</span><span class="src-sym">-></span><span class="src-id">course </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a606"></a> <span class="src-var">$layout</span><span class="src-sym">-></span><span class="src-id">timeupdated </span>= <a href="http://www.php.net/time">time</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a607"></a> <span class="src-var">$layout</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_layout'</span><span class="src-sym">, </span><span class="src-var">$layout</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a608"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$layout</span><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a609"></a> </div></li>
- <li><div class="src-line"><a name="a610"></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="a611"></a> <span class="src-comm">// Change the time updated</span></div></li>
- <li><div class="src-line"><a name="a612"></a> <span class="src-id">set_field</span><span class="src-sym">(</span><span class="src-str">'sloodle_layout'</span><span class="src-sym">, </span><span class="src-str">'timeupdated'</span><span class="src-sym">, </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-str">'course'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#var$course_object">course_object</a><span class="src-sym">-></span><span class="src-id">id</span><span class="src-sym">, </span><span class="src-str">'name'</span><span class="src-sym">, </span><span class="src-var">$name</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a613"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a614"></a> </div></li>
- <li><div class="src-line"><a name="a615"></a> <span class="src-comm">// Delete all existing entries if necessary</span></div></li>
- <li><div class="src-line"><a name="a616"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$add</span><span class="src-sym">) </span><span class="src-id">delete_records</span><span class="src-sym">(</span><span class="src-str">'sloodle_layout_entry'</span><span class="src-sym">, </span><span class="src-str">'layout'</span><span class="src-sym">, </span><span class="src-var">$layout</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="a617"></a> </div></li>
- <li><div class="src-line"><a name="a618"></a> <span class="src-comm">// Insert each new entry</span></div></li>
- <li><div class="src-line"><a name="a619"></a> <span class="src-var">$success </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a620"></a> <span class="src-key">foreach </span><span class="src-sym">(</span><span class="src-var">$entries </span><span class="src-key">as </span><span class="src-var">$e</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a621"></a> <span class="src-var">$rec </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="a622"></a> <span class="src-var">$rec</span><span class="src-sym">-></span><span class="src-id">layout </span>= <span class="src-var">$layout</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="a623"></a> <span class="src-var">$rec</span><span class="src-sym">-></span><span class="src-id">name </span>= <span class="src-var">$e</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="a624"></a> <span class="src-var">$rec</span><span class="src-sym">-></span><span class="src-id">position </span>= <span class="src-var">$e</span><span class="src-sym">-></span><span class="src-id">position</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a625"></a> <span class="src-var">$rec</span><span class="src-sym">-></span><span class="src-id">rotation </span>= <span class="src-var">$e</span><span class="src-sym">-></span><span class="src-id">rotation</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a626"></a> </div></li>
- <li><div class="src-line"><a name="a627"></a> <span class="src-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_layout_entry'</span><span class="src-sym">, </span><span class="src-var">$rec</span><span class="src-sym">)) </span><span class="src-var">$success </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a628"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a629"></a> </div></li>
- <li><div class="src-line"><a name="a630"></a> <span class="src-key">return </span><span class="src-var">$success</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a631"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a632"></a> </div></li>
- <li><div class="src-line"><a name="a633"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a634"></a><span class="src-doc"> * Checks whether or not the CURRENTLY LOGGED-IN user can authorise objects on this course.</span></div></li>
- <li><div class="src-line"><a name="a635"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">True if the user has object authorisation permission, or false otherwise.</span></div></li>
- <li><div class="src-line"><a name="a636"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a637"></a> <span class="src-key">function </span><a href="../sloodle/SloodleCourse.html#methodcan_user_authorise_objects">can_user_authorise_objects</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a638"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a639"></a> <span class="src-key">global </span><span class="src-var">$USER</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a640"></a> <span class="src-comm">// Make sure some user data</span></div></li>
- <li><div class="src-line"><a name="a641"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$USER</span><span class="src-sym">) </span>|| <span class="src-var">$USER</span><span class="src-sym">-></span><span class="src-id">id </span>== <span class="src-num">0</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-id">FALSE</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a642"></a> </div></li>
- <li><div class="src-line"><a name="a643"></a> <span class="src-comm">// Check the capability</span></div></li>
- <li><div class="src-line"><a name="a644"></a> <span class="src-key">return </span><span class="src-id">has_capability</span><span class="src-sym">(</span><span class="src-str">'mod/sloodle:objectauth'</span><span class="src-sym">, </span><span class="src-id">get_context_instance</span><span class="src-sym">(</span><span class="src-id">CONTEXT_COURSE</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodleCourse.html#methodget_course_id">get_course_id</a><span class="src-sym">(</span><span class="src-sym">)))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a645"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a646"></a> </div></li>
- <li><div class="src-line"><a name="a647"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a648"></a> </div></li>
- <li><div class="src-line"><a name="a649"></a><span class="src-php">?></span></div></li>
- </ol></div>
- </div>
- <p class="notes" id="credit">
- Documentation generated on Mon, 16 Jun 2008 15:56:17 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </body>
- </html>
|