SloodlePluginPresenterSlideImage.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383
  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 SloodlePluginPresenterSlideImage</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"> SloodlePluginPresenterSlideImage</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  94. </div>
  95. <div class="info-box-body">
  96. <!-- ========== Info from phpDoc block ========= -->
  97. <p class="short-description">Presenter plugin for showing image slides.</p>
  98. <p class="notes">
  99. Located in <a class="field" href="_plugin---presenter---image.php.html">/plugin/presenter/image.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__pluginpresenterimage.php.html#a22">22</a></span>)
  100. </p>
  101. <pre><a href="../sloodle/SloodlePluginBase.html">SloodlePluginBase</a>
  102. |
  103. --<a href="../sloodle/SloodlePluginBasePresenterSlide.html">SloodlePluginBasePresenterSlide</a>
  104. |
  105. --SloodlePluginPresenterSlideImage</pre>
  106. </div>
  107. </div>
  108. <a name="sec-method-summary"></a>
  109. <div class="info-box">
  110. <div class="info-box-title">Method Summary</span></div>
  111. <div class="nav-bar">
  112. <a href="#sec-description">Description</a> |
  113. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  114. </div>
  115. <div class="info-box-body">
  116. <div class="method-summary">
  117. <div class="method-definition">
  118. <img src="../media/images/Method.png" alt=" "/>
  119. <span class="method-result">string</span>
  120. <a href="#get_absolute_url" title="details" class="method-name">get_absolute_url</a>
  121. (<span class="var-type">string</span>&nbsp;<span class="var-name">$source</span>)
  122. </div>
  123. <div class="method-definition">
  124. <img src="../media/images/Method.png" alt=" "/>
  125. <span class="method-result">string</span>
  126. <a href="#get_plugin_name" title="details" class="method-name">get_plugin_name</a>
  127. ([<span class="var-type">string</span>&nbsp;<span class="var-name">$lang</span> = <span class="var-default">null</span>])
  128. </div>
  129. <div class="method-definition">
  130. <img src="../media/images/Method.png" alt=" "/>
  131. <span class="method-result">int</span>
  132. <a href="#get_version" title="details" class="method-name">get_version</a>
  133. ()
  134. </div>
  135. <div class="method-definition">
  136. <img src="../media/images/Method.png" alt=" "/>
  137. <span class="method-result">string</span>
  138. <a href="#render_slide_for_browser" title="details" class="method-name">render_slide_for_browser</a>
  139. (<span class="var-type"><a href="../sloodle/SloodlePresenterSlide.html">SloodlePresenterSlide</a></span>&nbsp;<span class="var-name">$slide</span>)
  140. </div>
  141. <div class="method-definition">
  142. <img src="../media/images/Method.png" alt=" "/>
  143. <span class="method-result">array</span>
  144. <a href="#render_slide_for_sl" title="details" class="method-name">render_slide_for_sl</a>
  145. (<span class="var-type"><a href="../sloodle/SloodlePresenterSlide.html">SloodlePresenterSlide</a></span>&nbsp;<span class="var-name">$slide</span>)
  146. </div>
  147. </div>
  148. </div>
  149. </div>
  150. <a name="sec-methods"></a>
  151. <div class="info-box">
  152. <div class="info-box-title">Methods</div>
  153. <div class="nav-bar">
  154. <a href="#sec-description">Description</a> |
  155. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  156. </div>
  157. <div class="info-box-body">
  158. <A NAME='method_detail'></A>
  159. <a name="methodget_absolute_url" id="get_absolute_url"><!-- --></a>
  160. <div class="evenrow">
  161. <div class="method-header">
  162. <img src="../media/images/Method.png" />
  163. <span class="method-title">get_absolute_url</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterimage.php.html#a32">32</a></span>)
  164. </div>
  165. <!-- ========== Info from phpDoc block ========= -->
  166. <p class="short-description">Construct an absolute URL, based on the given source data.</p>
  167. <p class="description"><p>Leaves existing absolute URLs alone, but converts relative URLs as necessary. (This allows the site to be moved without disrupting these slides.)</p></p>
  168. <ul class="tags">
  169. <li><span class="field">return:</span> An absolute URL.</li>
  170. </ul>
  171. <div class="method-signature">
  172. <span class="method-result">string</span>
  173. <span class="method-name">
  174. get_absolute_url
  175. </span>
  176. (<span class="var-type">string</span>&nbsp;<span class="var-name">$source</span>)
  177. </div>
  178. <ul class="parameters">
  179. <li>
  180. <span class="var-type">string</span>
  181. <span class="var-name">$source</span><span class="var-description">: The source data from the slide.</span> </li>
  182. </ul>
  183. </div>
  184. <a name="methodget_plugin_name" id="get_plugin_name"><!-- --></a>
  185. <div class="oddrow">
  186. <div class="method-header">
  187. <img src="../media/images/Method.png" />
  188. <span class="method-title">get_plugin_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterimage.php.html#a76">76</a></span>)
  189. </div>
  190. <!-- ========== Info from phpDoc block ========= -->
  191. <p class="short-description">Gets the human-readable name of this plugin.</p>
  192. <p class="description"><p>This MUST be overridden by base classes. If not, it will just return the name of the class.</p></p>
  193. <ul class="tags">
  194. <li><span class="field">return:</span> The human-readable name of this plugin</li>
  195. <li><span class="field">access:</span> public</li>
  196. </ul>
  197. <div class="method-signature">
  198. <span class="method-result">string</span>
  199. <span class="method-name">
  200. get_plugin_name
  201. </span>
  202. ([<span class="var-type">string</span>&nbsp;<span class="var-name">$lang</span> = <span class="var-default">null</span>])
  203. </div>
  204. <ul class="parameters">
  205. <li>
  206. <span class="var-type">string</span>
  207. <span class="var-name">$lang</span><span class="var-description">: Optional -- can specify the language we want the plugin name in, as an identifier like &quot;en_utf8&quot;. If unspecified, then the current Moodle language should be used.</span> </li>
  208. </ul>
  209. <hr class="separator" />
  210. <div class="notes">Redefinition of:</div>
  211. <dl>
  212. <dt><a href="../sloodle/SloodlePluginBase.html#methodget_plugin_name">SloodlePluginBase::get_plugin_name()</a></dt>
  213. <dd>Gets the human-readable name of this plugin.</dd>
  214. </dl>
  215. </div>
  216. <a name="methodget_version" id="get_version"><!-- --></a>
  217. <div class="evenrow">
  218. <div class="method-header">
  219. <img src="../media/images/Method.png" />
  220. <span class="method-title">get_version</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterimage.php.html#a89">89</a></span>)
  221. </div>
  222. <!-- ========== Info from phpDoc block ========= -->
  223. <p class="short-description">Gets the internal version number of this plugin.</p>
  224. <p class="description"><p>This MUST be overridden. This should be a number like the internal version number for Moodle modules, containing the date and release number. Format is: YYYYMMDD##. For example, &quot;2009012302&quot; would be the 3rd release on the 23rd January 2009.</p></p>
  225. <ul class="tags">
  226. <li><span class="field">return:</span> The version number of this module.</li>
  227. </ul>
  228. <div class="method-signature">
  229. <span class="method-result">int</span>
  230. <span class="method-name">
  231. get_version
  232. </span>
  233. ()
  234. </div>
  235. <hr class="separator" />
  236. <div class="notes">Redefinition of:</div>
  237. <dl>
  238. <dt><a href="../sloodle/SloodlePluginBase.html#methodget_version">SloodlePluginBase::get_version()</a></dt>
  239. <dd>Gets the internal version number of this plugin.</dd>
  240. </dl>
  241. </div>
  242. <a name="methodrender_slide_for_browser" id="render_slide_for_browser"><!-- --></a>
  243. <div class="oddrow">
  244. <div class="method-header">
  245. <img src="../media/images/Method.png" />
  246. <span class="method-title">render_slide_for_browser</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterimage.php.html#a49">49</a></span>)
  247. </div>
  248. <!-- ========== Info from phpDoc block ========= -->
  249. <p class="short-description">Render the given slide for browser output -- NOTE: render to a string, and return the string.</p>
  250. <p class="description"><p>The title of the slide need not be included -- simply the basic iFrame or embedded player etc.</p></p>
  251. <div class="method-signature">
  252. <span class="method-result">string</span>
  253. <span class="method-name">
  254. render_slide_for_browser
  255. </span>
  256. (<span class="var-type"><a href="../sloodle/SloodlePresenterSlide.html">SloodlePresenterSlide</a></span>&nbsp;<span class="var-name">$slide</span>)
  257. </div>
  258. <ul class="parameters">
  259. <li>
  260. <span class="var-type"><a href="../sloodle/SloodlePresenterSlide.html">SloodlePresenterSlide</a></span>
  261. <span class="var-name">$slide</span><span class="var-description">: An object containing the raw slide data.</span> </li>
  262. </ul>
  263. <hr class="separator" />
  264. <div class="notes">Redefinition of:</div>
  265. <dl>
  266. <dt><a href="../sloodle/SloodlePluginBasePresenterSlide.html#methodrender_slide_for_browser">SloodlePluginBasePresenterSlide::render_slide_for_browser()</a></dt>
  267. <dd>Render the given slide for browser output -- NOTE: render to a string, and return the string.</dd>
  268. </dl>
  269. </div>
  270. <a name="methodrender_slide_for_sl" id="render_slide_for_sl"><!-- --></a>
  271. <div class="evenrow">
  272. <div class="method-header">
  273. <img src="../media/images/Method.png" />
  274. <span class="method-title">render_slide_for_sl</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterimage.php.html#a64">64</a></span>)
  275. </div>
  276. <!-- ========== Info from phpDoc block ========= -->
  277. <p class="short-description">Render the given slide for virtual-world output.</p>
  278. <p class="description"><p>This returns two items of data in a numeric array. The first is the virtual world compatible type identifier: web, image, video, or audio (or a mime type). The second is the absolute URL to give it.</p></p>
  279. <ul class="tags">
  280. <li><span class="field">return:</span> Numeric array containg (type, url)</li>
  281. </ul>
  282. <div class="method-signature">
  283. <span class="method-result">array</span>
  284. <span class="method-name">
  285. render_slide_for_sl
  286. </span>
  287. (<span class="var-type"><a href="../sloodle/SloodlePresenterSlide.html">SloodlePresenterSlide</a></span>&nbsp;<span class="var-name">$slide</span>)
  288. </div>
  289. <ul class="parameters">
  290. <li>
  291. <span class="var-type"><a href="../sloodle/SloodlePresenterSlide.html">SloodlePresenterSlide</a></span>
  292. <span class="var-name">$slide</span><span class="var-description">: An object containing the raw slide data.</span> </li>
  293. </ul>
  294. <hr class="separator" />
  295. <div class="notes">Redefinition of:</div>
  296. <dl>
  297. <dt><a href="../sloodle/SloodlePluginBasePresenterSlide.html#methodrender_slide_for_sl">SloodlePluginBasePresenterSlide::render_slide_for_sl()</a></dt>
  298. <dd>Render the given slide for virtual-world output.</dd>
  299. </dl>
  300. </div>
  301. <h4>Inherited Methods</h4>
  302. <a name='inherited_methods'><!-- --></a>
  303. <!-- =========== Summary =========== -->
  304. <p>Inherited From <span class="classname"><a href="../sloodle/SloodlePluginBasePresenterSlide.html">SloodlePluginBasePresenterSlide</a></span></p>
  305. <blockquote>
  306. <img src="../media/images/Method.png" alt=" "/>
  307. <span class="method-name"><a href="../sloodle/SloodlePluginBasePresenterSlide.html#methodrender_slide_for_browser">SloodlePluginBasePresenterSlide::render_slide_for_browser()</a></span><br>
  308. <img src="../media/images/Method.png" alt=" "/>
  309. <span class="method-name"><a href="../sloodle/SloodlePluginBasePresenterSlide.html#methodrender_slide_for_sl">SloodlePluginBasePresenterSlide::render_slide_for_sl()</a></span><br>
  310. </blockquote>
  311. <!-- =========== Summary =========== -->
  312. <p>Inherited From <span class="classname"><a href="../sloodle/SloodlePluginBase.html">SloodlePluginBase</a></span></p>
  313. <blockquote>
  314. <img src="../media/images/Method.png" alt=" "/>
  315. <span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_id">SloodlePluginBase::get_id()</a></span><br>
  316. <img src="../media/images/Method.png" alt=" "/>
  317. <span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_plugin_description">SloodlePluginBase::get_plugin_description()</a></span><br>
  318. <img src="../media/images/Method.png" alt=" "/>
  319. <span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_plugin_name">SloodlePluginBase::get_plugin_name()</a></span><br>
  320. <img src="../media/images/Method.png" alt=" "/>
  321. <span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_version">SloodlePluginBase::get_version()</a></span><br>
  322. </blockquote>
  323. </div>
  324. </div>
  325. <p class="notes" id="credit">
  326. Documentation generated on Fri, 17 Jul 2009 11:01:22 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  327. </p>
  328. </div></body>
  329. </html>