SloodleModule.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851
  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/SloodleModuleSloodleObject.html">SloodleModuleSloodleObject</a>
  201. </td>
  202. <td>
  203. The Sloodle Object assignment module class.
  204. </td>
  205. </tr>
  206. </table>
  207. </div>
  208. </div>
  209. <a name="sec-var-summary"></a>
  210. <div class="info-box">
  211. <div class="info-box-title">Variable Summary</span></div>
  212. <div class="nav-bar">
  213. <a href="#sec-description">Description</a> |
  214. <a href="#sec-descendents">Descendants</a> |
  215. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  216. |
  217. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  218. </div>
  219. <div class="info-box-body">
  220. <div class="var-summary">
  221. <div class="var-title">
  222. <img src="../media/images/Variable.png" alt=" " />
  223. <span class="var-type">object</span>
  224. <a href="#$_session" title="details" class="var-name">$_session</a>
  225. </div>
  226. </div>
  227. </div>
  228. </div>
  229. <a name="sec-method-summary"></a>
  230. <div class="info-box">
  231. <div class="info-box-title">Method Summary</span></div>
  232. <div class="nav-bar">
  233. <a href="#sec-description">Description</a> |
  234. <a href="#sec-descendents">Descendants</a> |
  235. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  236. |
  237. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  238. </div>
  239. <div class="info-box-body">
  240. <div class="method-summary">
  241. <div class="method-definition">
  242. <img src="../media/images/Constructor.png" alt=" "/>
  243. <span class="method-result">SloodleModule</span>
  244. <a href="#SloodleModule" title="details" class="method-name">SloodleModule</a>
  245. (<span class="var-type">object</span>&nbsp;<span class="var-name">&$_session</span>)
  246. </div>
  247. <div class="method-definition">
  248. <img src="../media/images/Method.png" alt=" "/>
  249. <span class="method-result">mixed</span>
  250. <a href="#get_course_id" title="details" class="method-name">get_course_id</a>
  251. ()
  252. </div>
  253. <div class="method-definition">
  254. <img src="../media/images/Method.png" alt=" "/>
  255. <span class="method-result">int</span>
  256. <a href="#get_creation_time" title="details" class="method-name">get_creation_time</a>
  257. ()
  258. </div>
  259. <div class="method-definition">
  260. <img src="../media/images/Method.png" alt=" "/>
  261. <span class="method-result">string</span>
  262. <a href="#get_intro" title="details" class="method-name">get_intro</a>
  263. ()
  264. </div>
  265. <div class="method-definition">
  266. <img src="../media/images/Method.png" alt=" "/>
  267. <span class="method-result">int</span>
  268. <a href="#get_modification_time" title="details" class="method-name">get_modification_time</a>
  269. ()
  270. </div>
  271. <div class="method-definition">
  272. <img src="../media/images/Method.png" alt=" "/>
  273. <span class="method-result">string</span>
  274. <a href="#get_name" title="details" class="method-name">get_name</a>
  275. ()
  276. </div>
  277. <div class="method-definition">
  278. <img src="../media/images/Method.png" alt=" "/>
  279. <span class="method-result">string</span>
  280. <a href="#get_type" title="details" class="method-name">get_type</a>
  281. ()
  282. </div>
  283. <div class="method-definition">
  284. <img src="../media/images/Method.png" alt=" "/>
  285. <span class="method-result">string</span>
  286. <a href="#get_type_full" title="details" class="method-name">get_type_full</a>
  287. ()
  288. </div>
  289. <div class="method-definition">
  290. <img src="../media/images/Method.png" alt=" "/>
  291. <span class="method-result">bool</span>
  292. <a href="#load" title="details" class="method-name">load</a>
  293. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  294. </div>
  295. </div>
  296. </div>
  297. </div>
  298. <a name="sec-vars"></a>
  299. <div class="info-box">
  300. <div class="info-box-title">Variables</div>
  301. <div class="nav-bar">
  302. <a href="#sec-description">Description</a> |
  303. <a href="#sec-descendents">Descendents</a> |
  304. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  305. |
  306. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  307. </div>
  308. <div class="info-box-body">
  309. <a name="var$_session" id="$_session"><!-- --></A>
  310. <div class="oddrow">
  311. <div class="var-header">
  312. <img src="../media/images/Variable.png" />
  313. <span class="var-title">
  314. <span class="var-type">object</span>
  315. <span class="var-name">$_session</span>
  316. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a31">31</a></span>)
  317. </span>
  318. </div>
  319. <!-- ========== Info from phpDoc block ========= -->
  320. <p class="short-description">Reference to the containing <a href="../sloodle/SloodleSession.html">SloodleSession</a> object.</p>
  321. <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>
  322. <ul class="tags">
  323. <li><span class="field">access:</span> protected</li>
  324. </ul>
  325. </div>
  326. </div>
  327. </div>
  328. <a name="sec-methods"></a>
  329. <div class="info-box">
  330. <div class="info-box-title">Methods</div>
  331. <div class="nav-bar">
  332. <a href="#sec-description">Description</a> |
  333. <a href="#sec-descendents">Descendents</a> |
  334. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  335. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  336. </div>
  337. <div class="info-box-body">
  338. <A NAME='method_detail'></A>
  339. <a name="methodSloodleModule" id="SloodleModule"><!-- --></a>
  340. <div class="evenrow">
  341. <div class="method-header">
  342. <img src="../media/images/Constructor.png" />
  343. <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>)
  344. </div>
  345. <!-- ========== Info from phpDoc block ========= -->
  346. <p class="short-description">Constructor - initialises the session variable</p>
  347. <div class="method-signature">
  348. <span class="method-result">SloodleModule</span>
  349. <span class="method-name">
  350. SloodleModule
  351. </span>
  352. (<span class="var-type">object</span>&nbsp;<span class="var-name">&$_session</span>)
  353. </div>
  354. <ul class="parameters">
  355. <li>
  356. <span class="var-type">object</span>
  357. <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>
  358. </ul>
  359. </div>
  360. <a name="methodget_course_id" id="get_course_id"><!-- --></a>
  361. <div class="oddrow">
  362. <div class="method-header">
  363. <img src="../media/images/Method.png" />
  364. <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>)
  365. </div>
  366. <!-- ========== Info from phpDoc block ========= -->
  367. <p class="short-description">Gets the identifier of the course this controller belongs to.</p>
  368. <ul class="tags">
  369. <li><span class="field">return:</span> Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</li>
  370. </ul>
  371. <div class="method-signature">
  372. <span class="method-result">mixed</span>
  373. <span class="method-name">
  374. get_course_id
  375. </span>
  376. ()
  377. </div>
  378. <hr class="separator" />
  379. <div class="notes">Redefined in descendants as:</div>
  380. <ul class="redefinitions">
  381. <li>
  382. <a href="../sloodle/SloodleModuleBlog.html#methodget_course_id">SloodleModuleBlog::get_course_id()</a>
  383. : Gets the identifier of the course this controller belongs to.
  384. </li>
  385. <li>
  386. <a href="../sloodle/SloodleModuleChat.html#methodget_course_id">SloodleModuleChat::get_course_id()</a>
  387. : Gets the identifier of the course this controller belongs to.
  388. </li>
  389. <li>
  390. <a href="../sloodle/SloodleModuleChoice.html#methodget_course_id">SloodleModuleChoice::get_course_id()</a>
  391. : Gets the identifier of the course this controller belongs to.
  392. </li>
  393. <li>
  394. <a href="../sloodle/SloodleModuleDistributor.html#methodget_course_id">SloodleModuleDistributor::get_course_id()</a>
  395. : Gets the identifier of the course this controller belongs to.
  396. </li>
  397. <li>
  398. <a href="../sloodle/SloodleModuleGlossary.html#methodget_course_id">SloodleModuleGlossary::get_course_id()</a>
  399. : Gets the identifier of the course this controller belongs to.
  400. </li>
  401. <li>
  402. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_course_id">SloodleModuleSloodleObject::get_course_id()</a>
  403. : Gets the identifier of the course this controller belongs to.
  404. </li>
  405. </ul>
  406. </div>
  407. <a name="methodget_creation_time" id="get_creation_time"><!-- --></a>
  408. <div class="evenrow">
  409. <div class="method-header">
  410. <img src="../media/images/Method.png" />
  411. <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>)
  412. </div>
  413. <!-- ========== Info from phpDoc block ========= -->
  414. <p class="short-description">Gets the time at which this instance was created, or 0 if unknown.</p>
  415. <ul class="tags">
  416. <li><span class="field">return:</span> Timestamp</li>
  417. </ul>
  418. <div class="method-signature">
  419. <span class="method-result">int</span>
  420. <span class="method-name">
  421. get_creation_time
  422. </span>
  423. ()
  424. </div>
  425. <hr class="separator" />
  426. <div class="notes">Redefined in descendants as:</div>
  427. <ul class="redefinitions">
  428. <li>
  429. <a href="../sloodle/SloodleModuleBlog.html#methodget_creation_time">SloodleModuleBlog::get_creation_time()</a>
  430. : Gets the time at which this instance was created, or 0 if unknown.
  431. </li>
  432. <li>
  433. <a href="../sloodle/SloodleModuleChat.html#methodget_creation_time">SloodleModuleChat::get_creation_time()</a>
  434. : Gets the time at which this instance was created, or 0 if unknown.
  435. </li>
  436. <li>
  437. <a href="../sloodle/SloodleModuleChoice.html#methodget_creation_time">SloodleModuleChoice::get_creation_time()</a>
  438. : Gets the time at which this instance was created, or 0 if unknown.
  439. </li>
  440. <li>
  441. <a href="../sloodle/SloodleModuleDistributor.html#methodget_creation_time">SloodleModuleDistributor::get_creation_time()</a>
  442. : Gets the time at which this instance was created, or 0 if unknown.
  443. </li>
  444. <li>
  445. <a href="../sloodle/SloodleModuleGlossary.html#methodget_creation_time">SloodleModuleGlossary::get_creation_time()</a>
  446. : Gets the time at which this instance was created, or 0 if unknown.
  447. </li>
  448. <li>
  449. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_creation_time">SloodleModuleSloodleObject::get_creation_time()</a>
  450. : Gets the time at which this instance was created, or 0 if unknown.
  451. </li>
  452. </ul>
  453. </div>
  454. <a name="methodget_intro" id="get_intro"><!-- --></a>
  455. <div class="oddrow">
  456. <div class="method-header">
  457. <img src="../media/images/Method.png" />
  458. <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>)
  459. </div>
  460. <!-- ========== Info from phpDoc block ========= -->
  461. <p class="short-description">Gets the intro description of this module instance, if available.</p>
  462. <ul class="tags">
  463. <li><span class="field">return:</span> The intro description of this controller</li>
  464. </ul>
  465. <div class="method-signature">
  466. <span class="method-result">string</span>
  467. <span class="method-name">
  468. get_intro
  469. </span>
  470. ()
  471. </div>
  472. <hr class="separator" />
  473. <div class="notes">Redefined in descendants as:</div>
  474. <ul class="redefinitions">
  475. <li>
  476. <a href="../sloodle/SloodleModuleBlog.html#methodget_intro">SloodleModuleBlog::get_intro()</a>
  477. : Gets the intro description of this module instance, if available.
  478. </li>
  479. <li>
  480. <a href="../sloodle/SloodleModuleChat.html#methodget_intro">SloodleModuleChat::get_intro()</a>
  481. : Gets the intro description of this module instance, if available.
  482. </li>
  483. <li>
  484. <a href="../sloodle/SloodleModuleChoice.html#methodget_intro">SloodleModuleChoice::get_intro()</a>
  485. : Gets the intro description of this module instance, if available.
  486. </li>
  487. <li>
  488. <a href="../sloodle/SloodleModuleDistributor.html#methodget_intro">SloodleModuleDistributor::get_intro()</a>
  489. : Gets the intro description of this module instance, if available.
  490. </li>
  491. <li>
  492. <a href="../sloodle/SloodleModuleGlossary.html#methodget_intro">SloodleModuleGlossary::get_intro()</a>
  493. : Gets the intro description of this module instance, if available.
  494. </li>
  495. <li>
  496. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_intro">SloodleModuleSloodleObject::get_intro()</a>
  497. : Gets the intro description of this module instance, if available.
  498. </li>
  499. </ul>
  500. </div>
  501. <a name="methodget_modification_time" id="get_modification_time"><!-- --></a>
  502. <div class="evenrow">
  503. <div class="method-header">
  504. <img src="../media/images/Method.png" />
  505. <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>)
  506. </div>
  507. <!-- ========== Info from phpDoc block ========= -->
  508. <p class="short-description">Gets the time at which this instance was last modified, or 0 if unknown.</p>
  509. <ul class="tags">
  510. <li><span class="field">return:</span> Timestamp</li>
  511. </ul>
  512. <div class="method-signature">
  513. <span class="method-result">int</span>
  514. <span class="method-name">
  515. get_modification_time
  516. </span>
  517. ()
  518. </div>
  519. <hr class="separator" />
  520. <div class="notes">Redefined in descendants as:</div>
  521. <ul class="redefinitions">
  522. <li>
  523. <a href="../sloodle/SloodleModuleBlog.html#methodget_modification_time">SloodleModuleBlog::get_modification_time()</a>
  524. : Gets the time at which this instance was last modified, or 0 if unknown.
  525. </li>
  526. <li>
  527. <a href="../sloodle/SloodleModuleChat.html#methodget_modification_time">SloodleModuleChat::get_modification_time()</a>
  528. : Gets the time at which this instance was last modified, or 0 if unknown.
  529. </li>
  530. <li>
  531. <a href="../sloodle/SloodleModuleChoice.html#methodget_modification_time">SloodleModuleChoice::get_modification_time()</a>
  532. : Gets the time at which this instance was last modified, or 0 if unknown.
  533. </li>
  534. <li>
  535. <a href="../sloodle/SloodleModuleDistributor.html#methodget_modification_time">SloodleModuleDistributor::get_modification_time()</a>
  536. : Gets the time at which this instance was last modified, or 0 if unknown.
  537. </li>
  538. <li>
  539. <a href="../sloodle/SloodleModuleGlossary.html#methodget_modification_time">SloodleModuleGlossary::get_modification_time()</a>
  540. : Gets the time at which this instance was last modified, or 0 if unknown.
  541. </li>
  542. <li>
  543. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_modification_time">SloodleModuleSloodleObject::get_modification_time()</a>
  544. : Gets the time at which this instance was last modified, or 0 if unknown.
  545. </li>
  546. </ul>
  547. </div>
  548. <a name="methodget_name" id="get_name"><!-- --></a>
  549. <div class="oddrow">
  550. <div class="method-header">
  551. <img src="../media/images/Method.png" />
  552. <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>)
  553. </div>
  554. <!-- ========== Info from phpDoc block ========= -->
  555. <p class="short-description">Gets the name of this module instance.</p>
  556. <ul class="tags">
  557. <li><span class="field">return:</span> The name of this controller</li>
  558. </ul>
  559. <div class="method-signature">
  560. <span class="method-result">string</span>
  561. <span class="method-name">
  562. get_name
  563. </span>
  564. ()
  565. </div>
  566. <hr class="separator" />
  567. <div class="notes">Redefined in descendants as:</div>
  568. <ul class="redefinitions">
  569. <li>
  570. <a href="../sloodle/SloodleModuleAviLister.html#methodget_name">SloodleModuleAviLister::get_name()</a>
  571. : Gets the name of this module instance.
  572. </li>
  573. <li>
  574. <a href="../sloodle/SloodleModuleBlog.html#methodget_name">SloodleModuleBlog::get_name()</a>
  575. : Gets the name of this module instance.
  576. </li>
  577. <li>
  578. <a href="../sloodle/SloodleModuleChat.html#methodget_name">SloodleModuleChat::get_name()</a>
  579. : Gets the name of this module instance.
  580. </li>
  581. <li>
  582. <a href="../sloodle/SloodleModuleChoice.html#methodget_name">SloodleModuleChoice::get_name()</a>
  583. : Gets the name of this module instance.
  584. </li>
  585. <li>
  586. <a href="../sloodle/SloodleModuleDistributor.html#methodget_name">SloodleModuleDistributor::get_name()</a>
  587. : Gets the name of this module instance.
  588. </li>
  589. <li>
  590. <a href="../sloodle/SloodleModuleGlossary.html#methodget_name">SloodleModuleGlossary::get_name()</a>
  591. : Gets the name of this module instance.
  592. </li>
  593. <li>
  594. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_name">SloodleModuleSloodleObject::get_name()</a>
  595. : Gets the name of this module instance.
  596. </li>
  597. </ul>
  598. </div>
  599. <a name="methodget_type" id="get_type"><!-- --></a>
  600. <div class="evenrow">
  601. <div class="method-header">
  602. <img src="../media/images/Method.png" />
  603. <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>)
  604. </div>
  605. <!-- ========== Info from phpDoc block ========= -->
  606. <p class="short-description">Gets the short type name of this instance.</p>
  607. <div class="method-signature">
  608. <span class="method-result">string</span>
  609. <span class="method-name">
  610. get_type
  611. </span>
  612. ()
  613. </div>
  614. <hr class="separator" />
  615. <div class="notes">Redefined in descendants as:</div>
  616. <ul class="redefinitions">
  617. <li>
  618. <a href="../sloodle/SloodleModuleAviLister.html#methodget_type">SloodleModuleAviLister::get_type()</a>
  619. : Gets the short type name of this instance.
  620. </li>
  621. <li>
  622. <a href="../sloodle/SloodleModuleBlog.html#methodget_type">SloodleModuleBlog::get_type()</a>
  623. : Gets the short type name of this instance.
  624. </li>
  625. <li>
  626. <a href="../sloodle/SloodleModuleChat.html#methodget_type">SloodleModuleChat::get_type()</a>
  627. : Gets the short type name of this instance.
  628. </li>
  629. <li>
  630. <a href="../sloodle/SloodleModuleChoice.html#methodget_type">SloodleModuleChoice::get_type()</a>
  631. : Gets the short type name of this instance.
  632. </li>
  633. <li>
  634. <a href="../sloodle/SloodleModuleDistributor.html#methodget_type">SloodleModuleDistributor::get_type()</a>
  635. : Gets the short type name of this instance.
  636. </li>
  637. <li>
  638. <a href="../sloodle/SloodleModuleGlossary.html#methodget_type">SloodleModuleGlossary::get_type()</a>
  639. : Gets the short type name of this instance.
  640. </li>
  641. <li>
  642. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_type">SloodleModuleSloodleObject::get_type()</a>
  643. : Gets the short type name of this instance.
  644. </li>
  645. </ul>
  646. </div>
  647. <a name="methodget_type_full" id="get_type_full"><!-- --></a>
  648. <div class="oddrow">
  649. <div class="method-header">
  650. <img src="../media/images/Method.png" />
  651. <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>)
  652. </div>
  653. <!-- ========== Info from phpDoc block ========= -->
  654. <p class="short-description">Gets the full type name of this instance, according to the current language pack, if available.</p>
  655. <p class="description"><p>Note: should be overridden by sub-classes.</p></p>
  656. <ul class="tags">
  657. <li><span class="field">return:</span> Full type name if possible, or the short name otherwise.</li>
  658. </ul>
  659. <div class="method-signature">
  660. <span class="method-result">string</span>
  661. <span class="method-name">
  662. get_type_full
  663. </span>
  664. ()
  665. </div>
  666. <hr class="separator" />
  667. <div class="notes">Redefined in descendants as:</div>
  668. <ul class="redefinitions">
  669. <li>
  670. <a href="../sloodle/SloodleModuleAviLister.html#methodget_type_full">SloodleModuleAviLister::get_type_full()</a>
  671. : Gets the full type name of this instance, according to the current language pack, if available.
  672. </li>
  673. <li>
  674. <a href="../sloodle/SloodleModuleBlog.html#methodget_type_full">SloodleModuleBlog::get_type_full()</a>
  675. : Gets the full type name of this instance, according to the current language pack, if available.
  676. </li>
  677. <li>
  678. <a href="../sloodle/SloodleModuleChat.html#methodget_type_full">SloodleModuleChat::get_type_full()</a>
  679. : Gets the full type name of this instance, according to the current language pack, if available.
  680. </li>
  681. <li>
  682. <a href="../sloodle/SloodleModuleChoice.html#methodget_type_full">SloodleModuleChoice::get_type_full()</a>
  683. : Gets the full type name of this instance, according to the current language pack, if available.
  684. </li>
  685. <li>
  686. <a href="../sloodle/SloodleModuleDistributor.html#methodget_type_full">SloodleModuleDistributor::get_type_full()</a>
  687. : Gets the full type name of this instance, according to the current language pack, if available.
  688. </li>
  689. <li>
  690. <a href="../sloodle/SloodleModuleGlossary.html#methodget_type_full">SloodleModuleGlossary::get_type_full()</a>
  691. : Gets the full type name of this instance, according to the current language pack, if available.
  692. </li>
  693. <li>
  694. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_type_full">SloodleModuleSloodleObject::get_type_full()</a>
  695. : Gets the full type name of this instance, according to the current language pack, if available.
  696. </li>
  697. </ul>
  698. </div>
  699. <a name="methodload" id="load"><!-- --></a>
  700. <div class="evenrow">
  701. <div class="method-header">
  702. <img src="../media/images/Method.png" />
  703. <span class="method-title">load</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_base.php.html#a52">52</a></span>)
  704. </div>
  705. <!-- ========== Info from phpDoc block ========= -->
  706. <p class="short-description">Loads data from the database.</p>
  707. <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>
  708. <ul class="tags">
  709. <li><span class="field">return:</span> True if successful, or false otherwise</li>
  710. </ul>
  711. <div class="method-signature">
  712. <span class="method-result">bool</span>
  713. <span class="method-name">
  714. load
  715. </span>
  716. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  717. </div>
  718. <ul class="parameters">
  719. <li>
  720. <span class="var-type">mixed</span>
  721. <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>
  722. </ul>
  723. <hr class="separator" />
  724. <div class="notes">Redefined in descendants as:</div>
  725. <ul class="redefinitions">
  726. <li>
  727. <a href="../sloodle/SloodleModuleChat.html#methodload">SloodleModuleChat::load()</a>
  728. : Loads data from the database.
  729. </li>
  730. <li>
  731. <a href="../sloodle/SloodleModuleChoice.html#methodload">SloodleModuleChoice::load()</a>
  732. : Loads data from the database.
  733. </li>
  734. <li>
  735. <a href="../sloodle/SloodleModuleDistributor.html#methodload">SloodleModuleDistributor::load()</a>
  736. : Loads data from the database.
  737. </li>
  738. <li>
  739. <a href="../sloodle/SloodleModuleGlossary.html#methodload">SloodleModuleGlossary::load()</a>
  740. : Loads data from the database.
  741. </li>
  742. <li>
  743. <a href="../sloodle/SloodleModuleSloodleObject.html#methodload">SloodleModuleSloodleObject::load()</a>
  744. : Loads data from the database.
  745. </li>
  746. </ul>
  747. </div>
  748. </div>
  749. </div>
  750. <p class="notes" id="credit">
  751. Documentation generated on Mon, 07 Jul 2008 12:32:49 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  752. </p>
  753. </div></body>
  754. </html>