SloodleModuleiBank.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788
  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 SloodleModuleiBank</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"> SloodleModuleiBank</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  94. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  95. </div>
  96. <div class="info-box-body">
  97. <!-- ========== Info from phpDoc block ========= -->
  98. <p class="short-description">The Sloodle StipendGiver module class.</p>
  99. <p class="notes">
  100. Located in <a class="field" href="_lib---modules---module_ibank.php.html">/lib/modules/module_ibank.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a31">31</a></span>)
  101. </p>
  102. <pre><a href="../sloodle/SloodleModule.html">SloodleModule</a>
  103. |
  104. --SloodleModuleiBank</pre>
  105. </div>
  106. </div>
  107. <a name="sec-var-summary"></a>
  108. <div class="info-box">
  109. <div class="info-box-title">Variable Summary</span></div>
  110. <div class="nav-bar">
  111. <a href="#sec-description">Description</a> |
  112. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  113. |
  114. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  115. </div>
  116. <div class="info-box-body">
  117. <div class="var-summary">
  118. <div class="var-title">
  119. <img src="../media/images/PrivateVariable.png" alt=" " />
  120. <span class="var-type">object</span>
  121. <a href="#$cm" title="details" class="var-name">$cm</a>
  122. </div>
  123. <div class="var-title">
  124. <img src="../media/images/Variable.png" alt=" " />
  125. <span class="var-type">mixed</span>
  126. <a href="#$sCourseObj" title="details" class="var-name">$sCourseObj</a>
  127. </div>
  128. <div class="var-title">
  129. <img src="../media/images/Variable.png" alt=" " />
  130. <span class="var-type">mixed</span>
  131. <a href="#$sloodleid" title="details" class="var-name">$sloodleid</a>
  132. </div>
  133. <div class="var-title">
  134. <img src="../media/images/PrivateVariable.png" alt=" " />
  135. <span class="var-type">object</span>
  136. <a href="#$sloodle_module_instance" title="details" class="var-name">$sloodle_module_instance</a>
  137. </div>
  138. <div class="var-title">
  139. <img src="../media/images/PrivateVariable.png" alt=" " />
  140. <span class="var-type">object</span>
  141. <a href="#$sloodle_stipendgiver_instance" title="details" class="var-name">$sloodle_stipendgiver_instance</a>
  142. </div>
  143. </div>
  144. </div>
  145. </div>
  146. <a name="sec-method-summary"></a>
  147. <div class="info-box">
  148. <div class="info-box-title">Method Summary</span></div>
  149. <div class="nav-bar">
  150. <a href="#sec-description">Description</a> |
  151. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  152. |
  153. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  154. </div>
  155. <div class="info-box-body">
  156. <div class="method-summary">
  157. <div class="method-definition">
  158. <img src="../media/images/Constructor.png" alt=" "/>
  159. <span class="method-result">SloodleModuleiBank</span>
  160. <a href="#SloodleModuleiBank" title="details" class="method-name">SloodleModuleiBank</a>
  161. (<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
  162. </div>
  163. <div class="method-definition">
  164. <img src="../media/images/Method.png" alt=" "/>
  165. <span class="method-result">void</span>
  166. <a href="#get_amount" title="details" class="method-name">get_amount</a>
  167. ()
  168. </div>
  169. <div class="method-definition">
  170. <img src="../media/images/Method.png" alt=" "/>
  171. <span class="method-result">void</span>
  172. <a href="#get_class_list" title="details" class="method-name">get_class_list</a>
  173. ()
  174. </div>
  175. <div class="method-definition">
  176. <img src="../media/images/Method.png" alt=" "/>
  177. <span class="method-result">mixed</span>
  178. <a href="#get_course_id" title="details" class="method-name">get_course_id</a>
  179. ()
  180. </div>
  181. <div class="method-definition">
  182. <img src="../media/images/Method.png" alt=" "/>
  183. <span class="method-result">int</span>
  184. <a href="#get_creation_time" title="details" class="method-name">get_creation_time</a>
  185. ()
  186. </div>
  187. <div class="method-definition">
  188. <img src="../media/images/Method.png" alt=" "/>
  189. <span class="method-result">string</span>
  190. <a href="#get_intro" title="details" class="method-name">get_intro</a>
  191. ()
  192. </div>
  193. <div class="method-definition">
  194. <img src="../media/images/Method.png" alt=" "/>
  195. <span class="method-result">int</span>
  196. <a href="#get_modification_time" title="details" class="method-name">get_modification_time</a>
  197. ()
  198. </div>
  199. <div class="method-definition">
  200. <img src="../media/images/Method.png" alt=" "/>
  201. <span class="method-result">string</span>
  202. <a href="#get_name" title="details" class="method-name">get_name</a>
  203. ()
  204. </div>
  205. <div class="method-definition">
  206. <img src="../media/images/Method.png" alt=" "/>
  207. <span class="method-result">array</span>
  208. <a href="#get_objects" title="details" class="method-name">get_objects</a>
  209. ()
  210. </div>
  211. <div class="method-definition">
  212. <img src="../media/images/Method.png" alt=" "/>
  213. <span class="method-result">string</span>
  214. <a href="#get_type" title="details" class="method-name">get_type</a>
  215. ()
  216. </div>
  217. <div class="method-definition">
  218. <img src="../media/images/Method.png" alt=" "/>
  219. <span class="method-result">string</span>
  220. <a href="#get_type_full" title="details" class="method-name">get_type_full</a>
  221. ()
  222. </div>
  223. <div class="method-definition">
  224. <img src="../media/images/Method.png" alt=" "/>
  225. <span class="method-result">bool</span>
  226. <a href="#load" title="details" class="method-name">load</a>
  227. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  228. </div>
  229. </div>
  230. </div>
  231. </div>
  232. <a name="sec-vars"></a>
  233. <div class="info-box">
  234. <div class="info-box-title">Variables</div>
  235. <div class="nav-bar">
  236. <a href="#sec-description">Description</a> |
  237. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  238. |
  239. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  240. </div>
  241. <div class="info-box-body">
  242. <a name="var$cm" id="$cm"><!-- --></A>
  243. <div class="evenrow">
  244. <div class="var-header">
  245. <img src="../media/images/PrivateVariable.png" />
  246. <span class="var-title">
  247. <span class="var-type">object</span>
  248. <span class="var-name">$cm</span>
  249. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a41">41</a></span>)
  250. </span>
  251. </div>
  252. <!-- ========== Info from phpDoc block ========= -->
  253. <p class="short-description">Internal for Moodle only - course module instance.</p>
  254. <p class="description"><p>Corresponds to one record from the Moodle 'course_modules' table.</p></p>
  255. <ul class="tags">
  256. <li><span class="field">access:</span> private</li>
  257. </ul>
  258. </div>
  259. <a name="var$sCourseObj" id="$sCourseObj"><!-- --></A>
  260. <div class="oddrow">
  261. <div class="var-header">
  262. <img src="../media/images/Variable.png" />
  263. <span class="var-title">
  264. <span class="var-type">mixed</span>
  265. <span class="var-name">$sCourseObj</span>
  266. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a59">59</a></span>)
  267. </span>
  268. </div>
  269. <!-- ========== Info from phpDoc block ========= -->
  270. </div>
  271. <a name="var$sloodleid" id="$sloodleid"><!-- --></A>
  272. <div class="evenrow">
  273. <div class="var-header">
  274. <img src="../media/images/Variable.png" />
  275. <span class="var-title">
  276. <span class="var-type">mixed</span>
  277. <span class="var-name">$sloodleid</span>
  278. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a63">63</a></span>)
  279. </span>
  280. </div>
  281. <!-- ========== Info from phpDoc block ========= -->
  282. </div>
  283. <a name="var$sloodle_module_instance" id="$sloodle_module_instance"><!-- --></A>
  284. <div class="oddrow">
  285. <div class="var-header">
  286. <img src="../media/images/PrivateVariable.png" />
  287. <span class="var-title">
  288. <span class="var-type">object</span>
  289. <span class="var-name">$sloodle_module_instance</span>
  290. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a49">49</a></span>)
  291. </span>
  292. </div>
  293. <!-- ========== Info from phpDoc block ========= -->
  294. <p class="short-description">Internal only - Sloodle module instance database object.</p>
  295. <p class="description"><p>Corresponds to one record from the Moodle 'sloodle' table.</p></p>
  296. <ul class="tags">
  297. <li><span class="field">access:</span> private</li>
  298. </ul>
  299. </div>
  300. <a name="var$sloodle_stipendgiver_instance" id="$sloodle_stipendgiver_instance"><!-- --></A>
  301. <div class="evenrow">
  302. <div class="var-header">
  303. <img src="../media/images/PrivateVariable.png" />
  304. <span class="var-title">
  305. <span class="var-type">object</span>
  306. <span class="var-name">$sloodle_stipendgiver_instance</span>
  307. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a57">57</a></span>)
  308. </span>
  309. </div>
  310. <!-- ========== Info from phpDoc block ========= -->
  311. <p class="short-description">Internal only - Sloodle StipendGiver instance database object.</p>
  312. <p class="description"><p>Corresponds to one record from the Moodle 'sloodle_StipendGiver' table.</p></p>
  313. <ul class="tags">
  314. <li><span class="field">access:</span> private</li>
  315. </ul>
  316. </div>
  317. <h4>Inherited Variables</h4>
  318. <A NAME='inherited_vars'><!-- --></A>
  319. <p>Inherited from <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
  320. <blockquote>
  321. <img src="../media/images/Variable.png" />
  322. <span class="var-title">
  323. <span class="var-name"><a href="../sloodle/SloodleModule.html#var$_session">SloodleModule::$_session</a></span><br>
  324. </span>
  325. </blockquote>
  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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  334. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  335. </div>
  336. <div class="info-box-body">
  337. <A NAME='method_detail'></A>
  338. <a name="methodSloodleModuleiBank" id="SloodleModuleiBank"><!-- --></a>
  339. <div class="oddrow">
  340. <div class="method-header">
  341. <img src="../media/images/Constructor.png" />
  342. <span class="method-title">Constructor SloodleModuleiBank</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a70">70</a></span>)
  343. </div>
  344. <!-- ========== Info from phpDoc block ========= -->
  345. <p class="short-description">Constructor</p>
  346. <div class="method-signature">
  347. <span class="method-result">SloodleModuleiBank</span>
  348. <span class="method-name">
  349. SloodleModuleiBank
  350. </span>
  351. (<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
  352. </div>
  353. <ul class="parameters">
  354. <li>
  355. <span class="var-type"></span>
  356. <span class="var-name">&$_session</span> </li>
  357. </ul>
  358. </div>
  359. <a name="methodget_amount" id="get_amount"><!-- --></a>
  360. <div class="evenrow">
  361. <div class="method-header">
  362. <img src="../media/images/Method.png" />
  363. <span class="method-title">get_amount</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a187">187</a></span>)
  364. </div>
  365. <!-- ========== Info from phpDoc block ========= -->
  366. <div class="method-signature">
  367. <span class="method-result">void</span>
  368. <span class="method-name">
  369. get_amount
  370. </span>
  371. ()
  372. </div>
  373. </div>
  374. <a name="methodget_class_list" id="get_class_list"><!-- --></a>
  375. <div class="oddrow">
  376. <div class="method-header">
  377. <img src="../media/images/Method.png" />
  378. <span class="method-title">get_class_list</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a123">123</a></span>)
  379. </div>
  380. <!-- ========== Info from phpDoc block ========= -->
  381. <p class="short-description">Gets a list of students in the class</p>
  382. <div class="method-signature">
  383. <span class="method-result">void</span>
  384. <span class="method-name">
  385. get_class_list
  386. </span>
  387. ()
  388. </div>
  389. </div>
  390. <a name="methodget_course_id" id="get_course_id"><!-- --></a>
  391. <div class="evenrow">
  392. <div class="method-header">
  393. <img src="../media/images/Method.png" />
  394. <span class="method-title">get_course_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a174">174</a></span>)
  395. </div>
  396. <!-- ========== Info from phpDoc block ========= -->
  397. <p class="short-description">Gets the identifier of the course this controller belongs to.</p>
  398. <ul class="tags">
  399. <li><span class="field">return:</span> Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</li>
  400. </ul>
  401. <div class="method-signature">
  402. <span class="method-result">mixed</span>
  403. <span class="method-name">
  404. get_course_id
  405. </span>
  406. ()
  407. </div>
  408. <hr class="separator" />
  409. <div class="notes">Redefinition of:</div>
  410. <dl>
  411. <dt><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></dt>
  412. <dd>Gets the identifier of the course this controller belongs to.</dd>
  413. </dl>
  414. </div>
  415. <a name="methodget_creation_time" id="get_creation_time"><!-- --></a>
  416. <div class="oddrow">
  417. <div class="method-header">
  418. <img src="../media/images/Method.png" />
  419. <span class="method-title">get_creation_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a183">183</a></span>)
  420. </div>
  421. <!-- ========== Info from phpDoc block ========= -->
  422. <p class="short-description">Gets the time at which this instance was created, or 0 if unknown.</p>
  423. <ul class="tags">
  424. <li><span class="field">return:</span> Timestamp</li>
  425. </ul>
  426. <div class="method-signature">
  427. <span class="method-result">int</span>
  428. <span class="method-name">
  429. get_creation_time
  430. </span>
  431. ()
  432. </div>
  433. <hr class="separator" />
  434. <div class="notes">Redefinition of:</div>
  435. <dl>
  436. <dt><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></dt>
  437. <dd>Gets the time at which this instance was created, or 0 if unknown.</dd>
  438. </dl>
  439. </div>
  440. <a name="methodget_intro" id="get_intro"><!-- --></a>
  441. <div class="evenrow">
  442. <div class="method-header">
  443. <img src="../media/images/Method.png" />
  444. <span class="method-title">get_intro</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a165">165</a></span>)
  445. </div>
  446. <!-- ========== Info from phpDoc block ========= -->
  447. <p class="short-description">Gets the intro description of this module instance, if available.</p>
  448. <ul class="tags">
  449. <li><span class="field">return:</span> The intro description of this controller</li>
  450. </ul>
  451. <div class="method-signature">
  452. <span class="method-result">string</span>
  453. <span class="method-name">
  454. get_intro
  455. </span>
  456. ()
  457. </div>
  458. <hr class="separator" />
  459. <div class="notes">Redefinition of:</div>
  460. <dl>
  461. <dt><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></dt>
  462. <dd>Gets the intro description of this module instance, if available.</dd>
  463. </dl>
  464. </div>
  465. <a name="methodget_modification_time" id="get_modification_time"><!-- --></a>
  466. <div class="oddrow">
  467. <div class="method-header">
  468. <img src="../media/images/Method.png" />
  469. <span class="method-title">get_modification_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a195">195</a></span>)
  470. </div>
  471. <!-- ========== Info from phpDoc block ========= -->
  472. <p class="short-description">Gets the time at which this instance was last modified, or 0 if unknown.</p>
  473. <ul class="tags">
  474. <li><span class="field">return:</span> Timestamp</li>
  475. </ul>
  476. <div class="method-signature">
  477. <span class="method-result">int</span>
  478. <span class="method-name">
  479. get_modification_time
  480. </span>
  481. ()
  482. </div>
  483. <hr class="separator" />
  484. <div class="notes">Redefinition of:</div>
  485. <dl>
  486. <dt><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></dt>
  487. <dd>Gets the time at which this instance was last modified, or 0 if unknown.</dd>
  488. </dl>
  489. </div>
  490. <a name="methodget_name" id="get_name"><!-- --></a>
  491. <div class="evenrow">
  492. <div class="method-header">
  493. <img src="../media/images/Method.png" />
  494. <span class="method-title">get_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a156">156</a></span>)
  495. </div>
  496. <!-- ========== Info from phpDoc block ========= -->
  497. <p class="short-description">Gets the name of this module instance.</p>
  498. <ul class="tags">
  499. <li><span class="field">return:</span> The name of this controller</li>
  500. </ul>
  501. <div class="method-signature">
  502. <span class="method-result">string</span>
  503. <span class="method-name">
  504. get_name
  505. </span>
  506. ()
  507. </div>
  508. <hr class="separator" />
  509. <div class="notes">Redefinition of:</div>
  510. <dl>
  511. <dt><a href="../sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a></dt>
  512. <dd>Gets the name of this module instance.</dd>
  513. </dl>
  514. </div>
  515. <a name="methodget_objects" id="get_objects"><!-- --></a>
  516. <div class="oddrow">
  517. <div class="method-header">
  518. <img src="../media/images/Method.png" />
  519. <span class="method-title">get_objects</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a108">108</a></span>)
  520. </div>
  521. <!-- ========== Info from phpDoc block ========= -->
  522. <p class="short-description">Gets a list of all objects for this StipendGiver.</p>
  523. <ul class="tags">
  524. <li><span class="field">return:</span> An array of strings, each string containing the name of an object in this StipendGiver.</li>
  525. </ul>
  526. <div class="method-signature">
  527. <span class="method-result">array</span>
  528. <span class="method-name">
  529. get_objects
  530. </span>
  531. ()
  532. </div>
  533. </div>
  534. <a name="methodget_type" id="get_type"><!-- --></a>
  535. <div class="evenrow">
  536. <div class="method-header">
  537. <img src="../media/images/Method.png" />
  538. <span class="method-title">get_type</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a205">205</a></span>)
  539. </div>
  540. <!-- ========== Info from phpDoc block ========= -->
  541. <p class="short-description">Gets the short type name of this instance.</p>
  542. <div class="method-signature">
  543. <span class="method-result">string</span>
  544. <span class="method-name">
  545. get_type
  546. </span>
  547. ()
  548. </div>
  549. <hr class="separator" />
  550. <div class="notes">Redefinition of:</div>
  551. <dl>
  552. <dt><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></dt>
  553. <dd>Gets the short type name of this instance.</dd>
  554. </dl>
  555. </div>
  556. <a name="methodget_type_full" id="get_type_full"><!-- --></a>
  557. <div class="oddrow">
  558. <div class="method-header">
  559. <img src="../media/images/Method.png" />
  560. <span class="method-title">get_type_full</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a215">215</a></span>)
  561. </div>
  562. <!-- ========== Info from phpDoc block ========= -->
  563. <p class="short-description">Gets the full type name of this instance, according to the current language pack, if available.</p>
  564. <p class="description"><p>Note: should be overridden by sub-classes.</p></p>
  565. <ul class="tags">
  566. <li><span class="field">return:</span> Full type name if possible, or the short name otherwise.</li>
  567. </ul>
  568. <div class="method-signature">
  569. <span class="method-result">string</span>
  570. <span class="method-name">
  571. get_type_full
  572. </span>
  573. ()
  574. </div>
  575. <hr class="separator" />
  576. <div class="notes">Redefinition of:</div>
  577. <dl>
  578. <dt><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></dt>
  579. <dd>Gets the full type name of this instance, according to the current language pack, if available.</dd>
  580. </dl>
  581. </div>
  582. <a name="methodload" id="load"><!-- --></a>
  583. <div class="evenrow">
  584. <div class="method-header">
  585. <img src="../media/images/Method.png" />
  586. <span class="method-title">load</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_ibank.php.html#a82">82</a></span>)
  587. </div>
  588. <!-- ========== Info from phpDoc block ========= -->
  589. <p class="short-description">Loads data from the database.</p>
  590. <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>
  591. <ul class="tags">
  592. <li><span class="field">return:</span> True if successful, or false otherwise</li>
  593. </ul>
  594. <div class="method-signature">
  595. <span class="method-result">bool</span>
  596. <span class="method-name">
  597. load
  598. </span>
  599. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  600. </div>
  601. <ul class="parameters">
  602. <li>
  603. <span class="var-type">mixed</span>
  604. <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>
  605. </ul>
  606. <hr class="separator" />
  607. <div class="notes">Redefinition of:</div>
  608. <dl>
  609. <dt><a href="../sloodle/SloodleModule.html#methodload">SloodleModule::load()</a></dt>
  610. <dd>Loads data from the database.</dd>
  611. </dl>
  612. </div>
  613. <h4>Inherited Methods</h4>
  614. <a name='inherited_methods'><!-- --></a>
  615. <!-- =========== Summary =========== -->
  616. <p>Inherited From <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
  617. <blockquote>
  618. <img src="../media/images/Constructor.png" alt=" "/>
  619. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodSloodleModule">SloodleModule::SloodleModule()</a></span><br>
  620. <img src="../media/images/Method.png" alt=" "/>
  621. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></span><br>
  622. <img src="../media/images/Method.png" alt=" "/>
  623. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></span><br>
  624. <img src="../media/images/Method.png" alt=" "/>
  625. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></span><br>
  626. <img src="../media/images/Method.png" alt=" "/>
  627. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></span><br>
  628. <img src="../media/images/Method.png" alt=" "/>
  629. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a></span><br>
  630. <img src="../media/images/Method.png" alt=" "/>
  631. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></span><br>
  632. <img src="../media/images/Method.png" alt=" "/>
  633. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></span><br>
  634. <img src="../media/images/Method.png" alt=" "/>
  635. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodload">SloodleModule::load()</a></span><br>
  636. </blockquote>
  637. </div>
  638. </div>
  639. <p class="notes" id="credit">
  640. Documentation generated on Fri, 17 Jul 2009 11:02:02 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  641. </p>
  642. </div></body>
  643. </html>