SloodleModule.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743
  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="_sloodle---lib---modules---module_base.php.html">/sloodle/lib/modules/module_base.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_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/SloodleModuleChat.html">SloodleModuleChat</a>
  129. </td>
  130. <td>
  131. The Sloodle chat 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/SloodleModuleDistributor.html">SloodleModuleDistributor</a>
  141. </td>
  142. <td>
  143. The Sloodle Distributor 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/SloodleModuleGlossary.html">SloodleModuleGlossary</a>
  153. </td>
  154. <td>
  155. The Sloodle glossary 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/SloodleModuleSloodleObject.html">SloodleModuleSloodleObject</a>
  165. </td>
  166. <td>
  167. The Sloodle Object assignment module class.
  168. </td>
  169. </tr>
  170. </table>
  171. </div>
  172. </div>
  173. <a name="sec-var-summary"></a>
  174. <div class="info-box">
  175. <div class="info-box-title">Variable Summary</span></div>
  176. <div class="nav-bar">
  177. <a href="#sec-description">Description</a> |
  178. <a href="#sec-descendents">Descendants</a> |
  179. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  180. |
  181. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  182. </div>
  183. <div class="info-box-body">
  184. <div class="var-summary">
  185. <div class="var-title">
  186. <img src="../media/images/Variable.png" alt=" " />
  187. <span class="var-type">object</span>
  188. <a href="#$_session" title="details" class="var-name">$_session</a>
  189. </div>
  190. </div>
  191. </div>
  192. </div>
  193. <a name="sec-method-summary"></a>
  194. <div class="info-box">
  195. <div class="info-box-title">Method Summary</span></div>
  196. <div class="nav-bar">
  197. <a href="#sec-description">Description</a> |
  198. <a href="#sec-descendents">Descendants</a> |
  199. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  200. |
  201. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  202. </div>
  203. <div class="info-box-body">
  204. <div class="method-summary">
  205. <div class="method-definition">
  206. <img src="../media/images/Constructor.png" alt=" "/>
  207. <span class="method-result">SloodleModule</span>
  208. <a href="#SloodleModule" title="details" class="method-name">SloodleModule</a>
  209. (<span class="var-type">object</span>&nbsp;<span class="var-name">&$_session</span>)
  210. </div>
  211. <div class="method-definition">
  212. <img src="../media/images/Method.png" alt=" "/>
  213. <span class="method-result">mixed</span>
  214. <a href="#get_course_id" title="details" class="method-name">get_course_id</a>
  215. ()
  216. </div>
  217. <div class="method-definition">
  218. <img src="../media/images/Method.png" alt=" "/>
  219. <span class="method-result">int</span>
  220. <a href="#get_creation_time" title="details" class="method-name">get_creation_time</a>
  221. ()
  222. </div>
  223. <div class="method-definition">
  224. <img src="../media/images/Method.png" alt=" "/>
  225. <span class="method-result">string</span>
  226. <a href="#get_intro" title="details" class="method-name">get_intro</a>
  227. ()
  228. </div>
  229. <div class="method-definition">
  230. <img src="../media/images/Method.png" alt=" "/>
  231. <span class="method-result">int</span>
  232. <a href="#get_modification_time" title="details" class="method-name">get_modification_time</a>
  233. ()
  234. </div>
  235. <div class="method-definition">
  236. <img src="../media/images/Method.png" alt=" "/>
  237. <span class="method-result">string</span>
  238. <a href="#get_name" title="details" class="method-name">get_name</a>
  239. ()
  240. </div>
  241. <div class="method-definition">
  242. <img src="../media/images/Method.png" alt=" "/>
  243. <span class="method-result">string</span>
  244. <a href="#get_type" title="details" class="method-name">get_type</a>
  245. ()
  246. </div>
  247. <div class="method-definition">
  248. <img src="../media/images/Method.png" alt=" "/>
  249. <span class="method-result">string</span>
  250. <a href="#get_type_full" title="details" class="method-name">get_type_full</a>
  251. ()
  252. </div>
  253. <div class="method-definition">
  254. <img src="../media/images/Method.png" alt=" "/>
  255. <span class="method-result">bool</span>
  256. <a href="#load" title="details" class="method-name">load</a>
  257. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  258. </div>
  259. </div>
  260. </div>
  261. </div>
  262. <a name="sec-vars"></a>
  263. <div class="info-box">
  264. <div class="info-box-title">Variables</div>
  265. <div class="nav-bar">
  266. <a href="#sec-description">Description</a> |
  267. <a href="#sec-descendents">Descendents</a> |
  268. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  269. |
  270. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  271. </div>
  272. <div class="info-box-body">
  273. <a name="var$_session" id="$_session"><!-- --></A>
  274. <div class="evenrow">
  275. <div class="var-header">
  276. <img src="../media/images/Variable.png" />
  277. <span class="var-title">
  278. <span class="var-type">object</span>
  279. <span class="var-name">$_session</span>
  280. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_base.php.html#a31">31</a></span>)
  281. </span>
  282. </div>
  283. <!-- ========== Info from phpDoc block ========= -->
  284. <p class="short-description">Reference to the containing <a href="../sloodle/SloodleSession.html">SloodleSession</a> object.</p>
  285. <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>
  286. <ul class="tags">
  287. <li><span class="field">access:</span> protected</li>
  288. </ul>
  289. </div>
  290. </div>
  291. </div>
  292. <a name="sec-methods"></a>
  293. <div class="info-box">
  294. <div class="info-box-title">Methods</div>
  295. <div class="nav-bar">
  296. <a href="#sec-description">Description</a> |
  297. <a href="#sec-descendents">Descendents</a> |
  298. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  299. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  300. </div>
  301. <div class="info-box-body">
  302. <A NAME='method_detail'></A>
  303. <a name="methodSloodleModule" id="SloodleModule"><!-- --></a>
  304. <div class="oddrow">
  305. <div class="method-header">
  306. <img src="../media/images/Constructor.png" />
  307. <span class="method-title">Constructor SloodleModule</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_base.php.html#a40">40</a></span>)
  308. </div>
  309. <!-- ========== Info from phpDoc block ========= -->
  310. <p class="short-description">Constructor - initialises the session variable</p>
  311. <div class="method-signature">
  312. <span class="method-result">SloodleModule</span>
  313. <span class="method-name">
  314. SloodleModule
  315. </span>
  316. (<span class="var-type">object</span>&nbsp;<span class="var-name">&$_session</span>)
  317. </div>
  318. <ul class="parameters">
  319. <li>
  320. <span class="var-type">object</span>
  321. <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>
  322. </ul>
  323. </div>
  324. <a name="methodget_course_id" id="get_course_id"><!-- --></a>
  325. <div class="evenrow">
  326. <div class="method-header">
  327. <img src="../media/images/Method.png" />
  328. <span class="method-title">get_course_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_base.php.html#a82">82</a></span>)
  329. </div>
  330. <!-- ========== Info from phpDoc block ========= -->
  331. <p class="short-description">Gets the identifier of the course this controller belongs to.</p>
  332. <ul class="tags">
  333. <li><span class="field">return:</span> Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</li>
  334. </ul>
  335. <div class="method-signature">
  336. <span class="method-result">mixed</span>
  337. <span class="method-name">
  338. get_course_id
  339. </span>
  340. ()
  341. </div>
  342. <hr class="separator" />
  343. <div class="notes">Redefined in descendants as:</div>
  344. <ul class="redefinitions">
  345. <li>
  346. <a href="../sloodle/SloodleModuleChat.html#methodget_course_id">SloodleModuleChat::get_course_id()</a>
  347. : Gets the identifier of the course this controller belongs to.
  348. </li>
  349. <li>
  350. <a href="../sloodle/SloodleModuleDistributor.html#methodget_course_id">SloodleModuleDistributor::get_course_id()</a>
  351. : Gets the identifier of the course this controller belongs to.
  352. </li>
  353. <li>
  354. <a href="../sloodle/SloodleModuleGlossary.html#methodget_course_id">SloodleModuleGlossary::get_course_id()</a>
  355. : Gets the identifier of the course this controller belongs to.
  356. </li>
  357. <li>
  358. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_course_id">SloodleModuleSloodleObject::get_course_id()</a>
  359. : Gets the identifier of the course this controller belongs to.
  360. </li>
  361. </ul>
  362. </div>
  363. <a name="methodget_creation_time" id="get_creation_time"><!-- --></a>
  364. <div class="oddrow">
  365. <div class="method-header">
  366. <img src="../media/images/Method.png" />
  367. <span class="method-title">get_creation_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_base.php.html#a91">91</a></span>)
  368. </div>
  369. <!-- ========== Info from phpDoc block ========= -->
  370. <p class="short-description">Gets the time at which this instance was created, or 0 if unknown.</p>
  371. <ul class="tags">
  372. <li><span class="field">return:</span> Timestamp</li>
  373. </ul>
  374. <div class="method-signature">
  375. <span class="method-result">int</span>
  376. <span class="method-name">
  377. get_creation_time
  378. </span>
  379. ()
  380. </div>
  381. <hr class="separator" />
  382. <div class="notes">Redefined in descendants as:</div>
  383. <ul class="redefinitions">
  384. <li>
  385. <a href="../sloodle/SloodleModuleChat.html#methodget_creation_time">SloodleModuleChat::get_creation_time()</a>
  386. : Gets the time at which this instance was created, or 0 if unknown.
  387. </li>
  388. <li>
  389. <a href="../sloodle/SloodleModuleDistributor.html#methodget_creation_time">SloodleModuleDistributor::get_creation_time()</a>
  390. : Gets the time at which this instance was created, or 0 if unknown.
  391. </li>
  392. <li>
  393. <a href="../sloodle/SloodleModuleGlossary.html#methodget_creation_time">SloodleModuleGlossary::get_creation_time()</a>
  394. : Gets the time at which this instance was created, or 0 if unknown.
  395. </li>
  396. <li>
  397. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_creation_time">SloodleModuleSloodleObject::get_creation_time()</a>
  398. : Gets the time at which this instance was created, or 0 if unknown.
  399. </li>
  400. </ul>
  401. </div>
  402. <a name="methodget_intro" id="get_intro"><!-- --></a>
  403. <div class="evenrow">
  404. <div class="method-header">
  405. <img src="../media/images/Method.png" />
  406. <span class="method-title">get_intro</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_base.php.html#a73">73</a></span>)
  407. </div>
  408. <!-- ========== Info from phpDoc block ========= -->
  409. <p class="short-description">Gets the intro description of this module instance, if available.</p>
  410. <ul class="tags">
  411. <li><span class="field">return:</span> The intro description of this controller</li>
  412. </ul>
  413. <div class="method-signature">
  414. <span class="method-result">string</span>
  415. <span class="method-name">
  416. get_intro
  417. </span>
  418. ()
  419. </div>
  420. <hr class="separator" />
  421. <div class="notes">Redefined in descendants as:</div>
  422. <ul class="redefinitions">
  423. <li>
  424. <a href="../sloodle/SloodleModuleChat.html#methodget_intro">SloodleModuleChat::get_intro()</a>
  425. : Gets the intro description of this module instance, if available.
  426. </li>
  427. <li>
  428. <a href="../sloodle/SloodleModuleDistributor.html#methodget_intro">SloodleModuleDistributor::get_intro()</a>
  429. : Gets the intro description of this module instance, if available.
  430. </li>
  431. <li>
  432. <a href="../sloodle/SloodleModuleGlossary.html#methodget_intro">SloodleModuleGlossary::get_intro()</a>
  433. : Gets the intro description of this module instance, if available.
  434. </li>
  435. <li>
  436. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_intro">SloodleModuleSloodleObject::get_intro()</a>
  437. : Gets the intro description of this module instance, if available.
  438. </li>
  439. </ul>
  440. </div>
  441. <a name="methodget_modification_time" id="get_modification_time"><!-- --></a>
  442. <div class="oddrow">
  443. <div class="method-header">
  444. <img src="../media/images/Method.png" />
  445. <span class="method-title">get_modification_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_base.php.html#a100">100</a></span>)
  446. </div>
  447. <!-- ========== Info from phpDoc block ========= -->
  448. <p class="short-description">Gets the time at which this instance was last modified, or 0 if unknown.</p>
  449. <ul class="tags">
  450. <li><span class="field">return:</span> Timestamp</li>
  451. </ul>
  452. <div class="method-signature">
  453. <span class="method-result">int</span>
  454. <span class="method-name">
  455. get_modification_time
  456. </span>
  457. ()
  458. </div>
  459. <hr class="separator" />
  460. <div class="notes">Redefined in descendants as:</div>
  461. <ul class="redefinitions">
  462. <li>
  463. <a href="../sloodle/SloodleModuleChat.html#methodget_modification_time">SloodleModuleChat::get_modification_time()</a>
  464. : Gets the time at which this instance was last modified, or 0 if unknown.
  465. </li>
  466. <li>
  467. <a href="../sloodle/SloodleModuleDistributor.html#methodget_modification_time">SloodleModuleDistributor::get_modification_time()</a>
  468. : Gets the time at which this instance was last modified, or 0 if unknown.
  469. </li>
  470. <li>
  471. <a href="../sloodle/SloodleModuleGlossary.html#methodget_modification_time">SloodleModuleGlossary::get_modification_time()</a>
  472. : Gets the time at which this instance was last modified, or 0 if unknown.
  473. </li>
  474. <li>
  475. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_modification_time">SloodleModuleSloodleObject::get_modification_time()</a>
  476. : Gets the time at which this instance was last modified, or 0 if unknown.
  477. </li>
  478. </ul>
  479. </div>
  480. <a name="methodget_name" id="get_name"><!-- --></a>
  481. <div class="evenrow">
  482. <div class="method-header">
  483. <img src="../media/images/Method.png" />
  484. <span class="method-title">get_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_base.php.html#a64">64</a></span>)
  485. </div>
  486. <!-- ========== Info from phpDoc block ========= -->
  487. <p class="short-description">Gets the name of this module instance.</p>
  488. <ul class="tags">
  489. <li><span class="field">return:</span> The name of this controller</li>
  490. </ul>
  491. <div class="method-signature">
  492. <span class="method-result">string</span>
  493. <span class="method-name">
  494. get_name
  495. </span>
  496. ()
  497. </div>
  498. <hr class="separator" />
  499. <div class="notes">Redefined in descendants as:</div>
  500. <ul class="redefinitions">
  501. <li>
  502. <a href="../sloodle/SloodleModuleChat.html#methodget_name">SloodleModuleChat::get_name()</a>
  503. : Gets the name of this module instance.
  504. </li>
  505. <li>
  506. <a href="../sloodle/SloodleModuleDistributor.html#methodget_name">SloodleModuleDistributor::get_name()</a>
  507. : Gets the name of this module instance.
  508. </li>
  509. <li>
  510. <a href="../sloodle/SloodleModuleGlossary.html#methodget_name">SloodleModuleGlossary::get_name()</a>
  511. : Gets the name of this module instance.
  512. </li>
  513. <li>
  514. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_name">SloodleModuleSloodleObject::get_name()</a>
  515. : Gets the name of this module instance.
  516. </li>
  517. </ul>
  518. </div>
  519. <a name="methodget_type" id="get_type"><!-- --></a>
  520. <div class="oddrow">
  521. <div class="method-header">
  522. <img src="../media/images/Method.png" />
  523. <span class="method-title">get_type</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_base.php.html#a110">110</a></span>)
  524. </div>
  525. <!-- ========== Info from phpDoc block ========= -->
  526. <p class="short-description">Gets the short type name of this instance.</p>
  527. <div class="method-signature">
  528. <span class="method-result">string</span>
  529. <span class="method-name">
  530. get_type
  531. </span>
  532. ()
  533. </div>
  534. <hr class="separator" />
  535. <div class="notes">Redefined in descendants as:</div>
  536. <ul class="redefinitions">
  537. <li>
  538. <a href="../sloodle/SloodleModuleChat.html#methodget_type">SloodleModuleChat::get_type()</a>
  539. : Gets the short type name of this instance.
  540. </li>
  541. <li>
  542. <a href="../sloodle/SloodleModuleDistributor.html#methodget_type">SloodleModuleDistributor::get_type()</a>
  543. : Gets the short type name of this instance.
  544. </li>
  545. <li>
  546. <a href="../sloodle/SloodleModuleGlossary.html#methodget_type">SloodleModuleGlossary::get_type()</a>
  547. : Gets the short type name of this instance.
  548. </li>
  549. <li>
  550. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_type">SloodleModuleSloodleObject::get_type()</a>
  551. : Gets the short type name of this instance.
  552. </li>
  553. </ul>
  554. </div>
  555. <a name="methodget_type_full" id="get_type_full"><!-- --></a>
  556. <div class="evenrow">
  557. <div class="method-header">
  558. <img src="../media/images/Method.png" />
  559. <span class="method-title">get_type_full</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_base.php.html#a120">120</a></span>)
  560. </div>
  561. <!-- ========== Info from phpDoc block ========= -->
  562. <p class="short-description">Gets the full type name of this instance, according to the current language pack, if available.</p>
  563. <p class="description"><p>Note: should be overridden by sub-classes.</p></p>
  564. <ul class="tags">
  565. <li><span class="field">return:</span> Full type name if possible, or the short name otherwise.</li>
  566. </ul>
  567. <div class="method-signature">
  568. <span class="method-result">string</span>
  569. <span class="method-name">
  570. get_type_full
  571. </span>
  572. ()
  573. </div>
  574. <hr class="separator" />
  575. <div class="notes">Redefined in descendants as:</div>
  576. <ul class="redefinitions">
  577. <li>
  578. <a href="../sloodle/SloodleModuleChat.html#methodget_type_full">SloodleModuleChat::get_type_full()</a>
  579. : Gets the full type name of this instance, according to the current language pack, if available.
  580. </li>
  581. <li>
  582. <a href="../sloodle/SloodleModuleDistributor.html#methodget_type_full">SloodleModuleDistributor::get_type_full()</a>
  583. : Gets the full type name of this instance, according to the current language pack, if available.
  584. </li>
  585. <li>
  586. <a href="../sloodle/SloodleModuleGlossary.html#methodget_type_full">SloodleModuleGlossary::get_type_full()</a>
  587. : Gets the full type name of this instance, according to the current language pack, if available.
  588. </li>
  589. <li>
  590. <a href="../sloodle/SloodleModuleSloodleObject.html#methodget_type_full">SloodleModuleSloodleObject::get_type_full()</a>
  591. : Gets the full type name of this instance, according to the current language pack, if available.
  592. </li>
  593. </ul>
  594. </div>
  595. <a name="methodload" id="load"><!-- --></a>
  596. <div class="oddrow">
  597. <div class="method-header">
  598. <img src="../media/images/Method.png" />
  599. <span class="method-title">load</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmodulesmodule_base.php.html#a52">52</a></span>)
  600. </div>
  601. <!-- ========== Info from phpDoc block ========= -->
  602. <p class="short-description">Loads data from the database.</p>
  603. <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>
  604. <ul class="tags">
  605. <li><span class="field">return:</span> True if successful, or false otherwise</li>
  606. </ul>
  607. <div class="method-signature">
  608. <span class="method-result">bool</span>
  609. <span class="method-name">
  610. load
  611. </span>
  612. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  613. </div>
  614. <ul class="parameters">
  615. <li>
  616. <span class="var-type">mixed</span>
  617. <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>
  618. </ul>
  619. <hr class="separator" />
  620. <div class="notes">Redefined in descendants as:</div>
  621. <ul class="redefinitions">
  622. <li>
  623. <a href="../sloodle/SloodleModuleChat.html#methodload">SloodleModuleChat::load()</a>
  624. : Loads data from the database.
  625. </li>
  626. <li>
  627. <a href="../sloodle/SloodleModuleDistributor.html#methodload">SloodleModuleDistributor::load()</a>
  628. : Loads data from the database.
  629. </li>
  630. <li>
  631. <a href="../sloodle/SloodleModuleGlossary.html#methodload">SloodleModuleGlossary::load()</a>
  632. : Loads data from the database.
  633. </li>
  634. <li>
  635. <a href="../sloodle/SloodleModuleSloodleObject.html#methodload">SloodleModuleSloodleObject::load()</a>
  636. : Loads data from the database.
  637. </li>
  638. </ul>
  639. </div>
  640. </div>
  641. </div>
  642. <p class="notes" id="credit">
  643. Documentation generated on Mon, 16 Jun 2008 15:56:43 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  644. </p>
  645. </div></body>
  646. </html>