sloodle_view_map.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489
  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_map</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_map</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 a Map module in Moodle.</p>
  99. <p class="notes">
  100. Located in <a class="field" href="_view---map.php.html">/view/map.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__viewmap.php.html#a22">22</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_map</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">array</span>
  123. <a href="#$locations" title="details" class="var-name">$locations</a>
  124. </div>
  125. <div class="var-title">
  126. <img src="../media/images/PrivateVariable.png" alt=" " />
  127. <span class="var-type"><a href="../sloodle/SloodleModuleMap.html">SloodleModuleMap</a></span>
  128. <a href="#$sloodle_map_module" title="details" class="var-name">$sloodle_map_module</a>
  129. </div>
  130. </div>
  131. </div>
  132. </div>
  133. <a name="sec-method-summary"></a>
  134. <div class="info-box">
  135. <div class="info-box-title">Method Summary</span></div>
  136. <div class="nav-bar">
  137. <a href="#sec-description">Description</a> |
  138. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  139. |
  140. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  141. </div>
  142. <div class="info-box-body">
  143. <div class="method-summary">
  144. <div class="method-definition">
  145. <img src="../media/images/Constructor.png" alt=" "/>
  146. <span class="method-result">sloodle_view_map</span>
  147. <a href="#sloodle_view_map" title="details" class="method-name">sloodle_view_map</a>
  148. ()
  149. </div>
  150. <div class="method-definition">
  151. <img src="../media/images/Method.png" alt=" "/>
  152. <span class="method-result">void</span>
  153. <a href="#print_header" title="details" class="method-name">print_header</a>
  154. ()
  155. </div>
  156. <div class="method-definition">
  157. <img src="../media/images/Method.png" alt=" "/>
  158. <span class="method-result">void</span>
  159. <a href="#process_form" title="details" class="method-name">process_form</a>
  160. ()
  161. </div>
  162. <div class="method-definition">
  163. <img src="../media/images/Method.png" alt=" "/>
  164. <span class="method-result">void</span>
  165. <a href="#process_request" title="details" class="method-name">process_request</a>
  166. ()
  167. </div>
  168. <div class="method-definition">
  169. <img src="../media/images/Method.png" alt=" "/>
  170. <span class="method-result">void</span>
  171. <a href="#render" title="details" class="method-name">render</a>
  172. ()
  173. </div>
  174. </div>
  175. </div>
  176. </div>
  177. <a name="sec-vars"></a>
  178. <div class="info-box">
  179. <div class="info-box-title">Variables</div>
  180. <div class="nav-bar">
  181. <a href="#sec-description">Description</a> |
  182. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  183. |
  184. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  185. </div>
  186. <div class="info-box-body">
  187. <a name="var$locations" id="$locations"><!-- --></A>
  188. <div class="oddrow">
  189. <div class="var-header">
  190. <img src="../media/images/PrivateVariable.png" />
  191. <span class="var-title">
  192. <span class="var-type">array</span>
  193. <span class="var-name">$locations</span>
  194. = <span class="var-default">array()</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewmap.php.html#a36">36</a></span>)
  195. </span>
  196. </div>
  197. <!-- ========== Info from phpDoc block ========= -->
  198. <p class="short-description">Numeric array of locations, obtained from the <a href="../sloodle/SloodleModuleMap.html">SloodleModuleMap</a> object.</p>
  199. <ul class="tags">
  200. <li><span class="field">access:</span> private</li>
  201. </ul>
  202. </div>
  203. <a name="var$sloodle_map_module" id="$sloodle_map_module"><!-- --></A>
  204. <div class="evenrow">
  205. <div class="var-header">
  206. <img src="../media/images/PrivateVariable.png" />
  207. <span class="var-title">
  208. <span class="var-type"><a href="../sloodle/SloodleModuleMap.html">SloodleModuleMap</a></span>
  209. <span class="var-name">$sloodle_map_module</span>
  210. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewmap.php.html#a29">29</a></span>)
  211. </span>
  212. </div>
  213. <!-- ========== Info from phpDoc block ========= -->
  214. <p class="short-description">A SLOODLE map module object to wrap the basic map functionality.</p>
  215. <ul class="tags">
  216. <li><span class="field">access:</span> private</li>
  217. </ul>
  218. </div>
  219. <h4>Inherited Variables</h4>
  220. <A NAME='inherited_vars'><!-- --></A>
  221. <p>Inherited from <span class="classname"><a href="../sloodle/sloodle_base_view_module.html">sloodle_base_view_module</a></span></p>
  222. <blockquote>
  223. <img src="../media/images/PrivateVariable.png" />
  224. <span class="var-title">
  225. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$canedit">sloodle_base_view_module::$canedit</a></span><br>
  226. </span>
  227. <img src="../media/images/PrivateVariable.png" />
  228. <span class="var-title">
  229. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$cm">sloodle_base_view_module::$cm</a></span><br>
  230. </span>
  231. <img src="../media/images/PrivateVariable.png" />
  232. <span class="var-title">
  233. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$course">sloodle_base_view_module::$course</a></span><br>
  234. </span>
  235. <img src="../media/images/PrivateVariable.png" />
  236. <span class="var-title">
  237. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$course_context">sloodle_base_view_module::$course_context</a></span><br>
  238. </span>
  239. <img src="../media/images/PrivateVariable.png" />
  240. <span class="var-title">
  241. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$module_context">sloodle_base_view_module::$module_context</a></span><br>
  242. </span>
  243. <img src="../media/images/PrivateVariable.png" />
  244. <span class="var-title">
  245. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$sloodle">sloodle_base_view_module::$sloodle</a></span><br>
  246. </span>
  247. <img src="../media/images/PrivateVariable.png" />
  248. <span class="var-title">
  249. <span class="var-name"><a href="../sloodle/sloodle_base_view_module.html#var$sloodle_course">sloodle_base_view_module::$sloodle_course</a></span><br>
  250. </span>
  251. </blockquote>
  252. </div>
  253. </div>
  254. <a name="sec-methods"></a>
  255. <div class="info-box">
  256. <div class="info-box-title">Methods</div>
  257. <div class="nav-bar">
  258. <a href="#sec-description">Description</a> |
  259. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  260. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  261. </div>
  262. <div class="info-box-body">
  263. <A NAME='method_detail'></A>
  264. <a name="methodsloodle_view_map" id="sloodle_view_map"><!-- --></a>
  265. <div class="oddrow">
  266. <div class="method-header">
  267. <img src="../media/images/Constructor.png" />
  268. <span class="method-title">Constructor sloodle_view_map</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewmap.php.html#a41">41</a></span>)
  269. </div>
  270. <!-- ========== Info from phpDoc block ========= -->
  271. <p class="short-description">Constructor.</p>
  272. <div class="method-signature">
  273. <span class="method-result">sloodle_view_map</span>
  274. <span class="method-name">
  275. sloodle_view_map
  276. </span>
  277. ()
  278. </div>
  279. </div>
  280. <a name="methodprint_header" id="print_header"><!-- --></a>
  281. <div class="evenrow">
  282. <div class="method-header">
  283. <img src="../media/images/Method.png" />
  284. <span class="method-title">print_header</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewmap.php.html#a72">72</a></span>)
  285. </div>
  286. <!-- ========== Info from phpDoc block ========= -->
  287. <p class="short-description">Print the page header (requires special scripts to be added into the header)</p>
  288. <div class="method-signature">
  289. <span class="method-result">void</span>
  290. <span class="method-name">
  291. print_header
  292. </span>
  293. ()
  294. </div>
  295. <hr class="separator" />
  296. <div class="notes">Redefinition of:</div>
  297. <dl>
  298. <dt><a href="../sloodle/sloodle_base_view_module.html#methodprint_header">sloodle_base_view_module::print_header()</a></dt>
  299. <dd>Print module header info.</dd>
  300. </dl>
  301. </div>
  302. <a name="methodprocess_form" id="process_form"><!-- --></a>
  303. <div class="oddrow">
  304. <div class="method-header">
  305. <img src="../media/images/Method.png" />
  306. <span class="method-title">process_form</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewmap.php.html#a65">65</a></span>)
  307. </div>
  308. <!-- ========== Info from phpDoc block ========= -->
  309. <p class="short-description">Process any form data which has been submitted.</p>
  310. <div class="method-signature">
  311. <span class="method-result">void</span>
  312. <span class="method-name">
  313. process_form
  314. </span>
  315. ()
  316. </div>
  317. <hr class="separator" />
  318. <div class="notes">Redefinition of:</div>
  319. <dl>
  320. <dt><a href="../sloodle/sloodle_base_view_module.html#methodprocess_form">sloodle_base_view_module::process_form()</a></dt>
  321. <dd>Process any form data which has been submitted.</dd>
  322. </dl>
  323. </div>
  324. <a name="methodprocess_request" id="process_request"><!-- --></a>
  325. <div class="evenrow">
  326. <div class="method-header">
  327. <img src="../media/images/Method.png" />
  328. <span class="method-title">process_request</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewmap.php.html#a48">48</a></span>)
  329. </div>
  330. <!-- ========== Info from phpDoc block ========= -->
  331. <p class="short-description">Processes request data to determine which Map is being accessed.</p>
  332. <div class="method-signature">
  333. <span class="method-result">void</span>
  334. <span class="method-name">
  335. process_request
  336. </span>
  337. ()
  338. </div>
  339. <hr class="separator" />
  340. <div class="notes">Redefinition of:</div>
  341. <dl>
  342. <dt><a href="../sloodle/sloodle_base_view_module.html#methodprocess_request">sloodle_base_view_module::process_request()</a></dt>
  343. <dd>Checks for incoming request data identifying a particular module (parameter 'id').</dd>
  344. </dl>
  345. </div>
  346. <a name="methodrender" id="render"><!-- --></a>
  347. <div class="oddrow">
  348. <div class="method-header">
  349. <img src="../media/images/Method.png" />
  350. <span class="method-title">render</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__viewmap.php.html#a174">174</a></span>)
  351. </div>
  352. <!-- ========== Info from phpDoc block ========= -->
  353. <p class="short-description">Render the view of the Map.</p>
  354. <div class="method-signature">
  355. <span class="method-result">void</span>
  356. <span class="method-name">
  357. render
  358. </span>
  359. ()
  360. </div>
  361. <hr class="separator" />
  362. <div class="notes">Redefinition of:</div>
  363. <dl>
  364. <dt><a href="../sloodle/sloodle_base_view_module.html#methodrender">sloodle_base_view_module::render()</a></dt>
  365. <dd>Render the view of the module or feature.</dd>
  366. </dl>
  367. </div>
  368. <h4>Inherited Methods</h4>
  369. <a name='inherited_methods'><!-- --></a>
  370. <!-- =========== Summary =========== -->
  371. <p>Inherited From <span class="classname"><a href="../sloodle/sloodle_base_view_module.html">sloodle_base_view_module</a></span></p>
  372. <blockquote>
  373. <img src="../media/images/Constructor.png" alt=" "/>
  374. <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>
  375. <img src="../media/images/Method.png" alt=" "/>
  376. <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodcheck_permission">sloodle_base_view_module::check_permission()</a></span><br>
  377. <img src="../media/images/Method.png" alt=" "/>
  378. <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodprint_footer">sloodle_base_view_module::print_footer()</a></span><br>
  379. <img src="../media/images/Method.png" alt=" "/>
  380. <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodprint_header">sloodle_base_view_module::print_header()</a></span><br>
  381. <img src="../media/images/Method.png" alt=" "/>
  382. <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodprocess_form">sloodle_base_view_module::process_form()</a></span><br>
  383. <img src="../media/images/Method.png" alt=" "/>
  384. <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodprocess_request">sloodle_base_view_module::process_request()</a></span><br>
  385. <img src="../media/images/Method.png" alt=" "/>
  386. <span class="method-name"><a href="../sloodle/sloodle_base_view_module.html#methodrender">sloodle_base_view_module::render()</a></span><br>
  387. </blockquote>
  388. <!-- =========== Summary =========== -->
  389. <p>Inherited From <span class="classname"><a href="../sloodle/sloodle_base_view.html">sloodle_base_view</a></span></p>
  390. <blockquote>
  391. <img src="../media/images/Constructor.png" alt=" "/>
  392. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodsloodle_base_view">sloodle_base_view::sloodle_base_view()</a></span><br>
  393. <img src="../media/images/Method.png" alt=" "/>
  394. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodcheck_permission">sloodle_base_view::check_permission()</a></span><br>
  395. <img src="../media/images/Method.png" alt=" "/>
  396. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprint_footer">sloodle_base_view::print_footer()</a></span><br>
  397. <img src="../media/images/Method.png" alt=" "/>
  398. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprint_header">sloodle_base_view::print_header()</a></span><br>
  399. <img src="../media/images/Method.png" alt=" "/>
  400. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprocess_form">sloodle_base_view::process_form()</a></span><br>
  401. <img src="../media/images/Method.png" alt=" "/>
  402. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodprocess_request">sloodle_base_view::process_request()</a></span><br>
  403. <img src="../media/images/Method.png" alt=" "/>
  404. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodrender">sloodle_base_view::render()</a></span><br>
  405. <img src="../media/images/Method.png" alt=" "/>
  406. <span class="method-name"><a href="../sloodle/sloodle_base_view.html#methodview">sloodle_base_view::view()</a></span><br>
  407. </blockquote>
  408. </div>
  409. </div>
  410. <p class="notes" id="credit">
  411. Documentation generated on Fri, 17 Jul 2009 11:01:50 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  412. </p>
  413. </div></body>
  414. </html>