sloodle_view_course.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500
  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_course</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_course</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">Class for rendering a view of SLOODLE course information.</p>
  99. <p class="notes">
  100. Located in <a class="field" href="_view---course.php.html">/view/course.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__viewcourse.php.html#a24">24</a></span>)
  101. </p>
  102. <pre><a href="../sloodle/sloodle_base_view.html">sloodle_base_view</a>
  103. |
  104. --sloodle_view_course</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="#$course" title="details" class="var-name">$course</a>
  122. </div>
  123. <div class="var-title">
  124. <img src="../media/images/PrivateVariable.png" alt=" " />
  125. <span class="var-type">object</span>
  126. <a href="#$course_context" title="details" class="var-name">$course_context</a>
  127. </div>
  128. <div class="var-title">
  129. <img src="../media/images/PrivateVariable.png" alt=" " />
  130. <span class="var-type">object</span>
  131. <a href="#$sloodle_course" title="details" class="var-name">$sloodle_course</a>
  132. </div>
  133. </div>
  134. </div>
  135. </div>
  136. <a name="sec-method-summary"></a>
  137. <div class="info-box">
  138. <div class="info-box-title">Method Summary</span></div>
  139. <div class="nav-bar">
  140. <a href="#sec-description">Description</a> |
  141. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  142. |
  143. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  144. </div>
  145. <div class="info-box-body">
  146. <div class="method-summary">
  147. <div class="method-definition">
  148. <img src="../media/images/Constructor.png" alt=" "/>
  149. <span class="method-result">sloodle_view_course</span>
  150. <a href="#sloodle_view_course" title="details" class="method-name">sloodle_view_course</a>
  151. ()
  152. </div>
  153. <div class="method-definition">
  154. <img src="../media/images/Method.png" alt=" "/>
  155. <span class="method-result">void</span>
  156. <a href="#check_permission" title="details" class="method-name">check_permission</a>
  157. ()
  158. </div>
  159. <div class="method-definition">
  160. <img src="../media/images/Method.png" alt=" "/>
  161. <span class="method-result">void</span>
  162. <a href="#print_footer" title="details" class="method-name">print_footer</a>
  163. ()
  164. </div>
  165. <div class="method-definition">
  166. <img src="../media/images/Method.png" alt=" "/>
  167. <span class="method-result">void</span>
  168. <a href="#print_header" title="details" class="method-name">print_header</a>
  169. ()
  170. </div>
  171. <div class="method-definition">
  172. <img src="../media/images/Method.png" alt=" "/>
  173. <span class="method-result">void</span>
  174. <a href="#process_request" title="details" class="method-name">process_request</a>
  175. ()
  176. </div>
  177. <div class="method-definition">
  178. <img src="../media/images/Method.png" alt=" "/>
  179. <span class="method-result">void</span>
  180. <a href="#render" title="details" class="method-name">render</a>
  181. ()
  182. </div>
  183. </div>
  184. </div>
  185. </div>
  186. <a name="sec-vars"></a>
  187. <div class="info-box">
  188. <div class="info-box-title">Variables</div>
  189. <div class="nav-bar">
  190. <a href="#sec-description">Description</a> |
  191. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  192. |
  193. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  194. </div>
  195. <div class="info-box-body">
  196. <a name="var$course" id="$course"><!-- --></A>
  197. <div class="evenrow">
  198. <div class="var-header">
  199. <img src="../media/images/PrivateVariable.png" />
  200. <span class="var-title">
  201. <span class="var-type">object</span>
  202. <span class="var-name">$course</span>
  203. = <span class="var-default"> 0</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcourse.php.html#a31">31</a></span>)
  204. </span>
  205. </div>
  206. <!-- ========== Info from phpDoc block ========= -->
  207. <p class="short-description">The VLE course object, retrieved directly from database.</p>
  208. <ul class="tags">
  209. <li><span class="field">access:</span> private</li>
  210. </ul>
  211. </div>
  212. <a name="var$course_context" id="$course_context"><!-- --></A>
  213. <div class="oddrow">
  214. <div class="var-header">
  215. <img src="../media/images/PrivateVariable.png" />
  216. <span class="var-title">
  217. <span class="var-type">object</span>
  218. <span class="var-name">$course_context</span>
  219. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcourse.php.html#a45">45</a></span>)
  220. </span>
  221. </div>
  222. <!-- ========== Info from phpDoc block ========= -->
  223. <p class="short-description">Course context for Moodle permissions.</p>
  224. <ul class="tags">
  225. <li><span class="field">access:</span> private</li>
  226. </ul>
  227. </div>
  228. <a name="var$sloodle_course" id="$sloodle_course"><!-- --></A>
  229. <div class="evenrow">
  230. <div class="var-header">
  231. <img src="../media/images/PrivateVariable.png" />
  232. <span class="var-title">
  233. <span class="var-type">object</span>
  234. <span class="var-name">$sloodle_course</span>
  235. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcourse.php.html#a38">38</a></span>)
  236. </span>
  237. </div>
  238. <!-- ========== Info from phpDoc block ========= -->
  239. <p class="short-description">SLOODLE course object, retrieved directly from database.</p>
  240. <ul class="tags">
  241. <li><span class="field">access:</span> private</li>
  242. </ul>
  243. </div>
  244. </div>
  245. </div>
  246. <a name="sec-methods"></a>
  247. <div class="info-box">
  248. <div class="info-box-title">Methods</div>
  249. <div class="nav-bar">
  250. <a href="#sec-description">Description</a> |
  251. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  252. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  253. </div>
  254. <div class="info-box-body">
  255. <A NAME='method_detail'></A>
  256. <a name="methodsloodle_view_course" id="sloodle_view_course"><!-- --></a>
  257. <div class="oddrow">
  258. <div class="method-header">
  259. <img src="../media/images/Constructor.png" />
  260. <span class="method-title">Constructor sloodle_view_course</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcourse.php.html#a51">51</a></span>)
  261. </div>
  262. <!-- ========== Info from phpDoc block ========= -->
  263. <p class="short-description">Constructor.</p>
  264. <div class="method-signature">
  265. <span class="method-result">sloodle_view_course</span>
  266. <span class="method-name">
  267. sloodle_view_course
  268. </span>
  269. ()
  270. </div>
  271. </div>
  272. <a name="methodcheck_permission" id="check_permission"><!-- --></a>
  273. <div class="evenrow">
  274. <div class="method-header">
  275. <img src="../media/images/Method.png" />
  276. <span class="method-title">check_permission</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcourse.php.html#a69">69</a></span>)
  277. </div>
  278. <!-- ========== Info from phpDoc block ========= -->
  279. <p class="short-description">Check that the user is logged-in and has permission to alter course settings.</p>
  280. <div class="method-signature">
  281. <span class="method-result">void</span>
  282. <span class="method-name">
  283. check_permission
  284. </span>
  285. ()
  286. </div>
  287. <hr class="separator" />
  288. <div class="notes">Redefinition of:</div>
  289. <dl>
  290. <dt><a href="../sloodle/sloodle_base_view.html#methodcheck_permission">sloodle_base_view::check_permission()</a></dt>
  291. <dd>Check that the user has permission to access the current resources.</dd>
  292. </dl>
  293. </div>
  294. <a name="methodprint_footer" id="print_footer"><!-- --></a>
  295. <div class="oddrow">
  296. <div class="method-header">
  297. <img src="../media/images/Method.png" />
  298. <span class="method-title">print_footer</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcourse.php.html#a310">310</a></span>)
  299. </div>
  300. <!-- ========== Info from phpDoc block ========= -->
  301. <p class="short-description">Print the footer for this course.</p>
  302. <div class="method-signature">
  303. <span class="method-result">void</span>
  304. <span class="method-name">
  305. print_footer
  306. </span>
  307. ()
  308. </div>
  309. <hr class="separator" />
  310. <div class="notes">Redefinition of:</div>
  311. <dl>
  312. <dt><a href="../sloodle/sloodle_base_view.html#methodprint_footer">sloodle_base_view::print_footer()</a></dt>
  313. <dd>Output the page footer.</dd>
  314. </dl>
  315. </div>
  316. <a name="methodprint_header" id="print_header"><!-- --></a>
  317. <div class="evenrow">
  318. <div class="method-header">
  319. <img src="../media/images/Method.png" />
  320. <span class="method-title">print_header</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcourse.php.html#a84">84</a></span>)
  321. </div>
  322. <!-- ========== Info from phpDoc block ========= -->
  323. <p class="short-description">Print the course settings page header.</p>
  324. <div class="method-signature">
  325. <span class="method-result">void</span>
  326. <span class="method-name">
  327. print_header
  328. </span>
  329. ()
  330. </div>
  331. <hr class="separator" />
  332. <div class="notes">Redefinition of:</div>
  333. <dl>
  334. <dt><a href="../sloodle/sloodle_base_view.html#methodprint_header">sloodle_base_view::print_header()</a></dt>
  335. <dd>Print the standard page header.</dd>
  336. </dl>
  337. </div>
  338. <a name="methodprocess_request" id="process_request"><!-- --></a>
  339. <div class="oddrow">
  340. <div class="method-header">
  341. <img src="../media/images/Method.png" />
  342. <span class="method-title">process_request</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcourse.php.html#a58">58</a></span>)
  343. </div>
  344. <!-- ========== Info from phpDoc block ========= -->
  345. <p class="short-description">Check the request parameters to see which course was specified.</p>
  346. <div class="method-signature">
  347. <span class="method-result">void</span>
  348. <span class="method-name">
  349. process_request
  350. </span>
  351. ()
  352. </div>
  353. <hr class="separator" />
  354. <div class="notes">Redefinition of:</div>
  355. <dl>
  356. <dt><a href="../sloodle/sloodle_base_view.html#methodprocess_request">sloodle_base_view::process_request()</a></dt>
  357. <dd>Check for incoming request data identifying a particular course or module.</dd>
  358. </dl>
  359. </div>
  360. <a name="methodrender" id="render"><!-- --></a>
  361. <div class="evenrow">
  362. <div class="method-header">
  363. <img src="../media/images/Method.png" />
  364. <span class="method-title">render</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewcourse.php.html#a95">95</a></span>)
  365. </div>
  366. <!-- ========== Info from phpDoc block ========= -->
  367. <p class="short-description">Render the view of the module or feature.</p>
  368. <p class="description"><p>This MUST be overridden to provide functionality.</p></p>
  369. <div class="method-signature">
  370. <span class="method-result">void</span>
  371. <span class="method-name">
  372. render
  373. </span>
  374. ()
  375. </div>
  376. <hr class="separator" />
  377. <div class="notes">Redefinition of:</div>
  378. <dl>
  379. <dt><a href="../sloodle/sloodle_base_view.html#methodrender">sloodle_base_view::render()</a></dt>
  380. <dd>Render the view of the module or feature.</dd>
  381. </dl>
  382. </div>
  383. <h4>Inherited Methods</h4>
  384. <a name='inherited_methods'><!-- --></a>
  385. <!-- =========== Summary =========== -->
  386. <p>Inherited From <span class="classname"><a href="../sloodle/sloodle_base_view.html">sloodle_base_view</a></span></p>
  387. <blockquote>
  388. <img src="../media/images/Constructor.png" alt=" "/>
  389. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodsloodle_base_view">sloodle_base_view::sloodle_base_view()</a></span><br>
  390. <img src="../media/images/Method.png" alt=" "/>
  391. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodcheck_permission">sloodle_base_view::check_permission()</a></span><br>
  392. <img src="../media/images/Method.png" alt=" "/>
  393. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprint_footer">sloodle_base_view::print_footer()</a></span><br>
  394. <img src="../media/images/Method.png" alt=" "/>
  395. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprint_header">sloodle_base_view::print_header()</a></span><br>
  396. <img src="../media/images/Method.png" alt=" "/>
  397. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprocess_form">sloodle_base_view::process_form()</a></span><br>
  398. <img src="../media/images/Method.png" alt=" "/>
  399. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprocess_request">sloodle_base_view::process_request()</a></span><br>
  400. <img src="../media/images/Method.png" alt=" "/>
  401. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodrender">sloodle_base_view::render()</a></span><br>
  402. <img src="../media/images/Method.png" alt=" "/>
  403. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodview">sloodle_base_view::view()</a></span><br>
  404. </blockquote>
  405. </div>
  406. </div>
  407. <p class="notes" id="credit">
  408. Documentation generated on Fri, 17 Jul 2009 11:01:11 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  409. </p>
  410. </div></body>
  411. </html>