SloodleModulePresenter.html 40 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015
  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 SloodleModulePresenter</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"> SloodleModulePresenter</h2>
  88. <a name="sec-description"></a>
  89. <div class="info-box">
  90. <div class="info-box-title">Description</div>
  91. <div class="nav-bar">
  92. <span class="disabled">Description</span> |
  93. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  94. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  95. </div>
  96. <div class="info-box-body">
  97. <!-- ========== Info from phpDoc block ========= -->
  98. <p class="short-description">The Sloodle presenter module class.</p>
  99. <p class="notes">
  100. Located in <a class="field" href="_lib---modules---module_presenter.php.html">/lib/modules/module_presenter.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a23">23</a></span>)
  101. </p>
  102. <pre><a href="../sloodle/SloodleModule.html">SloodleModule</a>
  103. |
  104. --SloodleModulePresenter</pre>
  105. </div>
  106. </div>
  107. <a name="sec-var-summary"></a>
  108. <div class="info-box">
  109. <div class="info-box-title">Variable Summary</span></div>
  110. <div class="nav-bar">
  111. <a href="#sec-description">Description</a> |
  112. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  113. |
  114. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  115. </div>
  116. <div class="info-box-body">
  117. <div class="var-summary">
  118. <div class="var-title">
  119. <img src="../media/images/PrivateVariable.png" alt=" " />
  120. <span class="var-type">object</span>
  121. <a href="#$cm" title="details" class="var-name">$cm</a>
  122. </div>
  123. <div class="var-title">
  124. <img src="../media/images/PrivateVariable.png" alt=" " />
  125. <span class="var-type">object</span>
  126. <a href="#$presenter" title="details" class="var-name">$presenter</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_instance" title="details" class="var-name">$sloodle_instance</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">SloodleModulePresenter</span>
  150. <a href="#SloodleModulePresenter" title="details" class="method-name">SloodleModulePresenter</a>
  151. (<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
  152. </div>
  153. <div class="method-definition">
  154. <img src="../media/images/Method.png" alt=" "/>
  155. <span class="method-result">True</span>
  156. <a href="#add_entry" title="details" class="method-name">add_entry</a>
  157. (<span class="var-type">string</span>&nbsp;<span class="var-name">$source</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$position</span> = <span class="var-default">-1</span>])
  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="#delete_entry" title="details" class="method-name">delete_entry</a>
  163. (<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>)
  164. </div>
  165. <div class="method-definition">
  166. <img src="../media/images/Method.png" alt=" "/>
  167. <span class="method-result">True</span>
  168. <a href="#edit_entry" title="details" class="method-name">edit_entry</a>
  169. (<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$source</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$position</span> = <span class="var-default">-1</span>])
  170. </div>
  171. <div class="method-definition">
  172. <img src="../media/images/Method.png" alt=" "/>
  173. <span class="method-result">mixed</span>
  174. <a href="#get_course_id" title="details" class="method-name">get_course_id</a>
  175. ()
  176. </div>
  177. <div class="method-definition">
  178. <img src="../media/images/Method.png" alt=" "/>
  179. <span class="method-result">int</span>
  180. <a href="#get_creation_time" title="details" class="method-name">get_creation_time</a>
  181. ()
  182. </div>
  183. <div class="method-definition">
  184. <img src="../media/images/Method.png" alt=" "/>
  185. <span class="method-result">2d</span>
  186. <a href="#get_entry_urls" title="details" class="method-name">get_entry_urls</a>
  187. ()
  188. </div>
  189. <div class="method-definition">
  190. <img src="../media/images/Method.png" alt=" "/>
  191. <span class="method-result">int</span>
  192. <a href="#get_frame_height" title="details" class="method-name">get_frame_height</a>
  193. ()
  194. </div>
  195. <div class="method-definition">
  196. <img src="../media/images/Method.png" alt=" "/>
  197. <span class="method-result">int</span>
  198. <a href="#get_frame_width" title="details" class="method-name">get_frame_width</a>
  199. ()
  200. </div>
  201. <div class="method-definition">
  202. <img src="../media/images/Method.png" alt=" "/>
  203. <span class="method-result">string</span>
  204. <a href="#get_intro" title="details" class="method-name">get_intro</a>
  205. ()
  206. </div>
  207. <div class="method-definition">
  208. <img src="../media/images/Method.png" alt=" "/>
  209. <span class="method-result">int</span>
  210. <a href="#get_modification_time" title="details" class="method-name">get_modification_time</a>
  211. ()
  212. </div>
  213. <div class="method-definition">
  214. <img src="../media/images/Method.png" alt=" "/>
  215. <span class="method-result">string</span>
  216. <a href="#get_name" title="details" class="method-name">get_name</a>
  217. ()
  218. </div>
  219. <div class="method-definition">
  220. <img src="../media/images/Method.png" alt=" "/>
  221. <span class="method-result">Array</span>
  222. <a href="#get_slides" title="details" class="method-name">get_slides</a>
  223. ()
  224. </div>
  225. <div class="method-definition">
  226. <img src="../media/images/Method.png" alt=" "/>
  227. <span class="method-result">string</span>
  228. <a href="#get_type" title="details" class="method-name">get_type</a>
  229. ()
  230. </div>
  231. <div class="method-definition">
  232. <img src="../media/images/Method.png" alt=" "/>
  233. <span class="method-result">string</span>
  234. <a href="#get_type_full" title="details" class="method-name">get_type_full</a>
  235. ()
  236. </div>
  237. <div class="method-definition">
  238. <img src="../media/images/Method.png" alt=" "/>
  239. <span class="method-result">bool</span>
  240. <a href="#load" title="details" class="method-name">load</a>
  241. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  242. </div>
  243. <div class="method-definition">
  244. <img src="../media/images/Method.png" alt=" "/>
  245. <span class="method-result">void</span>
  246. <a href="#move_entry" title="details" class="method-name">move_entry</a>
  247. (<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$forward</span>)
  248. </div>
  249. <div class="method-definition">
  250. <img src="../media/images/Method.png" alt=" "/>
  251. <span class="method-result">void</span>
  252. <a href="#relocate_entry" title="details" class="method-name">relocate_entry</a>
  253. (<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$pos</span>)
  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="#validate_ordering" title="details" class="method-name">validate_ordering</a>
  259. ()
  260. </div>
  261. </div>
  262. </div>
  263. </div>
  264. <a name="sec-vars"></a>
  265. <div class="info-box">
  266. <div class="info-box-title">Variables</div>
  267. <div class="nav-bar">
  268. <a href="#sec-description">Description</a> |
  269. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  270. |
  271. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  272. </div>
  273. <div class="info-box-body">
  274. <a name="var$cm" id="$cm"><!-- --></A>
  275. <div class="oddrow">
  276. <div class="var-header">
  277. <img src="../media/images/PrivateVariable.png" />
  278. <span class="var-title">
  279. <span class="var-type">object</span>
  280. <span class="var-name">$cm</span>
  281. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a33">33</a></span>)
  282. </span>
  283. </div>
  284. <!-- ========== Info from phpDoc block ========= -->
  285. <p class="short-description">Internal for Moodle only - course module instance.</p>
  286. <p class="description"><p>Corresponds to one record from the Moodle 'course_modules' table.</p></p>
  287. <ul class="tags">
  288. <li><span class="field">access:</span> private</li>
  289. </ul>
  290. </div>
  291. <a name="var$presenter" id="$presenter"><!-- --></A>
  292. <div class="evenrow">
  293. <div class="var-header">
  294. <img src="../media/images/PrivateVariable.png" />
  295. <span class="var-title">
  296. <span class="var-type">object</span>
  297. <span class="var-name">$presenter</span>
  298. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a49">49</a></span>)
  299. </span>
  300. </div>
  301. <!-- ========== Info from phpDoc block ========= -->
  302. <p class="short-description">Internal only - a database objects representing the Presenter itself.</p>
  303. <p class="description"><p>Corresponds to one record from the Moodle 'mdl_sloodle_presenter' table.</p></p>
  304. <ul class="tags">
  305. <li><span class="field">access:</span> private</li>
  306. </ul>
  307. </div>
  308. <a name="var$sloodle_instance" id="$sloodle_instance"><!-- --></A>
  309. <div class="oddrow">
  310. <div class="var-header">
  311. <img src="../media/images/PrivateVariable.png" />
  312. <span class="var-title">
  313. <span class="var-type">object</span>
  314. <span class="var-name">$sloodle_instance</span>
  315. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a41">41</a></span>)
  316. </span>
  317. </div>
  318. <!-- ========== Info from phpDoc block ========= -->
  319. <p class="short-description">Internal only - Sloodle module instance database object.</p>
  320. <p class="description"><p>Corresponds to one record from the Moodle 'mdl_sloodle' table.</p></p>
  321. <ul class="tags">
  322. <li><span class="field">access:</span> private</li>
  323. </ul>
  324. </div>
  325. <h4>Inherited Variables</h4>
  326. <A NAME='inherited_vars'><!-- --></A>
  327. <p>Inherited from <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
  328. <blockquote>
  329. <img src="../media/images/Variable.png" />
  330. <span class="var-title">
  331. <span class="var-name"><a href="../sloodle/SloodleModule.html#var$_session">SloodleModule::$_session</a></span><br>
  332. </span>
  333. </blockquote>
  334. </div>
  335. </div>
  336. <a name="sec-methods"></a>
  337. <div class="info-box">
  338. <div class="info-box-title">Methods</div>
  339. <div class="nav-bar">
  340. <a href="#sec-description">Description</a> |
  341. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  342. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  343. </div>
  344. <div class="info-box-body">
  345. <A NAME='method_detail'></A>
  346. <a name="methodSloodleModulePresenter" id="SloodleModulePresenter"><!-- --></a>
  347. <div class="evenrow">
  348. <div class="method-header">
  349. <img src="../media/images/Constructor.png" />
  350. <span class="method-title">Constructor SloodleModulePresenter</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a58">58</a></span>)
  351. </div>
  352. <!-- ========== Info from phpDoc block ========= -->
  353. <p class="short-description">Constructor</p>
  354. <div class="method-signature">
  355. <span class="method-result">SloodleModulePresenter</span>
  356. <span class="method-name">
  357. SloodleModulePresenter
  358. </span>
  359. (<span class="var-type"></span>&nbsp;<span class="var-name">&$_session</span>)
  360. </div>
  361. <ul class="parameters">
  362. <li>
  363. <span class="var-type"></span>
  364. <span class="var-name">&$_session</span> </li>
  365. </ul>
  366. </div>
  367. <a name="methodadd_entry" id="add_entry"><!-- --></a>
  368. <div class="oddrow">
  369. <div class="method-header">
  370. <img src="../media/images/Method.png" />
  371. <span class="method-title">add_entry</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a168">168</a></span>)
  372. </div>
  373. <!-- ========== Info from phpDoc block ========= -->
  374. <p class="short-description">Adds a new entry to the presentation.</p>
  375. <ul class="tags">
  376. <li><span class="field">return:</span> if successful, or false on failure.</li>
  377. </ul>
  378. <div class="method-signature">
  379. <span class="method-result">True</span>
  380. <span class="method-name">
  381. add_entry
  382. </span>
  383. (<span class="var-type">string</span>&nbsp;<span class="var-name">$source</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$position</span> = <span class="var-default">-1</span>])
  384. </div>
  385. <ul class="parameters">
  386. <li>
  387. <span class="var-type">string</span>
  388. <span class="var-name">$source</span><span class="var-description">: A string containing the source address -- must start with http for absolute URLs</span> </li>
  389. <li>
  390. <span class="var-type">string</span>
  391. <span class="var-name">$type</span><span class="var-description">: Name of the type of source, e.g. &quot;web&quot;, &quot;image&quot;, or &quot;video&quot;</span> </li>
  392. <li>
  393. <span class="var-type">string</span>
  394. <span class="var-name">$name</span><span class="var-description">: Name of the slide</span> </li>
  395. <li>
  396. <span class="var-type">integer</span>
  397. <span class="var-name">$position</span><span class="var-description">: Integer indicating the position of the new entry. If negative, then it is placed last in the presentation.</span> </li>
  398. </ul>
  399. </div>
  400. <a name="methoddelete_entry" id="delete_entry"><!-- --></a>
  401. <div class="evenrow">
  402. <div class="method-header">
  403. <img src="../media/images/Method.png" />
  404. <span class="method-title">delete_entry</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a233">233</a></span>)
  405. </div>
  406. <!-- ========== Info from phpDoc block ========= -->
  407. <p class="short-description">Deletes the identified entry by ID.</p>
  408. <p class="description"><p>Only works if the entry is part of this presentation.</p></p>
  409. <div class="method-signature">
  410. <span class="method-result">void</span>
  411. <span class="method-name">
  412. delete_entry
  413. </span>
  414. (<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>)
  415. </div>
  416. <ul class="parameters">
  417. <li>
  418. <span class="var-type">int</span>
  419. <span class="var-name">$id</span><span class="var-description">: The ID of an entry record to delete</span> </li>
  420. </ul>
  421. </div>
  422. <a name="methodedit_entry" id="edit_entry"><!-- --></a>
  423. <div class="oddrow">
  424. <div class="method-header">
  425. <img src="../media/images/Method.png" />
  426. <span class="method-title">edit_entry</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a202">202</a></span>)
  427. </div>
  428. <!-- ========== Info from phpDoc block ========= -->
  429. <p class="short-description">Edits an existing entry in the presentation.</p>
  430. <ul class="tags">
  431. <li><span class="field">return:</span> if successful, or false on failure.</li>
  432. </ul>
  433. <div class="method-signature">
  434. <span class="method-result">True</span>
  435. <span class="method-name">
  436. edit_entry
  437. </span>
  438. (<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$source</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$position</span> = <span class="var-default">-1</span>])
  439. </div>
  440. <ul class="parameters">
  441. <li>
  442. <span class="var-type">int</span>
  443. <span class="var-name">$id</span><span class="var-description">: The ID of the entry in the database.</span> </li>
  444. <li>
  445. <span class="var-type">string</span>
  446. <span class="var-name">$source</span><span class="var-description">: A string containing the source address -- must start with http for absolute URLs</span> </li>
  447. <li>
  448. <span class="var-type">string</span>
  449. <span class="var-name">$type</span><span class="var-description">: Name of the type of source, e.g. &quot;web&quot;, &quot;image&quot;, or &quot;video&quot;</span> </li>
  450. <li>
  451. <span class="var-type">string</span>
  452. <span class="var-name">$name</span><span class="var-description">: Name of the slide</span> </li>
  453. <li>
  454. <span class="var-type">integer</span>
  455. <span class="var-name">$position</span><span class="var-description">: Integer indicating the desired position of the entry. If negative, then its position is left unchanged.</span> </li>
  456. </ul>
  457. </div>
  458. <a name="methodget_course_id" id="get_course_id"><!-- --></a>
  459. <div class="evenrow">
  460. <div class="method-header">
  461. <img src="../media/images/Method.png" />
  462. <span class="method-title">get_course_id</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a352">352</a></span>)
  463. </div>
  464. <!-- ========== Info from phpDoc block ========= -->
  465. <p class="short-description">Gets the identifier of the course this controller belongs to.</p>
  466. <ul class="tags">
  467. <li><span class="field">return:</span> Course identifier. Type depends on VLE. (In Moodle, it will be an integer).</li>
  468. </ul>
  469. <div class="method-signature">
  470. <span class="method-result">mixed</span>
  471. <span class="method-name">
  472. get_course_id
  473. </span>
  474. ()
  475. </div>
  476. <hr class="separator" />
  477. <div class="notes">Redefinition of:</div>
  478. <dl>
  479. <dt><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></dt>
  480. <dd>Gets the identifier of the course this controller belongs to.</dd>
  481. </dl>
  482. </div>
  483. <a name="methodget_creation_time" id="get_creation_time"><!-- --></a>
  484. <div class="oddrow">
  485. <div class="method-header">
  486. <img src="../media/images/Method.png" />
  487. <span class="method-title">get_creation_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a361">361</a></span>)
  488. </div>
  489. <!-- ========== Info from phpDoc block ========= -->
  490. <p class="short-description">Gets the time at which this instance was created, or 0 if unknown.</p>
  491. <ul class="tags">
  492. <li><span class="field">return:</span> Timestamp</li>
  493. </ul>
  494. <div class="method-signature">
  495. <span class="method-result">int</span>
  496. <span class="method-name">
  497. get_creation_time
  498. </span>
  499. ()
  500. </div>
  501. <hr class="separator" />
  502. <div class="notes">Redefinition of:</div>
  503. <dl>
  504. <dt><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></dt>
  505. <dd>Gets the time at which this instance was created, or 0 if unknown.</dd>
  506. </dl>
  507. </div>
  508. <a name="methodget_entry_urls" id="get_entry_urls"><!-- --></a>
  509. <div class="evenrow">
  510. <div class="method-header">
  511. <img src="../media/images/Method.png" />
  512. <span class="method-title">get_entry_urls</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a107">107</a></span>)
  513. </div>
  514. <!-- ========== Info from phpDoc block ========= -->
  515. <p class="short-description">Gets an array of absolute URLs to images in this slideshow, all correctly ordered.</p>
  516. <ul class="tags">
  517. <li><span class="field">return:</span> numeric array, each element associates an entry ID to a numeric array of URL string, the name of the source type, and the name of the slide.</li>
  518. </ul>
  519. <div class="method-signature">
  520. <span class="method-result">2d</span>
  521. <span class="method-name">
  522. get_entry_urls
  523. </span>
  524. ()
  525. </div>
  526. </div>
  527. <a name="methodget_frame_height" id="get_frame_height"><!-- --></a>
  528. <div class="oddrow">
  529. <div class="method-header">
  530. <img src="../media/images/Method.png" />
  531. <span class="method-title">get_frame_height</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a323">323</a></span>)
  532. </div>
  533. <!-- ========== Info from phpDoc block ========= -->
  534. <p class="short-description">Gets the height of the Presenter frame (for viewing in Moodle).</p>
  535. <ul class="tags">
  536. <li><span class="field">return:</span> Height of the Presenter frame.</li>
  537. </ul>
  538. <div class="method-signature">
  539. <span class="method-result">int</span>
  540. <span class="method-name">
  541. get_frame_height
  542. </span>
  543. ()
  544. </div>
  545. </div>
  546. <a name="methodget_frame_width" id="get_frame_width"><!-- --></a>
  547. <div class="evenrow">
  548. <div class="method-header">
  549. <img src="../media/images/Method.png" />
  550. <span class="method-title">get_frame_width</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a314">314</a></span>)
  551. </div>
  552. <!-- ========== Info from phpDoc block ========= -->
  553. <p class="short-description">Gets the width of the Presenter frame (for viewing in Moodle).</p>
  554. <ul class="tags">
  555. <li><span class="field">return:</span> Width of the Presenter frame.</li>
  556. </ul>
  557. <div class="method-signature">
  558. <span class="method-result">int</span>
  559. <span class="method-name">
  560. get_frame_width
  561. </span>
  562. ()
  563. </div>
  564. </div>
  565. <a name="methodget_intro" id="get_intro"><!-- --></a>
  566. <div class="oddrow">
  567. <div class="method-header">
  568. <img src="../media/images/Method.png" />
  569. <span class="method-title">get_intro</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a343">343</a></span>)
  570. </div>
  571. <!-- ========== Info from phpDoc block ========= -->
  572. <p class="short-description">Gets the intro description of this module instance, if available.</p>
  573. <ul class="tags">
  574. <li><span class="field">return:</span> The intro description of this controller</li>
  575. </ul>
  576. <div class="method-signature">
  577. <span class="method-result">string</span>
  578. <span class="method-name">
  579. get_intro
  580. </span>
  581. ()
  582. </div>
  583. <hr class="separator" />
  584. <div class="notes">Redefinition of:</div>
  585. <dl>
  586. <dt><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></dt>
  587. <dd>Gets the intro description of this module instance, if available.</dd>
  588. </dl>
  589. </div>
  590. <a name="methodget_modification_time" id="get_modification_time"><!-- --></a>
  591. <div class="evenrow">
  592. <div class="method-header">
  593. <img src="../media/images/Method.png" />
  594. <span class="method-title">get_modification_time</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a370">370</a></span>)
  595. </div>
  596. <!-- ========== Info from phpDoc block ========= -->
  597. <p class="short-description">Gets the time at which this instance was last modified, or 0 if unknown.</p>
  598. <ul class="tags">
  599. <li><span class="field">return:</span> Timestamp</li>
  600. </ul>
  601. <div class="method-signature">
  602. <span class="method-result">int</span>
  603. <span class="method-name">
  604. get_modification_time
  605. </span>
  606. ()
  607. </div>
  608. <hr class="separator" />
  609. <div class="notes">Redefinition of:</div>
  610. <dl>
  611. <dt><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></dt>
  612. <dd>Gets the time at which this instance was last modified, or 0 if unknown.</dd>
  613. </dl>
  614. </div>
  615. <a name="methodget_name" id="get_name"><!-- --></a>
  616. <div class="oddrow">
  617. <div class="method-header">
  618. <img src="../media/images/Method.png" />
  619. <span class="method-title">get_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a334">334</a></span>)
  620. </div>
  621. <!-- ========== Info from phpDoc block ========= -->
  622. <p class="short-description">Gets the name of this module instance.</p>
  623. <ul class="tags">
  624. <li><span class="field">return:</span> The name of this module</li>
  625. </ul>
  626. <div class="method-signature">
  627. <span class="method-result">string</span>
  628. <span class="method-name">
  629. get_name
  630. </span>
  631. ()
  632. </div>
  633. <hr class="separator" />
  634. <div class="notes">Redefinition of:</div>
  635. <dl>
  636. <dt><a href="../sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a></dt>
  637. <dd>Gets the name of this module instance.</dd>
  638. </dl>
  639. </div>
  640. <a name="methodget_slides" id="get_slides"><!-- --></a>
  641. <div class="evenrow">
  642. <div class="method-header">
  643. <img src="../media/images/Method.png" />
  644. <span class="method-title">get_slides</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a127">127</a></span>)
  645. </div>
  646. <!-- ========== Info from phpDoc block ========= -->
  647. <p class="short-description">Gets an ordered associative array of slides in presentation order.</p>
  648. <ul class="tags">
  649. <li><span class="field">return:</span> associating slide IDs to SloodlePresenterSlide objects if successful, or false if not.</li>
  650. </ul>
  651. <div class="method-signature">
  652. <span class="method-result">Array</span>
  653. <span class="method-name">
  654. get_slides
  655. </span>
  656. ()
  657. </div>
  658. </div>
  659. <a name="methodget_type" id="get_type"><!-- --></a>
  660. <div class="oddrow">
  661. <div class="method-header">
  662. <img src="../media/images/Method.png" />
  663. <span class="method-title">get_type</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a380">380</a></span>)
  664. </div>
  665. <!-- ========== Info from phpDoc block ========= -->
  666. <p class="short-description">Gets the short type name of this instance.</p>
  667. <div class="method-signature">
  668. <span class="method-result">string</span>
  669. <span class="method-name">
  670. get_type
  671. </span>
  672. ()
  673. </div>
  674. <hr class="separator" />
  675. <div class="notes">Redefinition of:</div>
  676. <dl>
  677. <dt><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></dt>
  678. <dd>Gets the short type name of this instance.</dd>
  679. </dl>
  680. </div>
  681. <a name="methodget_type_full" id="get_type_full"><!-- --></a>
  682. <div class="evenrow">
  683. <div class="method-header">
  684. <img src="../media/images/Method.png" />
  685. <span class="method-title">get_type_full</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a390">390</a></span>)
  686. </div>
  687. <!-- ========== Info from phpDoc block ========= -->
  688. <p class="short-description">Gets the full type name of this instance, according to the current language pack, if available.</p>
  689. <p class="description"><p>Note: should be overridden by sub-classes.</p></p>
  690. <ul class="tags">
  691. <li><span class="field">return:</span> Full type name if possible, or the short name otherwise.</li>
  692. </ul>
  693. <div class="method-signature">
  694. <span class="method-result">string</span>
  695. <span class="method-name">
  696. get_type_full
  697. </span>
  698. ()
  699. </div>
  700. <hr class="separator" />
  701. <div class="notes">Redefinition of:</div>
  702. <dl>
  703. <dt><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></dt>
  704. <dd>Gets the full type name of this instance, according to the current language pack, if available.</dd>
  705. </dl>
  706. </div>
  707. <a name="methodload" id="load"><!-- --></a>
  708. <div class="oddrow">
  709. <div class="method-header">
  710. <img src="../media/images/Method.png" />
  711. <span class="method-title">load</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a70">70</a></span>)
  712. </div>
  713. <!-- ========== Info from phpDoc block ========= -->
  714. <p class="short-description">Loads data from the database.</p>
  715. <p class="description"><p>Note: even if the function fails, it may still have overwritten some or all existing data in the object.</p></p>
  716. <ul class="tags">
  717. <li><span class="field">return:</span> True if successful, or false otherwise</li>
  718. </ul>
  719. <div class="method-signature">
  720. <span class="method-result">bool</span>
  721. <span class="method-name">
  722. load
  723. </span>
  724. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$id</span>)
  725. </div>
  726. <ul class="parameters">
  727. <li>
  728. <span class="var-type">mixed</span>
  729. <span class="var-name">$id</span><span class="var-description">: The site-wide unique identifier for all modules. Type depends on VLE. On Moodle, it is an integer course module identifier ('id' field of 'course_modules' table)</span> </li>
  730. </ul>
  731. <hr class="separator" />
  732. <div class="notes">Redefinition of:</div>
  733. <dl>
  734. <dt><a href="../sloodle/SloodleModule.html#methodload">SloodleModule::load()</a></dt>
  735. <dd>Loads data from the database.</dd>
  736. </dl>
  737. </div>
  738. <a name="methodmove_entry" id="move_entry"><!-- --></a>
  739. <div class="evenrow">
  740. <div class="method-header">
  741. <img src="../media/images/Method.png" />
  742. <span class="method-title">move_entry</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a247">247</a></span>)
  743. </div>
  744. <!-- ========== Info from phpDoc block ========= -->
  745. <p class="short-description">Moves the ID'd entry forward or back in the presentation ordering.</p>
  746. <p class="description"><p>Only works if the entry is part of this presentation.</p></p>
  747. <div class="method-signature">
  748. <span class="method-result">void</span>
  749. <span class="method-name">
  750. move_entry
  751. </span>
  752. (<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$forward</span>)
  753. </div>
  754. <ul class="parameters">
  755. <li>
  756. <span class="var-type">int</span>
  757. <span class="var-name">$id</span><span class="var-description">: The ID of the entry to move.</span> </li>
  758. <li>
  759. <span class="var-type">bool</span>
  760. <span class="var-name">$forward</span><span class="var-description">: TRUE to move the entry forward (closer to the beginning) or FALSE to push it back (closer to the end)</span> </li>
  761. </ul>
  762. </div>
  763. <a name="methodrelocate_entry" id="relocate_entry"><!-- --></a>
  764. <div class="oddrow">
  765. <div class="method-header">
  766. <img src="../media/images/Method.png" />
  767. <span class="method-title">relocate_entry</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a272">272</a></span>)
  768. </div>
  769. <!-- ========== Info from phpDoc block ========= -->
  770. <p class="short-description">Relocates the identified entry to the specified position in the presentation.</p>
  771. <p class="description"><p>Positions count from 1 upwards. If an entry already exists in that location, then the existing entry is pushed to the next position.</p></p>
  772. <div class="method-signature">
  773. <span class="method-result">void</span>
  774. <span class="method-name">
  775. relocate_entry
  776. </span>
  777. (<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$pos</span>)
  778. </div>
  779. <ul class="parameters">
  780. <li>
  781. <span class="var-type">int</span>
  782. <span class="var-name">$id</span><span class="var-description">: The ID of the entry to relocate</span> </li>
  783. <li>
  784. <span class="var-type">int</span>
  785. <span class="var-name">$pos</span><span class="var-description">: The position in the presentation to move the slide to</span> </li>
  786. </ul>
  787. </div>
  788. <a name="methodvalidate_ordering" id="validate_ordering"><!-- --></a>
  789. <div class="evenrow">
  790. <div class="method-header">
  791. <img src="../media/images/Method.png" />
  792. <span class="method-title">validate_ordering</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__libmodulesmodule_presenter.php.html#a295">295</a></span>)
  793. </div>
  794. <!-- ========== Info from phpDoc block ========= -->
  795. <p class="short-description">Validates the ordering value of all entries in the presenter.</p>
  796. <p class="description"><p>Gives each record an ordering value from 10 upwards, incrementing by 10 each time.</p></p>
  797. <div class="method-signature">
  798. <span class="method-result">void</span>
  799. <span class="method-name">
  800. validate_ordering
  801. </span>
  802. ()
  803. </div>
  804. </div>
  805. <h4>Inherited Methods</h4>
  806. <a name='inherited_methods'><!-- --></a>
  807. <!-- =========== Summary =========== -->
  808. <p>Inherited From <span class="classname"><a href="../sloodle/SloodleModule.html">SloodleModule</a></span></p>
  809. <blockquote>
  810. <img src="../media/images/Constructor.png" alt=" "/>
  811. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodSloodleModule">SloodleModule::SloodleModule()</a></span><br>
  812. <img src="../media/images/Method.png" alt=" "/>
  813. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_course_id">SloodleModule::get_course_id()</a></span><br>
  814. <img src="../media/images/Method.png" alt=" "/>
  815. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_creation_time">SloodleModule::get_creation_time()</a></span><br>
  816. <img src="../media/images/Method.png" alt=" "/>
  817. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_intro">SloodleModule::get_intro()</a></span><br>
  818. <img src="../media/images/Method.png" alt=" "/>
  819. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_modification_time">SloodleModule::get_modification_time()</a></span><br>
  820. <img src="../media/images/Method.png" alt=" "/>
  821. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_name">SloodleModule::get_name()</a></span><br>
  822. <img src="../media/images/Method.png" alt=" "/>
  823. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type">SloodleModule::get_type()</a></span><br>
  824. <img src="../media/images/Method.png" alt=" "/>
  825. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodget_type_full">SloodleModule::get_type_full()</a></span><br>
  826. <img src="../media/images/Method.png" alt=" "/>
  827. <span class="method-name"><a href="../sloodle/SloodleModule.html#methodload">SloodleModule::load()</a></span><br>
  828. </blockquote>
  829. </div>
  830. </div>
  831. <p class="notes" id="credit">
  832. Documentation generated on Fri, 17 Jul 2009 11:02:05 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  833. </p>
  834. </div></body>
  835. </html>