| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983 |
- <?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>Docs For Class SloodleModule</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- <script src="../media/lib/classTree.js"></script>
- <script language="javascript" type="text/javascript">
- var imgPlus = new Image();
- var imgMinus = new Image();
- imgPlus.src = "../media/images/plus.png";
- imgMinus.src = "../media/images/minus.png";
-
- function showNode(Node){
- switch(navigator.family){
- case 'nn4':
- // Nav 4.x code fork...
- var oTable = document.layers["span" + Node];
- var oImg = document.layers["img" + Node];
- break;
- case 'ie4':
- // IE 4/5 code fork...
- var oTable = document.all["span" + Node];
- var oImg = document.all["img" + Node];
- break;
- case 'gecko':
- // Standards Compliant code fork...
- var oTable = document.getElementById("span" + Node);
- var oImg = document.getElementById("img" + Node);
- break;
- }
- oImg.src = imgMinus.src;
- oTable.style.display = "block";
- }
-
- function hideNode(Node){
- switch(navigator.family){
- case 'nn4':
- // Nav 4.x code fork...
- var oTable = document.layers["span" + Node];
- var oImg = document.layers["img" + Node];
- break;
- case 'ie4':
- // IE 4/5 code fork...
- var oTable = document.all["span" + Node];
- var oImg = document.all["img" + Node];
- break;
- case 'gecko':
- // Standards Compliant code fork...
- var oTable = document.getElementById("span" + Node);
- var oImg = document.getElementById("img" + Node);
- break;
- }
- oImg.src = imgPlus.src;
- oTable.style.display = "none";
- }
-
- function nodeIsVisible(Node){
- switch(navigator.family){
- case 'nn4':
- // Nav 4.x code fork...
- var oTable = document.layers["span" + Node];
- break;
- case 'ie4':
- // IE 4/5 code fork...
- var oTable = document.all["span" + Node];
- break;
- case 'gecko':
- // Standards Compliant code fork...
- var oTable = document.getElementById("span" + Node);
- break;
- }
- return (oTable && oTable.style.display == "block");
- }
-
- function toggleNodeVisibility(Node){
- if (nodeIsVisible(Node)){
- hideNode(Node);
- }else{
- showNode(Node);
- }
- }
- </script>
- </head>
- <body>
- <div class="page-body">
- <h2 class="class-name"><img src="../media/images/Class_logo.png"
- alt=" Class"
- title=" Class"
- style="vertical-align: middle"> SloodleModule</h2>
- <a name="sec-description"></a>
- <div class="info-box">
- <div class="info-box-title">Description</div>
- <div class="nav-bar">
- <span class="disabled">Description</span> |
- <a href="#sec-descendents">Descendents</a>
- | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
- | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Sloodle module base class.</p>
- <p class="description"><p>An abstract class which must be overridden by sub-classes.</p></p>
- <p class="notes">
- Located in <a class="field" href="_lib---modules---module_base.php.html">/lib/modules/module_base.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a20">20</a></span>)
- </p>
-
-
- <pre></pre>
-
- </div>
- </div>
- <a name="sec-descendents"></a>
- <div class="info-box">
- <div class="info-box-title">Direct descendents</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <span class="disabled">Descendents</span>
- | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
- | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
- <table cellpadding="2" cellspacing="0" class="class-table">
- <tr>
- <th class="class-table-header">Class</th>
- <th class="class-table-header">Description</th>
- </tr>
- <tr>
- <td style="padding-right: 2em; white-space: nowrap">
- <img src="../media/images/Class.png"
- alt=" class"
- title=" class"
- style="vertical-align: center"/>
- <a href="../sloodle/SloodleModuleAviLister.html">SloodleModuleAviLister</a>
- </td>
- <td>
- The Sloodle AviLister module class.
- </td>
- </tr>
- <tr>
- <td style="padding-right: 2em; white-space: nowrap">
- <img src="../media/images/Class.png"
- alt=" class"
- title=" class"
- style="vertical-align: center"/>
- <a href="../sloodle/SloodleModuleBlog.html">SloodleModuleBlog</a>
- </td>
- <td>
- The Sloodle blog module class.
- </td>
- </tr>
- <tr>
- <td style="padding-right: 2em; white-space: nowrap">
- <img src="../media/images/Class.png"
- alt=" class"
- title=" class"
- style="vertical-align: center"/>
- <a href="../sloodle/SloodleModuleChat.html">SloodleModuleChat</a>
- </td>
- <td>
- The Sloodle chat module class.
- </td>
- </tr>
- <tr>
- <td style="padding-right: 2em; white-space: nowrap">
- <img src="../media/images/Class.png"
- alt=" class"
- title=" class"
- style="vertical-align: center"/>
- <a href="../sloodle/SloodleModuleChoice.html">SloodleModuleChoice</a>
- </td>
- <td>
- The Sloodle choice module class.
- </td>
- </tr>
- <tr>
- <td style="padding-right: 2em; white-space: nowrap">
- <img src="../media/images/Class.png"
- alt=" class"
- title=" class"
- style="vertical-align: center"/>
- <a href="../sloodle/SloodleModuleDistributor.html">SloodleModuleDistributor</a>
- </td>
- <td>
- The Sloodle Distributor module class.
- </td>
- </tr>
- <tr>
- <td style="padding-right: 2em; white-space: nowrap">
- <img src="../media/images/Class.png"
- alt=" class"
- title=" class"
- style="vertical-align: center"/>
- <a href="../sloodle/SloodleModuleGlossary.html">SloodleModuleGlossary</a>
- </td>
- <td>
- The Sloodle glossary module class.
- </td>
- </tr>
- <tr>
- <td style="padding-right: 2em; white-space: nowrap">
- <img src="../media/images/Class.png"
- alt=" class"
- title=" class"
- style="vertical-align: center"/>
- <a href="../sloodle/SloodleModuleiBank.html">SloodleModuleiBank</a>
- </td>
- <td>
- The Sloodle StipendGiver module class.
- </td>
- </tr>
- <tr>
- <td style="padding-right: 2em; white-space: nowrap">
- <img src="../media/images/Class.png"
- alt=" class"
- title=" class"
- style="vertical-align: center"/>
- <a href="../sloodle/SloodleModuleMap.html">SloodleModuleMap</a>
- </td>
- <td>
- The Sloodle map resource module class.
- </td>
- </tr>
- <tr>
- <td style="padding-right: 2em; white-space: nowrap">
- <img src="../media/images/Class.png"
- alt=" class"
- title=" class"
- style="vertical-align: center"/>
- <a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a>
- </td>
- <td>
- The Sloodle presenter module class.
- </td>
- </tr>
- <tr>
- <td style="padding-right: 2em; white-space: nowrap">
- <img src="../media/images/Class.png"
- alt=" class"
- title=" class"
- style="vertical-align: center"/>
- <a href="../sloodle/SloodleModuleSloodleObject.html">SloodleModuleSloodleObject</a>
- </td>
- <td>
- The Sloodle Object assignment module class.
- </td>
- </tr>
- </table>
- </div>
- </div>
- <a name="sec-var-summary"></a>
- <div class="info-box">
- <div class="info-box-title">Variable Summary</span></div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-descendents">Descendants</a> |
- <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
- |
- <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
- <div class="var-summary">
- <div class="var-title">
- <img src="../media/images/Variable.png" alt=" " />
- <span class="var-type">object</span>
- <a href="#$_session" title="details" class="var-name">$_session</a>
- </div>
- </div>
- </div>
- </div>
- <a name="sec-method-summary"></a>
- <div class="info-box">
- <div class="info-box-title">Method Summary</span></div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-descendents">Descendants</a> |
- <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
-
- |
- <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
- </div>
- <div class="info-box-body">
- <div class="method-summary">
-
- <div class="method-definition">
- <img src="../media/images/Constructor.png" alt=" "/>
- <span class="method-result">SloodleModule</span>
- <a href="#SloodleModule" title="details" class="method-name">SloodleModule</a>
- (<span class="var-type">object</span> <span class="var-name">&$_session</span>)
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">mixed</span>
- <a href="#get_course_id" title="details" class="method-name">get_course_id</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">int</span>
- <a href="#get_creation_time" title="details" class="method-name">get_creation_time</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">string</span>
- <a href="#get_intro" title="details" class="method-name">get_intro</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">int</span>
- <a href="#get_modification_time" title="details" class="method-name">get_modification_time</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">string</span>
- <a href="#get_name" title="details" class="method-name">get_name</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">string</span>
- <a href="#get_type" title="details" class="method-name">get_type</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">string</span>
- <a href="#get_type_full" title="details" class="method-name">get_type_full</a>
- ()
- </div>
-
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">bool</span>
- <a href="#load" title="details" class="method-name">load</a>
- (<span class="var-type">mixed</span> <span class="var-name">$id</span>)
- </div>
- </div>
- </div>
- </div>
- <a name="sec-vars"></a>
- <div class="info-box">
- <div class="info-box-title">Variables</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-descendents">Descendents</a> |
- <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
-
-
- |
- <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
-
- <a name="var$_session" id="$_session"><!-- --></A>
- <div class="evenrow">
- <div class="var-header">
- <img src="../media/images/Variable.png" />
- <span class="var-title">
- <span class="var-type">object</span>
- <span class="var-name">$_session</span>
- = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a31">31</a></span>)
- </span>
- </div>
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Reference to the containing <a href="../sloodle/SloodleSession.html">SloodleSession</a> object.</p>
- <p class="description"><p>If null, then this module is being used outwith the framework. <strong>Always check the status of the variable before using it!</strong></p></p>
- <ul class="tags">
- <li><span class="field">access:</span> protected</li>
- </ul>
-
-
-
-
- </div>
-
- </div>
- </div>
-
- <a name="sec-methods"></a>
- <div class="info-box">
- <div class="info-box-title">Methods</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-descendents">Descendents</a> |
- <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
- <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
-
- </div>
- <div class="info-box-body">
- <A NAME='method_detail'></A>
- <a name="methodSloodleModule" id="SloodleModule"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Constructor.png" />
- <span class="method-title">Constructor SloodleModule</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a40">40</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Constructor - initialises the session variable</p>
-
- <div class="method-signature">
- <span class="method-result">SloodleModule</span>
- <span class="method-name">
- SloodleModule
- </span>
- (<span class="var-type">object</span> <span class="var-name">&$_session</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">object</span>
- <span class="var-name">&$_session</span><span class="var-description">: A reference to the containing <a href="../sloodle/SloodleSession.html">SloodleSession</a> object, if available.</span> </li>
- </ul>
-
-
- </div>
- <a name="methodget_course_id" id="get_course_id"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">get_course_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a82">82</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Gets the identifier of the course this controller belongs to.</p>
- <ul class="tags">
- <li><span class="field">return:</span> Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">mixed</span>
- <span class="method-name">
- get_course_id
- </span>
- ()
- </div>
-
-
-
- <hr class="separator" />
- <div class="notes">Redefined in descendants as:</div>
- <ul class="redefinitions">
- <li>
- <a href="../sloodle/SloodleModuleBlog.html#methodget_course_id">SloodleModuleBlog::get_course_id()</a>
- : Gets the identifier of the course this controller belongs to.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChat.html#methodget_course_id">SloodleModuleChat::get_course_id()</a>
- : Gets the identifier of the course this controller belongs to.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChoice.html#methodget_course_id">SloodleModuleChoice::get_course_id()</a>
- : Gets the identifier of the course this controller belongs to.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleDistributor.html#methodget_course_id">SloodleModuleDistributor::get_course_id()</a>
- : Gets the identifier of the course this controller belongs to.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleGlossary.html#methodget_course_id">SloodleModuleGlossary::get_course_id()</a>
- : Gets the identifier of the course this controller belongs to.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleiBank.html#methodget_course_id">SloodleModuleiBank::get_course_id()</a>
- : Gets the identifier of the course this controller belongs to.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleMap.html#methodget_course_id">SloodleModuleMap::get_course_id()</a>
- : Gets the identifier of the course this controller belongs to.
- </li>
- <li>
- <a href="../sloodle/SloodleModulePresenter.html#methodget_course_id">SloodleModulePresenter::get_course_id()</a>
- : Gets the identifier of the course this controller belongs to.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_course_id">SloodleModuleSloodleObject::get_course_id()</a>
- : Gets the identifier of the course this controller belongs to.
- </li>
- </ul>
- </div>
- <a name="methodget_creation_time" id="get_creation_time"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">get_creation_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a91">91</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Gets the time at which this instance was created, or 0 if unknown.</p>
- <ul class="tags">
- <li><span class="field">return:</span> Timestamp</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">int</span>
- <span class="method-name">
- get_creation_time
- </span>
- ()
- </div>
-
-
-
- <hr class="separator" />
- <div class="notes">Redefined in descendants as:</div>
- <ul class="redefinitions">
- <li>
- <a href="../sloodle/SloodleModuleBlog.html#methodget_creation_time">SloodleModuleBlog::get_creation_time()</a>
- : Gets the time at which this instance was created, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChat.html#methodget_creation_time">SloodleModuleChat::get_creation_time()</a>
- : Gets the time at which this instance was created, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChoice.html#methodget_creation_time">SloodleModuleChoice::get_creation_time()</a>
- : Gets the time at which this instance was created, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleDistributor.html#methodget_creation_time">SloodleModuleDistributor::get_creation_time()</a>
- : Gets the time at which this instance was created, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleGlossary.html#methodget_creation_time">SloodleModuleGlossary::get_creation_time()</a>
- : Gets the time at which this instance was created, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleiBank.html#methodget_creation_time">SloodleModuleiBank::get_creation_time()</a>
- : Gets the time at which this instance was created, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleMap.html#methodget_creation_time">SloodleModuleMap::get_creation_time()</a>
- : Gets the time at which this instance was created, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModulePresenter.html#methodget_creation_time">SloodleModulePresenter::get_creation_time()</a>
- : Gets the time at which this instance was created, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_creation_time">SloodleModuleSloodleObject::get_creation_time()</a>
- : Gets the time at which this instance was created, or 0 if unknown.
- </li>
- </ul>
- </div>
- <a name="methodget_intro" id="get_intro"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">get_intro</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a73">73</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Gets the intro description of this module instance, if available.</p>
- <ul class="tags">
- <li><span class="field">return:</span> The intro description of this controller</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- get_intro
- </span>
- ()
- </div>
-
-
-
- <hr class="separator" />
- <div class="notes">Redefined in descendants as:</div>
- <ul class="redefinitions">
- <li>
- <a href="../sloodle/SloodleModuleBlog.html#methodget_intro">SloodleModuleBlog::get_intro()</a>
- : Gets the intro description of this module instance, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChat.html#methodget_intro">SloodleModuleChat::get_intro()</a>
- : Gets the intro description of this module instance, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChoice.html#methodget_intro">SloodleModuleChoice::get_intro()</a>
- : Gets the intro description of this module instance, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleDistributor.html#methodget_intro">SloodleModuleDistributor::get_intro()</a>
- : Gets the intro description of this module instance, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleGlossary.html#methodget_intro">SloodleModuleGlossary::get_intro()</a>
- : Gets the intro description of this module instance, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleiBank.html#methodget_intro">SloodleModuleiBank::get_intro()</a>
- : Gets the intro description of this module instance, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleMap.html#methodget_intro">SloodleModuleMap::get_intro()</a>
- : Gets the intro description of this module instance, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModulePresenter.html#methodget_intro">SloodleModulePresenter::get_intro()</a>
- : Gets the intro description of this module instance, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_intro">SloodleModuleSloodleObject::get_intro()</a>
- : Gets the intro description of this module instance, if available.
- </li>
- </ul>
- </div>
- <a name="methodget_modification_time" id="get_modification_time"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">get_modification_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a100">100</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Gets the time at which this instance was last modified, or 0 if unknown.</p>
- <ul class="tags">
- <li><span class="field">return:</span> Timestamp</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">int</span>
- <span class="method-name">
- get_modification_time
- </span>
- ()
- </div>
-
-
-
- <hr class="separator" />
- <div class="notes">Redefined in descendants as:</div>
- <ul class="redefinitions">
- <li>
- <a href="../sloodle/SloodleModuleBlog.html#methodget_modification_time">SloodleModuleBlog::get_modification_time()</a>
- : Gets the time at which this instance was last modified, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChat.html#methodget_modification_time">SloodleModuleChat::get_modification_time()</a>
- : Gets the time at which this instance was last modified, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChoice.html#methodget_modification_time">SloodleModuleChoice::get_modification_time()</a>
- : Gets the time at which this instance was last modified, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleDistributor.html#methodget_modification_time">SloodleModuleDistributor::get_modification_time()</a>
- : Gets the time at which this instance was last modified, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleGlossary.html#methodget_modification_time">SloodleModuleGlossary::get_modification_time()</a>
- : Gets the time at which this instance was last modified, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleiBank.html#methodget_modification_time">SloodleModuleiBank::get_modification_time()</a>
- : Gets the time at which this instance was last modified, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleMap.html#methodget_modification_time">SloodleModuleMap::get_modification_time()</a>
- : Gets the time at which this instance was last modified, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModulePresenter.html#methodget_modification_time">SloodleModulePresenter::get_modification_time()</a>
- : Gets the time at which this instance was last modified, or 0 if unknown.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_modification_time">SloodleModuleSloodleObject::get_modification_time()</a>
- : Gets the time at which this instance was last modified, or 0 if unknown.
- </li>
- </ul>
- </div>
- <a name="methodget_name" id="get_name"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">get_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a64">64</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Gets the name of this module instance.</p>
- <ul class="tags">
- <li><span class="field">return:</span> The name of this controller</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- get_name
- </span>
- ()
- </div>
-
-
-
- <hr class="separator" />
- <div class="notes">Redefined in descendants as:</div>
- <ul class="redefinitions">
- <li>
- <a href="../sloodle/SloodleModuleAviLister.html#methodget_name">SloodleModuleAviLister::get_name()</a>
- : Gets the name of this module instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleBlog.html#methodget_name">SloodleModuleBlog::get_name()</a>
- : Gets the name of this module instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChat.html#methodget_name">SloodleModuleChat::get_name()</a>
- : Gets the name of this module instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChoice.html#methodget_name">SloodleModuleChoice::get_name()</a>
- : Gets the name of this module instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleDistributor.html#methodget_name">SloodleModuleDistributor::get_name()</a>
- : Gets the name of this module instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleGlossary.html#methodget_name">SloodleModuleGlossary::get_name()</a>
- : Gets the name of this module instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleiBank.html#methodget_name">SloodleModuleiBank::get_name()</a>
- : Gets the name of this module instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleMap.html#methodget_name">SloodleModuleMap::get_name()</a>
- : Gets the name of this module instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModulePresenter.html#methodget_name">SloodleModulePresenter::get_name()</a>
- : Gets the name of this module instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_name">SloodleModuleSloodleObject::get_name()</a>
- : Gets the name of this module instance.
- </li>
- </ul>
- </div>
- <a name="methodget_type" id="get_type"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">get_type</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a110">110</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Gets the short type name of this instance.</p>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- get_type
- </span>
- ()
- </div>
-
-
-
- <hr class="separator" />
- <div class="notes">Redefined in descendants as:</div>
- <ul class="redefinitions">
- <li>
- <a href="../sloodle/SloodleModuleAviLister.html#methodget_type">SloodleModuleAviLister::get_type()</a>
- : Gets the short type name of this instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleBlog.html#methodget_type">SloodleModuleBlog::get_type()</a>
- : Gets the short type name of this instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChat.html#methodget_type">SloodleModuleChat::get_type()</a>
- : Gets the short type name of this instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChoice.html#methodget_type">SloodleModuleChoice::get_type()</a>
- : Gets the short type name of this instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleDistributor.html#methodget_type">SloodleModuleDistributor::get_type()</a>
- : Gets the short type name of this instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleGlossary.html#methodget_type">SloodleModuleGlossary::get_type()</a>
- : Gets the short type name of this instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleiBank.html#methodget_type">SloodleModuleiBank::get_type()</a>
- : Gets the short type name of this instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleMap.html#methodget_type">SloodleModuleMap::get_type()</a>
- : Gets the short type name of this instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModulePresenter.html#methodget_type">SloodleModulePresenter::get_type()</a>
- : Gets the short type name of this instance.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_type">SloodleModuleSloodleObject::get_type()</a>
- : Gets the short type name of this instance.
- </li>
- </ul>
- </div>
- <a name="methodget_type_full" id="get_type_full"><!-- --></a>
- <div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">get_type_full</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a120">120</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Gets the full type name of this instance, according to the current language pack, if available.</p>
- <p class="description"><p>Note: should be overridden by sub-classes.</p></p>
- <ul class="tags">
- <li><span class="field">return:</span> Full type name if possible, or the short name otherwise.</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- get_type_full
- </span>
- ()
- </div>
-
-
-
- <hr class="separator" />
- <div class="notes">Redefined in descendants as:</div>
- <ul class="redefinitions">
- <li>
- <a href="../sloodle/SloodleModuleAviLister.html#methodget_type_full">SloodleModuleAviLister::get_type_full()</a>
- : Gets the full type name of this instance, according to the current language pack, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleBlog.html#methodget_type_full">SloodleModuleBlog::get_type_full()</a>
- : Gets the full type name of this instance, according to the current language pack, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChat.html#methodget_type_full">SloodleModuleChat::get_type_full()</a>
- : Gets the full type name of this instance, according to the current language pack, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChoice.html#methodget_type_full">SloodleModuleChoice::get_type_full()</a>
- : Gets the full type name of this instance, according to the current language pack, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleDistributor.html#methodget_type_full">SloodleModuleDistributor::get_type_full()</a>
- : Gets the full type name of this instance, according to the current language pack, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleGlossary.html#methodget_type_full">SloodleModuleGlossary::get_type_full()</a>
- : Gets the full type name of this instance, according to the current language pack, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleiBank.html#methodget_type_full">SloodleModuleiBank::get_type_full()</a>
- : Gets the full type name of this instance, according to the current language pack, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleMap.html#methodget_type_full">SloodleModuleMap::get_type_full()</a>
- : Gets the full type name of this instance, according to the current language pack, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModulePresenter.html#methodget_type_full">SloodleModulePresenter::get_type_full()</a>
- : Gets the full type name of this instance, according to the current language pack, if available.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_type_full">SloodleModuleSloodleObject::get_type_full()</a>
- : Gets the full type name of this instance, according to the current language pack, if available.
- </li>
- </ul>
- </div>
- <a name="methodload" id="load"><!-- --></a>
- <div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">load</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a52">52</a></span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
- <p class="short-description">Loads data from the database.</p>
- <p class="description"><p>Note: even if the function fails, it may still have overwritten some or all existing data in the object.</p></p>
- <ul class="tags">
- <li><span class="field">return:</span> True if successful, or false otherwise</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">bool</span>
- <span class="method-name">
- load
- </span>
- (<span class="var-type">mixed</span> <span class="var-name">$id</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">mixed</span>
- <span class="var-name">$id</span><span class="var-description">: The site-wide unique identifier for all modules. Type depends on VLE. On Moodle, it is an integer course module identifier ('id' field of 'course_modules' table)</span> </li>
- </ul>
-
-
- <hr class="separator" />
- <div class="notes">Redefined in descendants as:</div>
- <ul class="redefinitions">
- <li>
- <a href="../sloodle/SloodleModuleChat.html#methodload">SloodleModuleChat::load()</a>
- : Loads data from the database.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleChoice.html#methodload">SloodleModuleChoice::load()</a>
- : Loads data from the database.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleDistributor.html#methodload">SloodleModuleDistributor::load()</a>
- : Loads data from the database.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleGlossary.html#methodload">SloodleModuleGlossary::load()</a>
- : Loads data from the database.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleiBank.html#methodload">SloodleModuleiBank::load()</a>
- : Loads data from the database.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleMap.html#methodload">SloodleModuleMap::load()</a>
- : Loads data from the database.
- </li>
- <li>
- <a href="../sloodle/SloodleModulePresenter.html#methodload">SloodleModulePresenter::load()</a>
- : Loads data from the database.
- </li>
- <li>
- <a href="../sloodle/SloodleModuleSloodleObject.html#methodload">SloodleModuleSloodleObject::load()</a>
- : Loads data from the database.
- </li>
- </ul>
- </div>
-
- </div>
- </div>
-
- <p class="notes" id="credit">
- Documentation generated on Fri, 17 Jul 2009 11:01:52 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </div></body>
- </html>
|