sloodle_base_view_module.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873
  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 sloodle_base_view_module</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"> sloodle_base_view_module</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">The base class for viewing a SLOODLE module.</p>
  100. <p class="description"><p>Should be inherited and overridden. Child class MUST be named &quot;sloodle_view_NAME&quot;, where NAME replaces the name of the feature or module. For example, &quot;sloodle_view_controller&quot; or &quot;sloodle_view_course&quot;. For modules, the NAME must match the &quot;type&quot; specifier in the &quot;sloodle&quot; table, such as &quot;controller&quot;, &quot;distributor&quot;, or &quot;presenter&quot;.</p></p>
  101. <p class="notes">
  102. Located in <a class="field" href="_view---base---base_view_module.php.html">/view/base/base_view_module.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a28">28</a></span>)
  103. </p>
  104. <pre><a href="../sloodle/sloodle_base_view.html">sloodle_base_view</a>
  105. |
  106. --sloodle_base_view_module</pre>
  107. </div>
  108. </div>
  109. <a name="sec-descendents"></a>
  110. <div class="info-box">
  111. <div class="info-box-title">Direct descendents</div>
  112. <div class="nav-bar">
  113. <a href="#sec-description">Description</a> |
  114. <span class="disabled">Descendents</span>
  115. | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  116. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  117. </div>
  118. <div class="info-box-body">
  119. <table cellpadding="2" cellspacing="0" class="class-table">
  120. <tr>
  121. <th class="class-table-header">Class</th>
  122. <th class="class-table-header">Description</th>
  123. </tr>
  124. <tr>
  125. <td style="padding-right: 2em; white-space: nowrap">
  126. <img src="../media/images/Class.png"
  127. alt=" class"
  128. title=" class"
  129. style="vertical-align: center"/>
  130. <a href="../sloodle/sloodle_view_controller.html">sloodle_view_controller</a>
  131. </td>
  132. <td>
  133. The base class for viewing a SLOODLE Controller module.
  134. </td>
  135. </tr>
  136. <tr>
  137. <td style="padding-right: 2em; white-space: nowrap">
  138. <img src="../media/images/Class.png"
  139. alt=" class"
  140. title=" class"
  141. style="vertical-align: center"/>
  142. <a href="../sloodle/sloodle_view_distributor.html">sloodle_view_distributor</a>
  143. </td>
  144. <td>
  145. Class for rendering a view of a Distributor module in Moodle.
  146. </td>
  147. </tr>
  148. <tr>
  149. <td style="padding-right: 2em; white-space: nowrap">
  150. <img src="../media/images/Class.png"
  151. alt=" class"
  152. title=" class"
  153. style="vertical-align: center"/>
  154. <a href="../sloodle/sloodle_view_ibank.html">sloodle_view_ibank</a>
  155. </td>
  156. <td>
  157. Class for rendering a view of a Distributor module in Moodle.
  158. </td>
  159. </tr>
  160. <tr>
  161. <td style="padding-right: 2em; white-space: nowrap">
  162. <img src="../media/images/Class.png"
  163. alt=" class"
  164. title=" class"
  165. style="vertical-align: center"/>
  166. <a href="../sloodle/sloodle_view_map.html">sloodle_view_map</a>
  167. </td>
  168. <td>
  169. Class for rendering a view of a Map module in Moodle.
  170. </td>
  171. </tr>
  172. <tr>
  173. <td style="padding-right: 2em; white-space: nowrap">
  174. <img src="../media/images/Class.png"
  175. alt=" class"
  176. title=" class"
  177. style="vertical-align: center"/>
  178. <a href="../sloodle/sloodle_view_presenter.html">sloodle_view_presenter</a>
  179. </td>
  180. <td>
  181. Class for rendering a view of a Presenter module in Moodle.
  182. </td>
  183. </tr>
  184. </table>
  185. </div>
  186. </div>
  187. <a name="sec-var-summary"></a>
  188. <div class="info-box">
  189. <div class="info-box-title">Variable Summary</span></div>
  190. <div class="nav-bar">
  191. <a href="#sec-description">Description</a> |
  192. <a href="#sec-descendents">Descendants</a> |
  193. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  194. |
  195. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  196. </div>
  197. <div class="info-box-body">
  198. <div class="var-summary">
  199. <div class="var-title">
  200. <img src="../media/images/PrivateVariable.png" alt=" " />
  201. <span class="var-type">bool</span>
  202. <a href="#$canedit" title="details" class="var-name">$canedit</a>
  203. </div>
  204. <div class="var-title">
  205. <img src="../media/images/PrivateVariable.png" alt=" " />
  206. <span class="var-type">object</span>
  207. <a href="#$cm" title="details" class="var-name">$cm</a>
  208. </div>
  209. <div class="var-title">
  210. <img src="../media/images/PrivateVariable.png" alt=" " />
  211. <span class="var-type">object</span>
  212. <a href="#$course" title="details" class="var-name">$course</a>
  213. </div>
  214. <div class="var-title">
  215. <img src="../media/images/PrivateVariable.png" alt=" " />
  216. <span class="var-type">object</span>
  217. <a href="#$course_context" title="details" class="var-name">$course_context</a>
  218. </div>
  219. <div class="var-title">
  220. <img src="../media/images/PrivateVariable.png" alt=" " />
  221. <span class="var-type">object</span>
  222. <a href="#$module_context" title="details" class="var-name">$module_context</a>
  223. </div>
  224. <div class="var-title">
  225. <img src="../media/images/PrivateVariable.png" alt=" " />
  226. <span class="var-type">object</span>
  227. <a href="#$sloodle" title="details" class="var-name">$sloodle</a>
  228. </div>
  229. <div class="var-title">
  230. <img src="../media/images/PrivateVariable.png" alt=" " />
  231. <span class="var-type"><a href="../sloodle/SloodleCourse.html">SloodleCourse</a></span>
  232. <a href="#$sloodle_course" title="details" class="var-name">$sloodle_course</a>
  233. </div>
  234. </div>
  235. </div>
  236. </div>
  237. <a name="sec-method-summary"></a>
  238. <div class="info-box">
  239. <div class="info-box-title">Method Summary</span></div>
  240. <div class="nav-bar">
  241. <a href="#sec-description">Description</a> |
  242. <a href="#sec-descendents">Descendants</a> |
  243. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  244. |
  245. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  246. </div>
  247. <div class="info-box-body">
  248. <div class="method-summary">
  249. <div class="method-definition">
  250. <img src="../media/images/Constructor.png" alt=" "/>
  251. <span class="method-result">sloodle_base_view_module</span>
  252. <a href="#sloodle_base_view_module" title="details" class="method-name">sloodle_base_view_module</a>
  253. ()
  254. </div>
  255. <div class="method-definition">
  256. <img src="../media/images/Method.png" alt=" "/>
  257. <span class="method-result">void</span>
  258. <a href="#check_permission" title="details" class="method-name">check_permission</a>
  259. ()
  260. </div>
  261. <div class="method-definition">
  262. <img src="../media/images/Method.png" alt=" "/>
  263. <span class="method-result">void</span>
  264. <a href="#print_footer" title="details" class="method-name">print_footer</a>
  265. ()
  266. </div>
  267. <div class="method-definition">
  268. <img src="../media/images/Method.png" alt=" "/>
  269. <span class="method-result">void</span>
  270. <a href="#print_header" title="details" class="method-name">print_header</a>
  271. ()
  272. </div>
  273. <div class="method-definition">
  274. <img src="../media/images/Method.png" alt=" "/>
  275. <span class="method-result">void</span>
  276. <a href="#process_form" title="details" class="method-name">process_form</a>
  277. ()
  278. </div>
  279. <div class="method-definition">
  280. <img src="../media/images/Method.png" alt=" "/>
  281. <span class="method-result">void</span>
  282. <a href="#process_request" title="details" class="method-name">process_request</a>
  283. ()
  284. </div>
  285. <div class="method-definition">
  286. <img src="../media/images/Method.png" alt=" "/>
  287. <span class="method-result">void</span>
  288. <a href="#render" title="details" class="method-name">render</a>
  289. ()
  290. </div>
  291. </div>
  292. </div>
  293. </div>
  294. <a name="sec-vars"></a>
  295. <div class="info-box">
  296. <div class="info-box-title">Variables</div>
  297. <div class="nav-bar">
  298. <a href="#sec-description">Description</a> |
  299. <a href="#sec-descendents">Descendents</a> |
  300. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  301. |
  302. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  303. </div>
  304. <div class="info-box-body">
  305. <a name="var$canedit" id="$canedit"><!-- --></A>
  306. <div class="oddrow">
  307. <div class="var-header">
  308. <img src="../media/images/PrivateVariable.png" />
  309. <span class="var-title">
  310. <span class="var-type">bool</span>
  311. <span class="var-name">$canedit</span>
  312. = <span class="var-default"> false</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a77">77</a></span>)
  313. </span>
  314. </div>
  315. <!-- ========== Info from phpDoc block ========= -->
  316. <p class="short-description">Indicates whether or the user can edit (or 'manage') this module, according to the VLE permissions.</p>
  317. <ul class="tags">
  318. <li><span class="field">access:</span> private</li>
  319. </ul>
  320. </div>
  321. <a name="var$cm" id="$cm"><!-- --></A>
  322. <div class="evenrow">
  323. <div class="var-header">
  324. <img src="../media/images/PrivateVariable.png" />
  325. <span class="var-title">
  326. <span class="var-type">object</span>
  327. <span class="var-name">$cm</span>
  328. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a35">35</a></span>)
  329. </span>
  330. </div>
  331. <!-- ========== Info from phpDoc block ========= -->
  332. <p class="short-description">The course module instance, retrieved directly from the database (table: course_modules)</p>
  333. <ul class="tags">
  334. <li><span class="field">access:</span> private</li>
  335. </ul>
  336. <hr class="separator" />
  337. <div class="notes">Redefined in descendants as:</div>
  338. <ul class="redefinitions">
  339. <li>
  340. <a href="../sloodle/sloodle_view_ibank.html#var$cm">sloodle_view_ibank::$cm</a>
  341. : The course module instance, retrieved directly from the database (table: course_modules)
  342. </li>
  343. </ul>
  344. </div>
  345. <a name="var$course" id="$course"><!-- --></A>
  346. <div class="oddrow">
  347. <div class="var-header">
  348. <img src="../media/images/PrivateVariable.png" />
  349. <span class="var-title">
  350. <span class="var-type">object</span>
  351. <span class="var-name">$course</span>
  352. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a49">49</a></span>)
  353. </span>
  354. </div>
  355. <!-- ========== Info from phpDoc block ========= -->
  356. <p class="short-description">The VLE course object, retrieved directly from the database (table: course)</p>
  357. <ul class="tags">
  358. <li><span class="field">access:</span> private</li>
  359. </ul>
  360. <hr class="separator" />
  361. <div class="notes">Redefined in descendants as:</div>
  362. <ul class="redefinitions">
  363. <li>
  364. <a href="../sloodle/sloodle_view_ibank.html#var$course">sloodle_view_ibank::$course</a>
  365. : The VLE course object, retrieved directly from the database (table: course)
  366. </li>
  367. </ul>
  368. </div>
  369. <a name="var$course_context" id="$course_context"><!-- --></A>
  370. <div class="evenrow">
  371. <div class="var-header">
  372. <img src="../media/images/PrivateVariable.png" />
  373. <span class="var-title">
  374. <span class="var-type">object</span>
  375. <span class="var-name">$course_context</span>
  376. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a63">63</a></span>)
  377. </span>
  378. </div>
  379. <!-- ========== Info from phpDoc block ========= -->
  380. <p class="short-description">Context object for permissions in the Moodle course.</p>
  381. <ul class="tags">
  382. <li><span class="field">access:</span> private</li>
  383. </ul>
  384. <hr class="separator" />
  385. <div class="notes">Redefined in descendants as:</div>
  386. <ul class="redefinitions">
  387. <li>
  388. <a href="../sloodle/sloodle_view_ibank.html#var$course_context">sloodle_view_ibank::$course_context</a>
  389. : Context object for permissions in the Moodle course.
  390. </li>
  391. </ul>
  392. </div>
  393. <a name="var$module_context" id="$module_context"><!-- --></A>
  394. <div class="oddrow">
  395. <div class="var-header">
  396. <img src="../media/images/PrivateVariable.png" />
  397. <span class="var-title">
  398. <span class="var-type">object</span>
  399. <span class="var-name">$module_context</span>
  400. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a70">70</a></span>)
  401. </span>
  402. </div>
  403. <!-- ========== Info from phpDoc block ========= -->
  404. <p class="short-description">Context object for permissions in the Moodle module.</p>
  405. <ul class="tags">
  406. <li><span class="field">access:</span> private</li>
  407. </ul>
  408. </div>
  409. <a name="var$sloodle" id="$sloodle"><!-- --></A>
  410. <div class="evenrow">
  411. <div class="var-header">
  412. <img src="../media/images/PrivateVariable.png" />
  413. <span class="var-title">
  414. <span class="var-type">object</span>
  415. <span class="var-name">$sloodle</span>
  416. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a42">42</a></span>)
  417. </span>
  418. </div>
  419. <!-- ========== Info from phpDoc block ========= -->
  420. <p class="short-description">The main SLOODLE module instance, retreived directly from the database (table: sloodle)</p>
  421. <ul class="tags">
  422. <li><span class="field">access:</span> private</li>
  423. </ul>
  424. <hr class="separator" />
  425. <div class="notes">Redefined in descendants as:</div>
  426. <ul class="redefinitions">
  427. <li>
  428. <a href="../sloodle/sloodle_view_ibank.html#var$sloodle">sloodle_view_ibank::$sloodle</a>
  429. : The main SLOODLE module instance, retreived directly from the database (table: sloodle)
  430. </li>
  431. </ul>
  432. </div>
  433. <a name="var$sloodle_course" id="$sloodle_course"><!-- --></A>
  434. <div class="oddrow">
  435. <div class="var-header">
  436. <img src="../media/images/PrivateVariable.png" />
  437. <span class="var-title">
  438. <span class="var-type"><a href="../sloodle/SloodleCourse.html">SloodleCourse</a></span>
  439. <span class="var-name">$sloodle_course</span>
  440. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a56">56</a></span>)
  441. </span>
  442. </div>
  443. <!-- ========== Info from phpDoc block ========= -->
  444. <p class="short-description">The SLOODLE course object.</p>
  445. <ul class="tags">
  446. <li><span class="field">access:</span> private</li>
  447. </ul>
  448. <hr class="separator" />
  449. <div class="notes">Redefined in descendants as:</div>
  450. <ul class="redefinitions">
  451. <li>
  452. <a href="../sloodle/sloodle_view_ibank.html#var$sloodle_course">sloodle_view_ibank::$sloodle_course</a>
  453. : The SLOODLE course object.
  454. </li>
  455. </ul>
  456. </div>
  457. </div>
  458. </div>
  459. <a name="sec-methods"></a>
  460. <div class="info-box">
  461. <div class="info-box-title">Methods</div>
  462. <div class="nav-bar">
  463. <a href="#sec-description">Description</a> |
  464. <a href="#sec-descendents">Descendents</a> |
  465. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  466. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  467. </div>
  468. <div class="info-box-body">
  469. <A NAME='method_detail'></A>
  470. <a name="methodsloodle_base_view_module" id="sloodle_base_view_module"><!-- --></a>
  471. <div class="evenrow">
  472. <div class="method-header">
  473. <img src="../media/images/Constructor.png" />
  474. <span class="method-title">Constructor sloodle_base_view_module</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a83">83</a></span>)
  475. </div>
  476. <!-- ========== Info from phpDoc block ========= -->
  477. <p class="short-description">Constructor.</p>
  478. <div class="method-signature">
  479. <span class="method-result">sloodle_base_view_module</span>
  480. <span class="method-name">
  481. sloodle_base_view_module
  482. </span>
  483. ()
  484. </div>
  485. <hr class="separator" />
  486. <div class="notes">Redefined in descendants as:</div>
  487. <ul class="redefinitions">
  488. <li>
  489. <a href="../sloodle/sloodle_view_distributor.html#methodsloodle_base_view_module">sloodle_view_distributor::sloodle_base_view_module()</a>
  490. : Constructor.
  491. </li>
  492. </ul>
  493. </div>
  494. <a name="methodcheck_permission" id="check_permission"><!-- --></a>
  495. <div class="oddrow">
  496. <div class="method-header">
  497. <img src="../media/images/Method.png" />
  498. <span class="method-title">check_permission</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a111">111</a></span>)
  499. </div>
  500. <!-- ========== Info from phpDoc block ========= -->
  501. <p class="short-description">Check that the user has permission to view this module, and check if they can edit it too.</p>
  502. <div class="method-signature">
  503. <span class="method-result">void</span>
  504. <span class="method-name">
  505. check_permission
  506. </span>
  507. ()
  508. </div>
  509. <hr class="separator" />
  510. <div class="notes">Redefinition of:</div>
  511. <dl>
  512. <dt><a href="../sloodle/sloodle_base_view.html#methodcheck_permission">sloodle_base_view::check_permission()</a></dt>
  513. <dd>Check that the user has permission to access the current resources.</dd>
  514. </dl>
  515. <hr class="separator" />
  516. <div class="notes">Redefined in descendants as:</div>
  517. <ul class="redefinitions">
  518. <li>
  519. <a href="../sloodle/sloodle_view_ibank.html#methodcheck_permission">sloodle_view_ibank::check_permission()</a>
  520. : Check that the user has permission to view this module, and check if they can edit it too.
  521. </li>
  522. </ul>
  523. </div>
  524. <a name="methodprint_footer" id="print_footer"><!-- --></a>
  525. <div class="evenrow">
  526. <div class="method-header">
  527. <img src="../media/images/Method.png" />
  528. <span class="method-title">print_footer</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a177">177</a></span>)
  529. </div>
  530. <!-- ========== Info from phpDoc block ========= -->
  531. <p class="short-description">Print the footer for this course.</p>
  532. <div class="method-signature">
  533. <span class="method-result">void</span>
  534. <span class="method-name">
  535. print_footer
  536. </span>
  537. ()
  538. </div>
  539. <hr class="separator" />
  540. <div class="notes">Redefinition of:</div>
  541. <dl>
  542. <dt><a href="../sloodle/sloodle_base_view.html#methodprint_footer">sloodle_base_view::print_footer()</a></dt>
  543. <dd>Output the page footer.</dd>
  544. </dl>
  545. </div>
  546. <a name="methodprint_header" id="print_header"><!-- --></a>
  547. <div class="oddrow">
  548. <div class="method-header">
  549. <img src="../media/images/Method.png" />
  550. <span class="method-title">print_header</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a137">137</a></span>)
  551. </div>
  552. <!-- ========== Info from phpDoc block ========= -->
  553. <p class="short-description">Print module header info.</p>
  554. <div class="method-signature">
  555. <span class="method-result">void</span>
  556. <span class="method-name">
  557. print_header
  558. </span>
  559. ()
  560. </div>
  561. <hr class="separator" />
  562. <div class="notes">Redefinition of:</div>
  563. <dl>
  564. <dt><a href="../sloodle/sloodle_base_view.html#methodprint_header">sloodle_base_view::print_header()</a></dt>
  565. <dd>Print the standard page header.</dd>
  566. </dl>
  567. <hr class="separator" />
  568. <div class="notes">Redefined in descendants as:</div>
  569. <ul class="redefinitions">
  570. <li>
  571. <a href="../sloodle/sloodle_view_ibank.html#methodprint_header">sloodle_view_ibank::print_header()</a>
  572. : Override the base_view_module print_header for formatting reasons
  573. </li>
  574. <li>
  575. <a href="../sloodle/sloodle_view_map.html#methodprint_header">sloodle_view_map::print_header()</a>
  576. : Print the page header (requires special scripts to be added into the header)
  577. </li>
  578. </ul>
  579. </div>
  580. <a name="methodprocess_form" id="process_form"><!-- --></a>
  581. <div class="evenrow">
  582. <div class="method-header">
  583. <img src="../media/images/Method.png" />
  584. <span class="method-title">process_form</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a130">130</a></span>)
  585. </div>
  586. <!-- ========== Info from phpDoc block ========= -->
  587. <p class="short-description">Process any form data which has been submitted.</p>
  588. <div class="method-signature">
  589. <span class="method-result">void</span>
  590. <span class="method-name">
  591. process_form
  592. </span>
  593. ()
  594. </div>
  595. <hr class="separator" />
  596. <div class="notes">Redefinition of:</div>
  597. <dl>
  598. <dt><a href="../sloodle/sloodle_base_view.html#methodprocess_form">sloodle_base_view::process_form()</a></dt>
  599. <dd>Process any form data which has been submitted.</dd>
  600. </dl>
  601. <hr class="separator" />
  602. <div class="notes">Redefined in descendants as:</div>
  603. <ul class="redefinitions">
  604. <li>
  605. <a href="../sloodle/sloodle_view_controller.html#methodprocess_form">sloodle_view_controller::process_form()</a>
  606. : Process any form data which has been submitted.
  607. </li>
  608. <li>
  609. <a href="../sloodle/sloodle_view_distributor.html#methodprocess_form">sloodle_view_distributor::process_form()</a>
  610. : Process any form data which has been submitted.
  611. </li>
  612. <li>
  613. <a href="../sloodle/sloodle_view_ibank.html#methodprocess_form">sloodle_view_ibank::process_form()</a>
  614. : Process any form data which has been submitted.
  615. </li>
  616. <li>
  617. <a href="../sloodle/sloodle_view_map.html#methodprocess_form">sloodle_view_map::process_form()</a>
  618. : Process any form data which has been submitted.
  619. </li>
  620. <li>
  621. <a href="../sloodle/sloodle_view_presenter.html#methodprocess_form">sloodle_view_presenter::process_form()</a>
  622. : Process any form data which has been submitted.
  623. </li>
  624. </ul>
  625. </div>
  626. <a name="methodprocess_request" id="process_request"><!-- --></a>
  627. <div class="oddrow">
  628. <div class="method-header">
  629. <img src="../media/images/Method.png" />
  630. <span class="method-title">process_request</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a93">93</a></span>)
  631. </div>
  632. <!-- ========== Info from phpDoc block ========= -->
  633. <p class="short-description">Checks for incoming request data identifying a particular module (parameter 'id').</p>
  634. <p class="description"><p>Loads the relevant course module and SLOODLE module instances. This should be overridden to add functionality to load any module-specific data. However, you can simply call the parent function (i.e. this one) first to load the basic data.</p></p>
  635. <div class="method-signature">
  636. <span class="method-result">void</span>
  637. <span class="method-name">
  638. process_request
  639. </span>
  640. ()
  641. </div>
  642. <hr class="separator" />
  643. <div class="notes">Redefinition of:</div>
  644. <dl>
  645. <dt><a href="../sloodle/sloodle_base_view.html#methodprocess_request">sloodle_base_view::process_request()</a></dt>
  646. <dd>Check for incoming request data identifying a particular course or module.</dd>
  647. </dl>
  648. <hr class="separator" />
  649. <div class="notes">Redefined in descendants as:</div>
  650. <ul class="redefinitions">
  651. <li>
  652. <a href="../sloodle/sloodle_view_controller.html#methodprocess_request">sloodle_view_controller::process_request()</a>
  653. : Uses the parent class to process basic request information, then obtains additional Controller data.
  654. </li>
  655. <li>
  656. <a href="../sloodle/sloodle_view_distributor.html#methodprocess_request">sloodle_view_distributor::process_request()</a>
  657. : Processes request data to determine which Distributor is being accessed.
  658. </li>
  659. <li>
  660. <a href="../sloodle/sloodle_view_ibank.html#methodprocess_request">sloodle_view_ibank::process_request()</a>
  661. : Check and process the request parameters.
  662. </li>
  663. <li>
  664. <a href="../sloodle/sloodle_view_map.html#methodprocess_request">sloodle_view_map::process_request()</a>
  665. : Processes request data to determine which Map is being accessed.
  666. </li>
  667. <li>
  668. <a href="../sloodle/sloodle_view_presenter.html#methodprocess_request">sloodle_view_presenter::process_request()</a>
  669. : Processes request data to determine which Presenter is being accessed.
  670. </li>
  671. </ul>
  672. </div>
  673. <a name="methodrender" id="render"><!-- --></a>
  674. <div class="evenrow">
  675. <div class="method-header">
  676. <img src="../media/images/Method.png" />
  677. <span class="method-title">render</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewbasebase_view_module.php.html#a170">170</a></span>)
  678. </div>
  679. <!-- ========== Info from phpDoc block ========= -->
  680. <p class="short-description">Render the view of the module or feature.</p>
  681. <p class="description"><p>This MUST be overridden to provide functionality.</p></p>
  682. <div class="method-signature">
  683. <span class="method-result">void</span>
  684. <span class="method-name">
  685. render
  686. </span>
  687. ()
  688. </div>
  689. <hr class="separator" />
  690. <div class="notes">Redefinition of:</div>
  691. <dl>
  692. <dt><a href="../sloodle/sloodle_base_view.html#methodrender">sloodle_base_view::render()</a></dt>
  693. <dd>Render the view of the module or feature.</dd>
  694. </dl>
  695. <hr class="separator" />
  696. <div class="notes">Redefined in descendants as:</div>
  697. <ul class="redefinitions">
  698. <li>
  699. <a href="../sloodle/sloodle_view_controller.html#methodrender">sloodle_view_controller::render()</a>
  700. : Render the view of the Controller.
  701. </li>
  702. <li>
  703. <a href="../sloodle/sloodle_view_distributor.html#methodrender">sloodle_view_distributor::render()</a>
  704. : Render the view of the Distributor.
  705. </li>
  706. <li>
  707. <a href="../sloodle/sloodle_view_ibank.html#methodrender">sloodle_view_ibank::render()</a>
  708. : Render the view of the Stipend Giver.
  709. </li>
  710. <li>
  711. <a href="../sloodle/sloodle_view_map.html#methodrender">sloodle_view_map::render()</a>
  712. : Render the view of the Map.
  713. </li>
  714. <li>
  715. <a href="../sloodle/sloodle_view_presenter.html#methodrender">sloodle_view_presenter::render()</a>
  716. : Render the view of the Presenter.
  717. </li>
  718. </ul>
  719. </div>
  720. <h4>Inherited Methods</h4>
  721. <a name='inherited_methods'><!-- --></a>
  722. <!-- =========== Summary =========== -->
  723. <p>Inherited From <span class="classname"><a href="../sloodle/sloodle_base_view.html">sloodle_base_view</a></span></p>
  724. <blockquote>
  725. <img src="../media/images/Constructor.png" alt=" "/>
  726. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodsloodle_base_view">sloodle_base_view::sloodle_base_view()</a></span><br>
  727. <img src="../media/images/Method.png" alt=" "/>
  728. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodcheck_permission">sloodle_base_view::check_permission()</a></span><br>
  729. <img src="../media/images/Method.png" alt=" "/>
  730. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprint_footer">sloodle_base_view::print_footer()</a></span><br>
  731. <img src="../media/images/Method.png" alt=" "/>
  732. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprint_header">sloodle_base_view::print_header()</a></span><br>
  733. <img src="../media/images/Method.png" alt=" "/>
  734. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprocess_form">sloodle_base_view::process_form()</a></span><br>
  735. <img src="../media/images/Method.png" alt=" "/>
  736. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprocess_request">sloodle_base_view::process_request()</a></span><br>
  737. <img src="../media/images/Method.png" alt=" "/>
  738. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodrender">sloodle_base_view::render()</a></span><br>
  739. <img src="../media/images/Method.png" alt=" "/>
  740. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodview">sloodle_base_view::view()</a></span><br>
  741. </blockquote>
  742. </div>
  743. </div>
  744. <p class="notes" id="credit">
  745. Documentation generated on Fri, 17 Jul 2009 11:01:02 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  746. </p>
  747. </div></body>
  748. </html>