sloodle_view_controller.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426
  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_view_controller</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_view_controller</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 base class for viewing a SLOODLE Controller module.</p>
  99. <p class="notes">
  100. Located in <a class="field" href="_view---controller.php.html">/view/controller.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__viewcontroller.php.html#a21">21</a></span>)
  101. </p>
  102. <pre><a href="../sloodle/sloodle_base_view.html">sloodle_base_view</a>
  103. |
  104. --<a href="../sloodle/sloodle_base_view_module.html">sloodle_base_view_module</a>
  105. |
  106. --sloodle_view_controller</pre>
  107. </div>
  108. </div>
  109. <a name="sec-var-summary"></a>
  110. <div class="info-box">
  111. <div class="info-box-title">Variable Summary</span></div>
  112. <div class="nav-bar">
  113. <a href="#sec-description">Description</a> |
  114. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  115. |
  116. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  117. </div>
  118. <div class="info-box-body">
  119. <div class="var-summary">
  120. <div class="var-title">
  121. <img src="../media/images/PrivateVariable.png" alt=" " />
  122. <span class="var-type">object</span>
  123. <a href="#$controller" title="details" class="var-name">$controller</a>
  124. </div>
  125. </div>
  126. </div>
  127. </div>
  128. <a name="sec-method-summary"></a>
  129. <div class="info-box">
  130. <div class="info-box-title">Method Summary</span></div>
  131. <div class="nav-bar">
  132. <a href="#sec-description">Description</a> |
  133. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  134. |
  135. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  136. </div>
  137. <div class="info-box-body">
  138. <div class="method-summary">
  139. <div class="method-definition">
  140. <img src="../media/images/Constructor.png" alt=" "/>
  141. <span class="method-result">sloodle_view_controller</span>
  142. <a href="#sloodle_view_controller" title="details" class="method-name">sloodle_view_controller</a>
  143. ()
  144. </div>
  145. <div class="method-definition">
  146. <img src="../media/images/Method.png" alt=" "/>
  147. <span class="method-result">void</span>
  148. <a href="#process_form" title="details" class="method-name">process_form</a>
  149. ()
  150. </div>
  151. <div class="method-definition">
  152. <img src="../media/images/Method.png" alt=" "/>
  153. <span class="method-result">void</span>
  154. <a href="#process_request" title="details" class="method-name">process_request</a>
  155. ()
  156. </div>
  157. <div class="method-definition">
  158. <img src="../media/images/Method.png" alt=" "/>
  159. <span class="method-result">void</span>
  160. <a href="#render" title="details" class="method-name">render</a>
  161. ()
  162. </div>
  163. </div>
  164. </div>
  165. </div>
  166. <a name="sec-vars"></a>
  167. <div class="info-box">
  168. <div class="info-box-title">Variables</div>
  169. <div class="nav-bar">
  170. <a href="#sec-description">Description</a> |
  171. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  172. |
  173. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  174. </div>
  175. <div class="info-box-body">
  176. <a name="var$controller" id="$controller"><!-- --></A>
  177. <div class="evenrow">
  178. <div class="var-header">
  179. <img src="../media/images/PrivateVariable.png" />
  180. <span class="var-title">
  181. <span class="var-type">object</span>
  182. <span class="var-name">$controller</span>
  183. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcontroller.php.html#a28">28</a></span>)
  184. </span>
  185. </div>
  186. <!-- ========== Info from phpDoc block ========= -->
  187. <p class="short-description">SLOODLE Controller data object, retreived directly from the database (table: sloodle_controller).</p>
  188. <ul class="tags">
  189. <li><span class="field">access:</span> private</li>
  190. </ul>
  191. </div>
  192. <h4>Inherited Variables</h4>
  193. <A NAME='inherited_vars'><!-- --></A>
  194. <p>Inherited from <span class="classname"><a href="../sloodle/sloodle_base_view_module.html">sloodle_base_view_module</a></span></p>
  195. <blockquote>
  196. <img src="../media/images/PrivateVariable.png" />
  197. <span class="var-title">
  198. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$canedit">sloodle_base_view_module::$canedit</a></span><br>
  199. </span>
  200. <img src="../media/images/PrivateVariable.png" />
  201. <span class="var-title">
  202. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$cm">sloodle_base_view_module::$cm</a></span><br>
  203. </span>
  204. <img src="../media/images/PrivateVariable.png" />
  205. <span class="var-title">
  206. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$course">sloodle_base_view_module::$course</a></span><br>
  207. </span>
  208. <img src="../media/images/PrivateVariable.png" />
  209. <span class="var-title">
  210. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$course_context">sloodle_base_view_module::$course_context</a></span><br>
  211. </span>
  212. <img src="../media/images/PrivateVariable.png" />
  213. <span class="var-title">
  214. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$module_context">sloodle_base_view_module::$module_context</a></span><br>
  215. </span>
  216. <img src="../media/images/PrivateVariable.png" />
  217. <span class="var-title">
  218. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$sloodle">sloodle_base_view_module::$sloodle</a></span><br>
  219. </span>
  220. <img src="../media/images/PrivateVariable.png" />
  221. <span class="var-title">
  222. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$sloodle_course">sloodle_base_view_module::$sloodle_course</a></span><br>
  223. </span>
  224. </blockquote>
  225. </div>
  226. </div>
  227. <a name="sec-methods"></a>
  228. <div class="info-box">
  229. <div class="info-box-title">Methods</div>
  230. <div class="nav-bar">
  231. <a href="#sec-description">Description</a> |
  232. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  233. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  234. </div>
  235. <div class="info-box-body">
  236. <A NAME='method_detail'></A>
  237. <a name="methodsloodle_view_controller" id="sloodle_view_controller"><!-- --></a>
  238. <div class="oddrow">
  239. <div class="method-header">
  240. <img src="../media/images/Constructor.png" />
  241. <span class="method-title">Constructor sloodle_view_controller</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcontroller.php.html#a33">33</a></span>)
  242. </div>
  243. <!-- ========== Info from phpDoc block ========= -->
  244. <p class="short-description">Constructor.</p>
  245. <div class="method-signature">
  246. <span class="method-result">sloodle_view_controller</span>
  247. <span class="method-name">
  248. sloodle_view_controller
  249. </span>
  250. ()
  251. </div>
  252. </div>
  253. <a name="methodprocess_form" id="process_form"><!-- --></a>
  254. <div class="evenrow">
  255. <div class="method-header">
  256. <img src="../media/images/Method.png" />
  257. <span class="method-title">process_form</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcontroller.php.html#a51">51</a></span>)
  258. </div>
  259. <!-- ========== Info from phpDoc block ========= -->
  260. <p class="short-description">Process any form data which has been submitted.</p>
  261. <div class="method-signature">
  262. <span class="method-result">void</span>
  263. <span class="method-name">
  264. process_form
  265. </span>
  266. ()
  267. </div>
  268. <hr class="separator" />
  269. <div class="notes">Redefinition of:</div>
  270. <dl>
  271. <dt><a href="../sloodle/sloodle_base_view_module.html#methodprocess_form">sloodle_base_view_module::process_form()</a></dt>
  272. <dd>Process any form data which has been submitted.</dd>
  273. </dl>
  274. </div>
  275. <a name="methodprocess_request" id="process_request"><!-- --></a>
  276. <div class="oddrow">
  277. <div class="method-header">
  278. <img src="../media/images/Method.png" />
  279. <span class="method-title">process_request</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcontroller.php.html#a40">40</a></span>)
  280. </div>
  281. <!-- ========== Info from phpDoc block ========= -->
  282. <p class="short-description">Uses the parent class to process basic request information, then obtains additional Controller data.</p>
  283. <div class="method-signature">
  284. <span class="method-result">void</span>
  285. <span class="method-name">
  286. process_request
  287. </span>
  288. ()
  289. </div>
  290. <hr class="separator" />
  291. <div class="notes">Redefinition of:</div>
  292. <dl>
  293. <dt><a href="../sloodle/sloodle_base_view_module.html#methodprocess_request">sloodle_base_view_module::process_request()</a></dt>
  294. <dd>Checks for incoming request data identifying a particular module (parameter 'id').</dd>
  295. </dl>
  296. </div>
  297. <a name="methodrender" id="render"><!-- --></a>
  298. <div class="evenrow">
  299. <div class="method-header">
  300. <img src="../media/images/Method.png" />
  301. <span class="method-title">render</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcontroller.php.html#a58">58</a></span>)
  302. </div>
  303. <!-- ========== Info from phpDoc block ========= -->
  304. <p class="short-description">Render the view of the Controller.</p>
  305. <div class="method-signature">
  306. <span class="method-result">void</span>
  307. <span class="method-name">
  308. render
  309. </span>
  310. ()
  311. </div>
  312. <hr class="separator" />
  313. <div class="notes">Redefinition of:</div>
  314. <dl>
  315. <dt><a href="../sloodle/sloodle_base_view_module.html#methodrender">sloodle_base_view_module::render()</a></dt>
  316. <dd>Render the view of the module or feature.</dd>
  317. </dl>
  318. </div>
  319. <h4>Inherited Methods</h4>
  320. <a name='inherited_methods'><!-- --></a>
  321. <!-- =========== Summary =========== -->
  322. <p>Inherited From <span class="classname"><a href="../sloodle/sloodle_base_view_module.html">sloodle_base_view_module</a></span></p>
  323. <blockquote>
  324. <img src="../media/images/Constructor.png" alt=" "/>
  325. <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodsloodle_base_view_module">sloodle_base_view_module::sloodle_base_view_module()</a></span><br>
  326. <img src="../media/images/Method.png" alt=" "/>
  327. <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodcheck_permission">sloodle_base_view_module::check_permission()</a></span><br>
  328. <img src="../media/images/Method.png" alt=" "/>
  329. <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodprint_footer">sloodle_base_view_module::print_footer()</a></span><br>
  330. <img src="../media/images/Method.png" alt=" "/>
  331. <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodprint_header">sloodle_base_view_module::print_header()</a></span><br>
  332. <img src="../media/images/Method.png" alt=" "/>
  333. <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodprocess_form">sloodle_base_view_module::process_form()</a></span><br>
  334. <img src="../media/images/Method.png" alt=" "/>
  335. <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodprocess_request">sloodle_base_view_module::process_request()</a></span><br>
  336. <img src="../media/images/Method.png" alt=" "/>
  337. <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodrender">sloodle_base_view_module::render()</a></span><br>
  338. </blockquote>
  339. <!-- =========== Summary =========== -->
  340. <p>Inherited From <span class="classname"><a href="../sloodle/sloodle_base_view.html">sloodle_base_view</a></span></p>
  341. <blockquote>
  342. <img src="../media/images/Constructor.png" alt=" "/>
  343. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodsloodle_base_view">sloodle_base_view::sloodle_base_view()</a></span><br>
  344. <img src="../media/images/Method.png" alt=" "/>
  345. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodcheck_permission">sloodle_base_view::check_permission()</a></span><br>
  346. <img src="../media/images/Method.png" alt=" "/>
  347. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprint_footer">sloodle_base_view::print_footer()</a></span><br>
  348. <img src="../media/images/Method.png" alt=" "/>
  349. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprint_header">sloodle_base_view::print_header()</a></span><br>
  350. <img src="../media/images/Method.png" alt=" "/>
  351. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprocess_form">sloodle_base_view::process_form()</a></span><br>
  352. <img src="../media/images/Method.png" alt=" "/>
  353. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprocess_request">sloodle_base_view::process_request()</a></span><br>
  354. <img src="../media/images/Method.png" alt=" "/>
  355. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodrender">sloodle_base_view::render()</a></span><br>
  356. <img src="../media/images/Method.png" alt=" "/>
  357. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodview">sloodle_base_view::view()</a></span><br>
  358. </blockquote>
  359. </div>
  360. </div>
  361. <p class="notes" id="credit">
  362. Documentation generated on Fri, 17 Jul 2009 11:01:09 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  363. </p>
  364. </div></body>
  365. </html>