| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124 |
- <?xml version="1.0" encoding="iso-8859-1"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <!-- template designed by Marco Von Ballmoos -->
- <title>File Source for web.php</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- </head>
- <body>
-
<h1>Source for file web.php</h1>
- <p>Documentation is available at <a href="../sloodle/_plugin---presenter---web.php.html">web.php</a></p>
- <div class="src-code">
- <div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
- <li><div class="src-line"><a name="a2"></a><span class="src-comm">// This file is part of the Sloodle project (www.sloodle.org) and is released under the GNU GPL v3.</span></div></li>
- <li><div class="src-line"><a name="a3"></a> </div></li>
- <li><div class="src-line"><a name="a4"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a5"></a><span class="src-doc">* Defines the SLOODLE Presenter plugin for showing web slides.</span></div></li>
- <li><div class="src-line"><a name="a6"></a><span class="src-doc">*</span></div></li>
- <li><div class="src-line"><a name="a7"></a><span class="src-doc">* </span><span class="src-doc-coretag">@package</span><span class="src-doc"> sloodle</span></div></li>
- <li><div class="src-line"><a name="a8"></a><span class="src-doc">* </span><span class="src-doc-coretag">@copyright</span><span class="src-doc"> Copyright (c) 2009 Sloodle (various contributors)</span></div></li>
- <li><div class="src-line"><a name="a9"></a><span class="src-doc">* </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3</span></div></li>
- <li><div class="src-line"><a name="a10"></a><span class="src-doc">* </span><span class="src-doc-coretag">@since</span><span class="src-doc"> Sloodle 0.4.1</span></div></li>
- <li><div class="src-line"><a name="a11"></a><span class="src-doc">*</span></div></li>
- <li><div class="src-line"><a name="a12"></a><span class="src-doc">* </span><span class="src-doc-tag">@contributor</span><span class="src-doc"> Peter R. Bloomfield</span></div></li>
- <li><div class="src-line"><a name="a13"></a><span class="src-doc">*</span></div></li>
- <li><div class="src-line"><a name="a14"></a><span class="src-doc">*/</span></div></li>
- <li><div class="src-line"><a name="a15"></a> </div></li>
- <li><div class="src-line"><a name="a16"></a> </div></li>
- <li><div class="src-line"><a name="a17"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a18"></a><span class="src-doc">* Presenter plugin for showing web slides.</span></div></li>
- <li><div class="src-line"><a name="a19"></a><span class="src-doc">*</span></div></li>
- <li><div class="src-line"><a name="a20"></a><span class="src-doc">* </span><span class="src-doc-coretag">@package</span><span class="src-doc"> sloodle</span></div></li>
- <li><div class="src-line"><a name="a21"></a><span class="src-doc">*/</span></div></li>
- <li><div class="src-line"><a name="a22"></a><span class="src-key">class </span><a href="../sloodle/SloodlePluginPresenterSlideWeb.html">SloodlePluginPresenterSlideWeb</a> <span class="src-key">extends </span><a href="../sloodle/SloodlePluginBasePresenterSlide.html">SloodlePluginBasePresenterSlide</a></div></li>
- <li><div class="src-line"><a name="a23"></a><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a24"></a> </div></li>
- <li><div class="src-line"><a name="a25"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a26"></a><span class="src-doc"> * Construct an absolute URL, based on the given source data.</span></div></li>
- <li><div class="src-line"><a name="a27"></a><span class="src-doc"> * Leaves existing absolute URLs alone, but converts relative URLs as necessary.</span></div></li>
- <li><div class="src-line"><a name="a28"></a><span class="src-doc"> * (This allows the site to be moved without disrupting these slides.)</span></div></li>
- <li><div class="src-line"><a name="a29"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$source </span><span class="src-doc">The source data from the slide.</span></div></li>
- <li><div class="src-line"><a name="a30"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc">An absolute URL.</span></div></li>
- <li><div class="src-line"><a name="a31"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a32"></a> <span class="src-key">function </span><a href="../sloodle/SloodlePluginPresenterSlideWeb.html#methodget_absolute_url">get_absolute_url</a><span class="src-sym">(</span><span class="src-var">$source</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a33"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a34"></a> <span class="src-key">global </span><span class="src-var">$CFG</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a35"></a> <span class="src-comm">// If we have a protocol specifier, then assume this is already an absolute URL</span></div></li>
- <li><div class="src-line"><a name="a36"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/strpos">strpos</a><span class="src-sym">(</span><span class="src-var">$source</span><span class="src-sym">, </span><span class="src-str">'://'</span><span class="src-sym">) </span>!== <span class="src-id">false</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-var">$source</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a37"></a> <span class="src-comm">// Assume the source URL is relative to the Moodle WWW root.</span></div></li>
- <li><div class="src-line"><a name="a38"></a> <span class="src-comm">// Make sure we don't duplicate a forward slash.</span></div></li>
- <li><div class="src-line"><a name="a39"></a> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/strpos">strpos</a><span class="src-sym">(</span><span class="src-var">$source</span><span class="src-sym">, </span><span class="src-str">'/'</span><span class="src-sym">) </span>=== <span class="src-num">0</span><span class="src-sym">) </span><span class="src-key">return </span><span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">wwwroot</span>.<span class="src-var">$source</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a40"></a> <span class="src-key">return </span><span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">wwwroot</span>.<span class="src-str">'/'</span>.<span class="src-var">$source</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a41"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a42"></a> </div></li>
- <li><div class="src-line"><a name="a43"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a44"></a><span class="src-doc"> * Render the given slide for browser output -- NOTE: render to a string, and return the string.</span></div></li>
- <li><div class="src-line"><a name="a45"></a><span class="src-doc"> * The title of the slide need not be included -- simply the basic iFrame or embedded player etc.</span></div></li>
- <li><div class="src-line"><a name="a46"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">SloodlePresenterSlide </span><span class="src-doc-var">$slide </span><span class="src-doc">An object containing the raw slide data.</span></div></li>
- <li><div class="src-line"><a name="a47"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span></div></li>
- <li><div class="src-line"><a name="a48"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a49"></a> <span class="src-key">function </span><a href="../sloodle/SloodlePluginPresenterSlideWeb.html#methodrender_slide_for_browser">render_slide_for_browser</a><span class="src-sym">(</span><span class="src-var">$slide</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a50"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a51"></a> <span class="src-var">$url </span>= <span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodlePluginPresenterSlideWeb.html#methodget_absolute_url">get_absolute_url</a><span class="src-sym">(</span><span class="src-var">$slide</span><span class="src-sym">-></span><span class="src-id">source</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a52"></a> <span class="src-var">$framewidth </span>= <span class="src-num">500</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a53"></a> <span class="src-var">$frameheight </span>= <span class="src-num">500</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a54"></a> <span class="src-key">if </span><span class="src-sym">(</span>isset<span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">presenter</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a55"></a> <span class="src-var">$framewidth </span>= <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">presenter</span><span class="src-sym">-></span><span class="src-id">get_frame_width</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a56"></a> <span class="src-var">$frameheight </span>= <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">presenter</span><span class="src-sym">-></span><span class="src-id">get_frame_height</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a57"></a> <span class="src-sym">} </span></div></li>
- <li><div class="src-line"><a name="a58"></a> </div></li>
- <li><div class="src-line"><a name="a59"></a> <span class="src-var">$output </span>= <span class="src-str">"</span><span class="src-str"><iframe src=\"{<span class="src-var">$url</span><span class="src-sym">}</span>\" style=\"width:{<span class="src-var">$framewidth</span><span class="src-sym">}</span>px; height:{<span class="src-var">$frameheight</span><span class="src-sym">}</span>px;\"></iframe></span><span class="src-str">"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a60"></a> <span class="src-key">return </span><span class="src-var">$output</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a61"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a62"></a> </div></li>
- <li><div class="src-line"><a name="a63"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a64"></a><span class="src-doc"> * Render the given slide for virtual-world output.</span></div></li>
- <li><div class="src-line"><a name="a65"></a><span class="src-doc"> * This returns two items of data in a numeric array.</span></div></li>
- <li><div class="src-line"><a name="a66"></a><span class="src-doc"> * The first is the virtual world compatible type identifier: web, image, video, or audio (or a mime type).</span></div></li>
- <li><div class="src-line"><a name="a67"></a><span class="src-doc"> * The second is the absolute URL to give it.</span></div></li>
- <li><div class="src-line"><a name="a68"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">SloodlePresenterSlide </span><span class="src-doc-var">$slide </span><span class="src-doc">An object containing the raw slide data.</span></div></li>
- <li><div class="src-line"><a name="a69"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span><span class="src-doc">Numeric array containg (type, url)</span></div></li>
- <li><div class="src-line"><a name="a70"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a71"></a> <span class="src-key">function </span><a href="../sloodle/SloodlePluginPresenterSlideWeb.html#methodrender_slide_for_sl">render_slide_for_sl</a><span class="src-sym">(</span><span class="src-var">$slide</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a72"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a73"></a> <span class="src-key">return </span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'text/html'</span><span class="src-sym">, </span><span class="src-var">$this</span><span class="src-sym">-></span><a href="../sloodle/SloodlePluginPresenterSlideWeb.html#methodget_absolute_url">get_absolute_url</a><span class="src-sym">(</span><span class="src-var">$slide</span><span class="src-sym">-></span><span class="src-id">source</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a74"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a75"></a> </div></li>
- <li><div class="src-line"><a name="a76"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a77"></a><span class="src-doc"> * Gets the human-readable name of this plugin.</span></div></li>
- <li><div class="src-line"><a name="a78"></a><span class="src-doc"> * This MUST be overridden by base classes. If not, it will just return the name of the class.</span></div></li>
- <li><div class="src-line"><a name="a79"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$lang </span><span class="src-doc">Optional -- can specify the language we want the plugin name in, as an identifier like "en_utf8". If unspecified, then the current Moodle language should be used.</span></div></li>
- <li><div class="src-line"><a name="a80"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@access</span><span class="src-doc"> public</span></div></li>
- <li><div class="src-line"><a name="a81"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc">The human-readable name of this plugin</span></div></li>
- <li><div class="src-line"><a name="a82"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a83"></a> <span class="src-key">function </span><a href="../sloodle/SloodlePluginPresenterSlideWeb.html#methodget_plugin_name">get_plugin_name</a><span class="src-sym">(</span><span class="src-var">$lang </span>= <span class="src-id">null</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a84"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a85"></a> <span class="src-key">return </span><span class="src-str">'Web'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a86"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a87"></a> </div></li>
- <li><div class="src-line"><a name="a88"></a> <span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a89"></a><span class="src-doc"> * Gets the internal version number of this plugin.</span></div></li>
- <li><div class="src-line"><a name="a90"></a><span class="src-doc"> * This MUST be overridden.</span></div></li>
- <li><div class="src-line"><a name="a91"></a><span class="src-doc"> * This should be a number like the internal version number for Moodle modules, containing the date and release number.</span></div></li>
- <li><div class="src-line"><a name="a92"></a><span class="src-doc"> * Format is: YYYYMMDD##.</span></div></li>
- <li><div class="src-line"><a name="a93"></a><span class="src-doc"> * For example, "2009012302" would be the 3rd release on the 23rd January 2009.</span></div></li>
- <li><div class="src-line"><a name="a94"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">int </span><span class="src-doc">The version number of this module.</span></div></li>
- <li><div class="src-line"><a name="a95"></a><span class="src-doc"> */</span></div></li>
- <li><div class="src-line"><a name="a96"></a> <span class="src-key">function </span><a href="../sloodle/SloodlePluginPresenterSlideWeb.html#methodget_version">get_version</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a97"></a> <span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a98"></a> <span class="src-key">return </span><span class="src-num">2009050600</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a99"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a100"></a> </div></li>
- <li><div class="src-line"><a name="a101"></a> </div></li>
- <li><div class="src-line"><a name="a102"></a><span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a103"></a> </div></li>
- <li><div class="src-line"><a name="a104"></a> </div></li>
- <li><div class="src-line"><a name="a105"></a><span class="src-php">?></span></div></li>
- </ol></div>
- </div>
- <p class="notes" id="credit">
- Documentation generated on Fri, 17 Jul 2009 11:02:49 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
- </p>
- </body>
- </html>
|