SloodleModule.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title>Docs For Class SloodleModule</title>
  7. <link rel="stylesheet" href="../media/stylesheet.css" />
  8. <script src="../media/lib/classTree.js"></script>
  9. <script language="javascript" type="text/javascript">
  10. var imgPlus = new Image();
  11. var imgMinus = new Image();
  12. imgPlus.src = "../media/images/plus.png";
  13. imgMinus.src = "../media/images/minus.png";
  14. function showNode(Node){
  15. switch(navigator.family){
  16. case 'nn4':
  17. // Nav 4.x code fork...
  18. var oTable = document.layers["span" + Node];
  19. var oImg = document.layers["img" + Node];
  20. break;
  21. case 'ie4':
  22. // IE 4/5 code fork...
  23. var oTable = document.all["span" + Node];
  24. var oImg = document.all["img" + Node];
  25. break;
  26. case 'gecko':
  27. // Standards Compliant code fork...
  28. var oTable = document.getElementById("span" + Node);
  29. var oImg = document.getElementById("img" + Node);
  30. break;
  31. }
  32. oImg.src = imgMinus.src;
  33. oTable.style.display = "block";
  34. }
  35. function hideNode(Node){
  36. switch(navigator.family){
  37. case 'nn4':
  38. // Nav 4.x code fork...
  39. var oTable = document.layers["span" + Node];
  40. var oImg = document.layers["img" + Node];
  41. break;
  42. case 'ie4':
  43. // IE 4/5 code fork...
  44. var oTable = document.all["span" + Node];
  45. var oImg = document.all["img" + Node];
  46. break;
  47. case 'gecko':
  48. // Standards Compliant code fork...
  49. var oTable = document.getElementById("span" + Node);
  50. var oImg = document.getElementById("img" + Node);
  51. break;
  52. }
  53. oImg.src = imgPlus.src;
  54. oTable.style.display = "none";
  55. }
  56. function nodeIsVisible(Node){
  57. switch(navigator.family){
  58. case 'nn4':
  59. // Nav 4.x code fork...
  60. var oTable = document.layers["span" + Node];
  61. break;
  62. case 'ie4':
  63. // IE 4/5 code fork...
  64. var oTable = document.all["span" + Node];
  65. break;
  66. case 'gecko':
  67. // Standards Compliant code fork...
  68. var oTable = document.getElementById("span" + Node);
  69. break;
  70. }
  71. return (oTable && oTable.style.display == "block");
  72. }
  73. function toggleNodeVisibility(Node){
  74. if (nodeIsVisible(Node)){
  75. hideNode(Node);
  76. }else{
  77. showNode(Node);
  78. }
  79. }
  80. </script>
  81. </head>
  82. <body>
  83. <div class="page-body">
  84. <h2 class="class-name"><img src="../media/images/Class_logo.png"
  85. alt=" Class"
  86. title=" Class"
  87. style="vertical-align: middle"> SloodleModule</h2>
  88. <a name="sec-description"></a>
  89. <div class="info-box">
  90. <div class="info-box-title">Description</div>
  91. <div class="nav-bar">
  92. <span class="disabled">Description</span> |
  93. <a href="#sec-descendents">Descendents</a>
  94. | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  95. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  96. </div>
  97. <div class="info-box-body">
  98. <!-- ========== Info from phpDoc block ========= -->
  99. <p class="short-description">Sloodle module base class.</p>
  100. <p class="description"><p>An abstract class which must be overridden by sub-classes.</p></p>
  101. <p class="notes">
  102. 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>)
  103. </p>
  104. <pre></pre>
  105. </div>
  106. </div>
  107. <a name="sec-descendents"></a>
  108. <div class="info-box">
  109. <div class="info-box-title">Direct descendents</div>
  110. <div class="nav-bar">
  111. <a href="#sec-description">Description</a> |
  112. <span class="disabled">Descendents</span>
  113. | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  114. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  115. </div>
  116. <div class="info-box-body">
  117. <table cellpadding="2" cellspacing="0" class="class-table">
  118. <tr>
  119. <th class="class-table-header">Class</th>
  120. <th class="class-table-header">Description</th>
  121. </tr>
  122. <tr>
  123. <td style="padding-right: 2em; white-space: nowrap">
  124. <img src="../media/images/Class.png"
  125. alt=" class"
  126. title=" class"
  127. style="vertical-align: center"/>
  128. <a href="../sloodle/SloodleModuleAviLister.html">SloodleModuleAviLister</a>
  129. </td>
  130. <td>
  131. The Sloodle AviLister module class.
  132. </td>
  133. </tr>
  134. <tr>
  135. <td style="padding-right: 2em; white-space: nowrap">
  136. <img src="../media/images/Class.png"
  137. alt=" class"
  138. title=" class"
  139. style="vertical-align: center"/>
  140. <a href="../sloodle/SloodleModuleBlog.html">SloodleModuleBlog</a>
  141. </td>
  142. <td>
  143. The Sloodle blog module class.
  144. </td>
  145. </tr>
  146. <tr>
  147. <td style="padding-right: 2em; white-space: nowrap">
  148. <img src="../media/images/Class.png"
  149. alt=" class"
  150. title=" class"
  151. style="vertical-align: center"/>
  152. <a href="../sloodle/SloodleModuleChat.html">SloodleModuleChat</a>
  153. </td>
  154. <td>
  155. The Sloodle chat module class.
  156. </td>
  157. </tr>
  158. <tr>
  159. <td style="padding-right: 2em; white-space: nowrap">
  160. <img src="../media/images/Class.png"
  161. alt=" class"
  162. title=" class"
  163. style="vertical-align: center"/>
  164. <a href="../sloodle/SloodleModuleChoice.html">SloodleModuleChoice</a>
  165. </td>
  166. <td>
  167. The Sloodle choice module class.
  168. </td>
  169. </tr>
  170. <tr>
  171. <td style="padding-right: 2em; white-space: nowrap">
  172. <img src="../media/images/Class.png"
  173. alt=" class"
  174. title=" class"
  175. style="vertical-align: center"/>
  176. <a href="../sloodle/SloodleModuleDistributor.html">SloodleModuleDistributor</a>
  177. </td>
  178. <td>
  179. The Sloodle Distributor module class.
  180. </td>
  181. </tr>
  182. <tr>
  183. <td style="padding-right: 2em; white-space: nowrap">
  184. <img src="../media/images/Class.png"
  185. alt=" class"
  186. title=" class"
  187. style="vertical-align: center"/>
  188. <a href="../sloodle/SloodleModuleGlossary.html">SloodleModuleGlossary</a>
  189. </td>
  190. <td>
  191. The Sloodle glossary module class.
  192. </td>
  193. </tr>
  194. <tr>
  195. <td style="padding-right: 2em; white-space: nowrap">
  196. <img src="../media/images/Class.png"
  197. alt=" class"
  198. title=" class"
  199. style="vertical-align: center"/>
  200. <a href="../sloodle/SloodleModuleiBank.html">SloodleModuleiBank</a>
  201. </td>
  202. <td>
  203. The Sloodle StipendGiver module class.
  204. </td>
  205. </tr>
  206. <tr>
  207. <td style="padding-right: 2em; white-space: nowrap">
  208. <img src="../media/images/Class.png"
  209. alt=" class"
  210. title=" class"
  211. style="vertical-align: center"/>
  212. <a href="../sloodle/SloodleModuleMap.html">SloodleModuleMap</a>
  213. </td>
  214. <td>
  215. The Sloodle map resource module class.
  216. </td>
  217. </tr>
  218. <tr>
  219. <td style="padding-right: 2em; white-space: nowrap">
  220. <img src="../media/images/Class.png"
  221. alt=" class"
  222. title=" class"
  223. style="vertical-align: center"/>
  224. <a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a>
  225. </td>
  226. <td>
  227. The Sloodle presenter module class.
  228. </td>
  229. </tr>
  230. <tr>
  231. <td style="padding-right: 2em; white-space: nowrap">
  232. <img src="../media/images/Class.png"
  233. alt=" class"
  234. title=" class"
  235. style="vertical-align: center"/>
  236. <a href="../sloodle/SloodleModuleSloodleObject.html">SloodleModuleSloodleObject</a>
  237. </td>
  238. <td>
  239. The Sloodle Object assignment module class.
  240. </td>
  241. </tr>
  242. </table>
  243. </div>
  244. </div>
  245. <a name="sec-var-summary"></a>
  246. <div class="info-box">
  247. <div class="info-box-title">Variable Summary</span></div>
  248. <div class="nav-bar">
  249. <a href="#sec-description">Description</a> |
  250. <a href="#sec-descendents">Descendants</a> |
  251. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  252. |
  253. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  254. </div>
  255. <div class="info-box-body">
  256. <div class="var-summary">
  257. <div class="var-title">
  258. <img src="../media/images/Variable.png" alt=" " />
  259. <span class="var-type">object</span>
  260. <a href="#$_session" title="details" class="var-name">$_session</a>
  261. </div>
  262. </div>
  263. </div>
  264. </div>
  265. <a name="sec-method-summary"></a>
  266. <div class="info-box">
  267. <div class="info-box-title">Method Summary</span></div>
  268. <div class="nav-bar">
  269. <a href="#sec-description">Description</a> |
  270. <a href="#sec-descendents">Descendants</a> |
  271. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  272. |
  273. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  274. </div>
  275. <div class="info-box-body">
  276. <div class="method-summary">
  277. <div class="method-definition">
  278. <img src="../media/images/Constructor.png" alt=" "/>
  279. <span class="method-result">SloodleModule</span>
  280. <a href="#SloodleModule" title="details" class="method-name">SloodleModule</a>
  281. (<span class="var-type">object</span>&nbsp;<span class="var-name">&$_session</span>)
  282. </div>
  283. <div class="method-definition">
  284. <img src="../media/images/Method.png" alt=" "/>
  285. <span class="method-result">mixed</span>
  286. <a href="#get_course_id" title="details" class="method-name">get_course_id</a>
  287. ()
  288. </div>
  289. <div class="method-definition">
  290. <img src="../media/images/Method.png" alt=" "/>
  291. <span class="method-result">int</span>
  292. <a href="#get_creation_time" title="details" class="method-name">get_creation_time</a>
  293. ()
  294. </div>
  295. <div class="method-definition">
  296. <img src="../media/images/Method.png" alt=" "/>
  297. <span class="method-result">string</span>
  298. <a href="#get_intro" title="details" class="method-name">get_intro</a>
  299. ()
  300. </div>
  301. <div class="method-definition">
  302. <img src="../media/images/Method.png" alt=" "/>
  303. <span class="method-result">int</span>
  304. <a href="#get_modification_time" title="details" class="method-name">get_modification_time</a>
  305. ()
  306. </div>
  307. <div class="method-definition">
  308. <img src="../media/images/Method.png" alt=" "/>
  309. <span class="method-result">string</span>
  310. <a href="#get_name" title="details" class="method-name">get_name</a>
  311. ()
  312. </div>
  313. <div class="method-definition">
  314. <img src="../media/images/Method.png" alt=" "/>
  315. <span class="method-result">string</span>
  316. <a href="#get_type" title="details" class="method-name">get_type</a>
  317. ()
  318. </div>
  319. <div class="method-definition">
  320. <img src="../media/images/Method.png" alt=" "/>
  321. <span class="method-result">string</span>
  322. <a href="#get_type_full" title="details" class="method-name">get_type_full</a>
  323. ()
  324. </div>
  325. <div class="method-definition">
  326. <img src="../media/images/Method.png" alt=" "/>
  327. <span class="method-result">bool</span>
  328. <a href="#load" title="details" class="method-name">load</a>
  329. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  330. </div>
  331. </div>
  332. </div>
  333. </div>
  334. <a name="sec-vars"></a>
  335. <div class="info-box">
  336. <div class="info-box-title">Variables</div>
  337. <div class="nav-bar">
  338. <a href="#sec-description">Description</a> |
  339. <a href="#sec-descendents">Descendents</a> |
  340. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  341. |
  342. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  343. </div>
  344. <div class="info-box-body">
  345. <a name="var$_session" id="$_session"><!-- --></A>
  346. <div class="evenrow">
  347. <div class="var-header">
  348. <img src="../media/images/Variable.png" />
  349. <span class="var-title">
  350. <span class="var-type">object</span>
  351. <span class="var-name">$_session</span>
  352. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a31">31</a></span>)
  353. </span>
  354. </div>
  355. <!-- ========== Info from phpDoc block ========= -->
  356. <p class="short-description">Reference to the containing <a href="../sloodle/SloodleSession.html">SloodleSession</a> object.</p>
  357. <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>
  358. <ul class="tags">
  359. <li><span class="field">access:</span> protected</li>
  360. </ul>
  361. </div>
  362. </div>
  363. </div>
  364. <a name="sec-methods"></a>
  365. <div class="info-box">
  366. <div class="info-box-title">Methods</div>
  367. <div class="nav-bar">
  368. <a href="#sec-description">Description</a> |
  369. <a href="#sec-descendents">Descendents</a> |
  370. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  371. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  372. </div>
  373. <div class="info-box-body">
  374. <A NAME='method_detail'></A>
  375. <a name="methodSloodleModule" id="SloodleModule"><!-- --></a>
  376. <div class="oddrow">
  377. <div class="method-header">
  378. <img src="../media/images/Constructor.png" />
  379. <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>)
  380. </div>
  381. <!-- ========== Info from phpDoc block ========= -->
  382. <p class="short-description">Constructor - initialises the session variable</p>
  383. <div class="method-signature">
  384. <span class="method-result">SloodleModule</span>
  385. <span class="method-name">
  386. SloodleModule
  387. </span>
  388. (<span class="var-type">object</span>&nbsp;<span class="var-name">&$_session</span>)
  389. </div>
  390. <ul class="parameters">
  391. <li>
  392. <span class="var-type">object</span>
  393. <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>
  394. </ul>
  395. </div>
  396. <a name="methodget_course_id" id="get_course_id"><!-- --></a>
  397. <div class="evenrow">
  398. <div class="method-header">
  399. <img src="../media/images/Method.png" />
  400. <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>)
  401. </div>
  402. <!-- ========== Info from phpDoc block ========= -->
  403. <p class="short-description">Gets the identifier of the course this controller belongs to.</p>
  404. <ul class="tags">
  405. <li><span class="field">return:</span> Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</li>
  406. </ul>
  407. <div class="method-signature">
  408. <span class="method-result">mixed</span>
  409. <span class="method-name">
  410. get_course_id
  411. </span>
  412. ()
  413. </div>
  414. <hr class="separator" />
  415. <div class="notes">Redefined in descendants as:</div>
  416. <ul class="redefinitions">
  417. <li>
  418. <a href="../sloodle/SloodleModuleBlog.html#methodget_course_id">SloodleModuleBlog::get_course_id()</a>
  419. : Gets the identifier of the course this controller belongs to.
  420. </li>
  421. <li>
  422. <a href="../sloodle/SloodleModuleChat.html#methodget_course_id">SloodleModuleChat::get_course_id()</a>
  423. : Gets the identifier of the course this controller belongs to.
  424. </li>
  425. <li>
  426. <a href="../sloodle/SloodleModuleChoice.html#methodget_course_id">SloodleModuleChoice::get_course_id()</a>
  427. : Gets the identifier of the course this controller belongs to.
  428. </li>
  429. <li>
  430. <a href="../sloodle/SloodleModuleDistributor.html#methodget_course_id">SloodleModuleDistributor::get_course_id()</a>
  431. : Gets the identifier of the course this controller belongs to.
  432. </li>
  433. <li>
  434. <a href="../sloodle/SloodleModuleGlossary.html#methodget_course_id">SloodleModuleGlossary::get_course_id()</a>
  435. : Gets the identifier of the course this controller belongs to.
  436. </li>
  437. <li>
  438. <a href="../sloodle/SloodleModuleiBank.html#methodget_course_id">SloodleModuleiBank::get_course_id()</a>
  439. : Gets the identifier of the course this controller belongs to.
  440. </li>
  441. <li>
  442. <a href="../sloodle/SloodleModuleMap.html#methodget_course_id">SloodleModuleMap::get_course_id()</a>
  443. : Gets the identifier of the course this controller belongs to.
  444. </li>
  445. <li>
  446. <a href="../sloodle/SloodleModulePresenter.html#methodget_course_id">SloodleModulePresenter::get_course_id()</a>
  447. : Gets the identifier of the course this controller belongs to.
  448. </li>
  449. <li>
  450. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_course_id">SloodleModuleSloodleObject::get_course_id()</a>
  451. : Gets the identifier of the course this controller belongs to.
  452. </li>
  453. </ul>
  454. </div>
  455. <a name="methodget_creation_time" id="get_creation_time"><!-- --></a>
  456. <div class="oddrow">
  457. <div class="method-header">
  458. <img src="../media/images/Method.png" />
  459. <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>)
  460. </div>
  461. <!-- ========== Info from phpDoc block ========= -->
  462. <p class="short-description">Gets the time at which this instance was created, or 0 if unknown.</p>
  463. <ul class="tags">
  464. <li><span class="field">return:</span> Timestamp</li>
  465. </ul>
  466. <div class="method-signature">
  467. <span class="method-result">int</span>
  468. <span class="method-name">
  469. get_creation_time
  470. </span>
  471. ()
  472. </div>
  473. <hr class="separator" />
  474. <div class="notes">Redefined in descendants as:</div>
  475. <ul class="redefinitions">
  476. <li>
  477. <a href="../sloodle/SloodleModuleBlog.html#methodget_creation_time">SloodleModuleBlog::get_creation_time()</a>
  478. : Gets the time at which this instance was created, or 0 if unknown.
  479. </li>
  480. <li>
  481. <a href="../sloodle/SloodleModuleChat.html#methodget_creation_time">SloodleModuleChat::get_creation_time()</a>
  482. : Gets the time at which this instance was created, or 0 if unknown.
  483. </li>
  484. <li>
  485. <a href="../sloodle/SloodleModuleChoice.html#methodget_creation_time">SloodleModuleChoice::get_creation_time()</a>
  486. : Gets the time at which this instance was created, or 0 if unknown.
  487. </li>
  488. <li>
  489. <a href="../sloodle/SloodleModuleDistributor.html#methodget_creation_time">SloodleModuleDistributor::get_creation_time()</a>
  490. : Gets the time at which this instance was created, or 0 if unknown.
  491. </li>
  492. <li>
  493. <a href="../sloodle/SloodleModuleGlossary.html#methodget_creation_time">SloodleModuleGlossary::get_creation_time()</a>
  494. : Gets the time at which this instance was created, or 0 if unknown.
  495. </li>
  496. <li>
  497. <a href="../sloodle/SloodleModuleiBank.html#methodget_creation_time">SloodleModuleiBank::get_creation_time()</a>
  498. : Gets the time at which this instance was created, or 0 if unknown.
  499. </li>
  500. <li>
  501. <a href="../sloodle/SloodleModuleMap.html#methodget_creation_time">SloodleModuleMap::get_creation_time()</a>
  502. : Gets the time at which this instance was created, or 0 if unknown.
  503. </li>
  504. <li>
  505. <a href="../sloodle/SloodleModulePresenter.html#methodget_creation_time">SloodleModulePresenter::get_creation_time()</a>
  506. : Gets the time at which this instance was created, or 0 if unknown.
  507. </li>
  508. <li>
  509. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_creation_time">SloodleModuleSloodleObject::get_creation_time()</a>
  510. : Gets the time at which this instance was created, or 0 if unknown.
  511. </li>
  512. </ul>
  513. </div>
  514. <a name="methodget_intro" id="get_intro"><!-- --></a>
  515. <div class="evenrow">
  516. <div class="method-header">
  517. <img src="../media/images/Method.png" />
  518. <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>)
  519. </div>
  520. <!-- ========== Info from phpDoc block ========= -->
  521. <p class="short-description">Gets the intro description of this module instance, if available.</p>
  522. <ul class="tags">
  523. <li><span class="field">return:</span> The intro description of this controller</li>
  524. </ul>
  525. <div class="method-signature">
  526. <span class="method-result">string</span>
  527. <span class="method-name">
  528. get_intro
  529. </span>
  530. ()
  531. </div>
  532. <hr class="separator" />
  533. <div class="notes">Redefined in descendants as:</div>
  534. <ul class="redefinitions">
  535. <li>
  536. <a href="../sloodle/SloodleModuleBlog.html#methodget_intro">SloodleModuleBlog::get_intro()</a>
  537. : Gets the intro description of this module instance, if available.
  538. </li>
  539. <li>
  540. <a href="../sloodle/SloodleModuleChat.html#methodget_intro">SloodleModuleChat::get_intro()</a>
  541. : Gets the intro description of this module instance, if available.
  542. </li>
  543. <li>
  544. <a href="../sloodle/SloodleModuleChoice.html#methodget_intro">SloodleModuleChoice::get_intro()</a>
  545. : Gets the intro description of this module instance, if available.
  546. </li>
  547. <li>
  548. <a href="../sloodle/SloodleModuleDistributor.html#methodget_intro">SloodleModuleDistributor::get_intro()</a>
  549. : Gets the intro description of this module instance, if available.
  550. </li>
  551. <li>
  552. <a href="../sloodle/SloodleModuleGlossary.html#methodget_intro">SloodleModuleGlossary::get_intro()</a>
  553. : Gets the intro description of this module instance, if available.
  554. </li>
  555. <li>
  556. <a href="../sloodle/SloodleModuleiBank.html#methodget_intro">SloodleModuleiBank::get_intro()</a>
  557. : Gets the intro description of this module instance, if available.
  558. </li>
  559. <li>
  560. <a href="../sloodle/SloodleModuleMap.html#methodget_intro">SloodleModuleMap::get_intro()</a>
  561. : Gets the intro description of this module instance, if available.
  562. </li>
  563. <li>
  564. <a href="../sloodle/SloodleModulePresenter.html#methodget_intro">SloodleModulePresenter::get_intro()</a>
  565. : Gets the intro description of this module instance, if available.
  566. </li>
  567. <li>
  568. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_intro">SloodleModuleSloodleObject::get_intro()</a>
  569. : Gets the intro description of this module instance, if available.
  570. </li>
  571. </ul>
  572. </div>
  573. <a name="methodget_modification_time" id="get_modification_time"><!-- --></a>
  574. <div class="oddrow">
  575. <div class="method-header">
  576. <img src="../media/images/Method.png" />
  577. <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>)
  578. </div>
  579. <!-- ========== Info from phpDoc block ========= -->
  580. <p class="short-description">Gets the time at which this instance was last modified, or 0 if unknown.</p>
  581. <ul class="tags">
  582. <li><span class="field">return:</span> Timestamp</li>
  583. </ul>
  584. <div class="method-signature">
  585. <span class="method-result">int</span>
  586. <span class="method-name">
  587. get_modification_time
  588. </span>
  589. ()
  590. </div>
  591. <hr class="separator" />
  592. <div class="notes">Redefined in descendants as:</div>
  593. <ul class="redefinitions">
  594. <li>
  595. <a href="../sloodle/SloodleModuleBlog.html#methodget_modification_time">SloodleModuleBlog::get_modification_time()</a>
  596. : Gets the time at which this instance was last modified, or 0 if unknown.
  597. </li>
  598. <li>
  599. <a href="../sloodle/SloodleModuleChat.html#methodget_modification_time">SloodleModuleChat::get_modification_time()</a>
  600. : Gets the time at which this instance was last modified, or 0 if unknown.
  601. </li>
  602. <li>
  603. <a href="../sloodle/SloodleModuleChoice.html#methodget_modification_time">SloodleModuleChoice::get_modification_time()</a>
  604. : Gets the time at which this instance was last modified, or 0 if unknown.
  605. </li>
  606. <li>
  607. <a href="../sloodle/SloodleModuleDistributor.html#methodget_modification_time">SloodleModuleDistributor::get_modification_time()</a>
  608. : Gets the time at which this instance was last modified, or 0 if unknown.
  609. </li>
  610. <li>
  611. <a href="../sloodle/SloodleModuleGlossary.html#methodget_modification_time">SloodleModuleGlossary::get_modification_time()</a>
  612. : Gets the time at which this instance was last modified, or 0 if unknown.
  613. </li>
  614. <li>
  615. <a href="../sloodle/SloodleModuleiBank.html#methodget_modification_time">SloodleModuleiBank::get_modification_time()</a>
  616. : Gets the time at which this instance was last modified, or 0 if unknown.
  617. </li>
  618. <li>
  619. <a href="../sloodle/SloodleModuleMap.html#methodget_modification_time">SloodleModuleMap::get_modification_time()</a>
  620. : Gets the time at which this instance was last modified, or 0 if unknown.
  621. </li>
  622. <li>
  623. <a href="../sloodle/SloodleModulePresenter.html#methodget_modification_time">SloodleModulePresenter::get_modification_time()</a>
  624. : Gets the time at which this instance was last modified, or 0 if unknown.
  625. </li>
  626. <li>
  627. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_modification_time">SloodleModuleSloodleObject::get_modification_time()</a>
  628. : Gets the time at which this instance was last modified, or 0 if unknown.
  629. </li>
  630. </ul>
  631. </div>
  632. <a name="methodget_name" id="get_name"><!-- --></a>
  633. <div class="evenrow">
  634. <div class="method-header">
  635. <img src="../media/images/Method.png" />
  636. <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>)
  637. </div>
  638. <!-- ========== Info from phpDoc block ========= -->
  639. <p class="short-description">Gets the name of this module instance.</p>
  640. <ul class="tags">
  641. <li><span class="field">return:</span> The name of this controller</li>
  642. </ul>
  643. <div class="method-signature">
  644. <span class="method-result">string</span>
  645. <span class="method-name">
  646. get_name
  647. </span>
  648. ()
  649. </div>
  650. <hr class="separator" />
  651. <div class="notes">Redefined in descendants as:</div>
  652. <ul class="redefinitions">
  653. <li>
  654. <a href="../sloodle/SloodleModuleAviLister.html#methodget_name">SloodleModuleAviLister::get_name()</a>
  655. : Gets the name of this module instance.
  656. </li>
  657. <li>
  658. <a href="../sloodle/SloodleModuleBlog.html#methodget_name">SloodleModuleBlog::get_name()</a>
  659. : Gets the name of this module instance.
  660. </li>
  661. <li>
  662. <a href="../sloodle/SloodleModuleChat.html#methodget_name">SloodleModuleChat::get_name()</a>
  663. : Gets the name of this module instance.
  664. </li>
  665. <li>
  666. <a href="../sloodle/SloodleModuleChoice.html#methodget_name">SloodleModuleChoice::get_name()</a>
  667. : Gets the name of this module instance.
  668. </li>
  669. <li>
  670. <a href="../sloodle/SloodleModuleDistributor.html#methodget_name">SloodleModuleDistributor::get_name()</a>
  671. : Gets the name of this module instance.
  672. </li>
  673. <li>
  674. <a href="../sloodle/SloodleModuleGlossary.html#methodget_name">SloodleModuleGlossary::get_name()</a>
  675. : Gets the name of this module instance.
  676. </li>
  677. <li>
  678. <a href="../sloodle/SloodleModuleiBank.html#methodget_name">SloodleModuleiBank::get_name()</a>
  679. : Gets the name of this module instance.
  680. </li>
  681. <li>
  682. <a href="../sloodle/SloodleModuleMap.html#methodget_name">SloodleModuleMap::get_name()</a>
  683. : Gets the name of this module instance.
  684. </li>
  685. <li>
  686. <a href="../sloodle/SloodleModulePresenter.html#methodget_name">SloodleModulePresenter::get_name()</a>
  687. : Gets the name of this module instance.
  688. </li>
  689. <li>
  690. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_name">SloodleModuleSloodleObject::get_name()</a>
  691. : Gets the name of this module instance.
  692. </li>
  693. </ul>
  694. </div>
  695. <a name="methodget_type" id="get_type"><!-- --></a>
  696. <div class="oddrow">
  697. <div class="method-header">
  698. <img src="../media/images/Method.png" />
  699. <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>)
  700. </div>
  701. <!-- ========== Info from phpDoc block ========= -->
  702. <p class="short-description">Gets the short type name of this instance.</p>
  703. <div class="method-signature">
  704. <span class="method-result">string</span>
  705. <span class="method-name">
  706. get_type
  707. </span>
  708. ()
  709. </div>
  710. <hr class="separator" />
  711. <div class="notes">Redefined in descendants as:</div>
  712. <ul class="redefinitions">
  713. <li>
  714. <a href="../sloodle/SloodleModuleAviLister.html#methodget_type">SloodleModuleAviLister::get_type()</a>
  715. : Gets the short type name of this instance.
  716. </li>
  717. <li>
  718. <a href="../sloodle/SloodleModuleBlog.html#methodget_type">SloodleModuleBlog::get_type()</a>
  719. : Gets the short type name of this instance.
  720. </li>
  721. <li>
  722. <a href="../sloodle/SloodleModuleChat.html#methodget_type">SloodleModuleChat::get_type()</a>
  723. : Gets the short type name of this instance.
  724. </li>
  725. <li>
  726. <a href="../sloodle/SloodleModuleChoice.html#methodget_type">SloodleModuleChoice::get_type()</a>
  727. : Gets the short type name of this instance.
  728. </li>
  729. <li>
  730. <a href="../sloodle/SloodleModuleDistributor.html#methodget_type">SloodleModuleDistributor::get_type()</a>
  731. : Gets the short type name of this instance.
  732. </li>
  733. <li>
  734. <a href="../sloodle/SloodleModuleGlossary.html#methodget_type">SloodleModuleGlossary::get_type()</a>
  735. : Gets the short type name of this instance.
  736. </li>
  737. <li>
  738. <a href="../sloodle/SloodleModuleiBank.html#methodget_type">SloodleModuleiBank::get_type()</a>
  739. : Gets the short type name of this instance.
  740. </li>
  741. <li>
  742. <a href="../sloodle/SloodleModuleMap.html#methodget_type">SloodleModuleMap::get_type()</a>
  743. : Gets the short type name of this instance.
  744. </li>
  745. <li>
  746. <a href="../sloodle/SloodleModulePresenter.html#methodget_type">SloodleModulePresenter::get_type()</a>
  747. : Gets the short type name of this instance.
  748. </li>
  749. <li>
  750. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_type">SloodleModuleSloodleObject::get_type()</a>
  751. : Gets the short type name of this instance.
  752. </li>
  753. </ul>
  754. </div>
  755. <a name="methodget_type_full" id="get_type_full"><!-- --></a>
  756. <div class="evenrow">
  757. <div class="method-header">
  758. <img src="../media/images/Method.png" />
  759. <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>)
  760. </div>
  761. <!-- ========== Info from phpDoc block ========= -->
  762. <p class="short-description">Gets the full type name of this instance, according to the current language pack, if available.</p>
  763. <p class="description"><p>Note: should be overridden by sub-classes.</p></p>
  764. <ul class="tags">
  765. <li><span class="field">return:</span> Full type name if possible, or the short name otherwise.</li>
  766. </ul>
  767. <div class="method-signature">
  768. <span class="method-result">string</span>
  769. <span class="method-name">
  770. get_type_full
  771. </span>
  772. ()
  773. </div>
  774. <hr class="separator" />
  775. <div class="notes">Redefined in descendants as:</div>
  776. <ul class="redefinitions">
  777. <li>
  778. <a href="../sloodle/SloodleModuleAviLister.html#methodget_type_full">SloodleModuleAviLister::get_type_full()</a>
  779. : Gets the full type name of this instance, according to the current language pack, if available.
  780. </li>
  781. <li>
  782. <a href="../sloodle/SloodleModuleBlog.html#methodget_type_full">SloodleModuleBlog::get_type_full()</a>
  783. : Gets the full type name of this instance, according to the current language pack, if available.
  784. </li>
  785. <li>
  786. <a href="../sloodle/SloodleModuleChat.html#methodget_type_full">SloodleModuleChat::get_type_full()</a>
  787. : Gets the full type name of this instance, according to the current language pack, if available.
  788. </li>
  789. <li>
  790. <a href="../sloodle/SloodleModuleChoice.html#methodget_type_full">SloodleModuleChoice::get_type_full()</a>
  791. : Gets the full type name of this instance, according to the current language pack, if available.
  792. </li>
  793. <li>
  794. <a href="../sloodle/SloodleModuleDistributor.html#methodget_type_full">SloodleModuleDistributor::get_type_full()</a>
  795. : Gets the full type name of this instance, according to the current language pack, if available.
  796. </li>
  797. <li>
  798. <a href="../sloodle/SloodleModuleGlossary.html#methodget_type_full">SloodleModuleGlossary::get_type_full()</a>
  799. : Gets the full type name of this instance, according to the current language pack, if available.
  800. </li>
  801. <li>
  802. <a href="../sloodle/SloodleModuleiBank.html#methodget_type_full">SloodleModuleiBank::get_type_full()</a>
  803. : Gets the full type name of this instance, according to the current language pack, if available.
  804. </li>
  805. <li>
  806. <a href="../sloodle/SloodleModuleMap.html#methodget_type_full">SloodleModuleMap::get_type_full()</a>
  807. : Gets the full type name of this instance, according to the current language pack, if available.
  808. </li>
  809. <li>
  810. <a href="../sloodle/SloodleModulePresenter.html#methodget_type_full">SloodleModulePresenter::get_type_full()</a>
  811. : Gets the full type name of this instance, according to the current language pack, if available.
  812. </li>
  813. <li>
  814. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_type_full">SloodleModuleSloodleObject::get_type_full()</a>
  815. : Gets the full type name of this instance, according to the current language pack, if available.
  816. </li>
  817. </ul>
  818. </div>
  819. <a name="methodload" id="load"><!-- --></a>
  820. <div class="oddrow">
  821. <div class="method-header">
  822. <img src="../media/images/Method.png" />
  823. <span class="method-title">load</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a52">52</a></span>)
  824. </div>
  825. <!-- ========== Info from phpDoc block ========= -->
  826. <p class="short-description">Loads data from the database.</p>
  827. <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>
  828. <ul class="tags">
  829. <li><span class="field">return:</span> True if successful, or false otherwise</li>
  830. </ul>
  831. <div class="method-signature">
  832. <span class="method-result">bool</span>
  833. <span class="method-name">
  834. load
  835. </span>
  836. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  837. </div>
  838. <ul class="parameters">
  839. <li>
  840. <span class="var-type">mixed</span>
  841. <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>
  842. </ul>
  843. <hr class="separator" />
  844. <div class="notes">Redefined in descendants as:</div>
  845. <ul class="redefinitions">
  846. <li>
  847. <a href="../sloodle/SloodleModuleChat.html#methodload">SloodleModuleChat::load()</a>
  848. : Loads data from the database.
  849. </li>
  850. <li>
  851. <a href="../sloodle/SloodleModuleChoice.html#methodload">SloodleModuleChoice::load()</a>
  852. : Loads data from the database.
  853. </li>
  854. <li>
  855. <a href="../sloodle/SloodleModuleDistributor.html#methodload">SloodleModuleDistributor::load()</a>
  856. : Loads data from the database.
  857. </li>
  858. <li>
  859. <a href="../sloodle/SloodleModuleGlossary.html#methodload">SloodleModuleGlossary::load()</a>
  860. : Loads data from the database.
  861. </li>
  862. <li>
  863. <a href="../sloodle/SloodleModuleiBank.html#methodload">SloodleModuleiBank::load()</a>
  864. : Loads data from the database.
  865. </li>
  866. <li>
  867. <a href="../sloodle/SloodleModuleMap.html#methodload">SloodleModuleMap::load()</a>
  868. : Loads data from the database.
  869. </li>
  870. <li>
  871. <a href="../sloodle/SloodleModulePresenter.html#methodload">SloodleModulePresenter::load()</a>
  872. : Loads data from the database.
  873. </li>
  874. <li>
  875. <a href="../sloodle/SloodleModuleSloodleObject.html#methodload">SloodleModuleSloodleObject::load()</a>
  876. : Loads data from the database.
  877. </li>
  878. </ul>
  879. </div>
  880. </div>
  881. </div>
  882. <p class="notes" id="credit">
  883. 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>
  884. </p>
  885. </div></body>
  886. </html>