Source for file image.php

Documentation is available at image.php

  1. <?php
  2. // This file is part of the Sloodle project (www.sloodle.org) and is released under the GNU GPL v3.
  3.  
  4. /**
  5. * Defines the SLOODLE Presenter plugin for showing image slides.
  6. *
  7. * @package sloodle
  8. * @copyright Copyright (c) 2009 Sloodle (various contributors)
  9. * @license http://www.gnu.org/licenses/gpl-3.0.html GNU GPL v3
  10. * @since Sloodle 0.4.1
  11. *
  12. * @contributor Peter R. Bloomfield
  13. *
  14. */
  15.  
  16.  
  17. /**
  18. * Presenter plugin for showing image slides.
  19. *
  20. * @package sloodle
  21. */
  22. class SloodlePluginPresenterSlideImage extends SloodlePluginBasePresenterSlide
  23. {
  24.  
  25.     /**
  26.     * Construct an absolute URL, based on the given source data.
  27.     * Leaves existing absolute URLs alone, but converts relative URLs as necessary.
  28.     * (This allows the site to be moved without disrupting these slides.)
  29.     * @param string $source The source data from the slide.
  30.     * @return string An absolute URL.
  31.     */
  32.     function get_absolute_url($source)
  33.     {
  34.         global $CFG;
  35.         // If we have a protocol specifier, then assume this is already an absolute URL
  36.         if (strpos($source, '://') !== false) return $source;
  37.         // Assume the source URL is relative to the Moodle WWW root.
  38.         // Make sure we don't duplicate a forward slash.
  39.         if (strpos($source, '/') === 0) return $CFG->wwwroot.$source;
  40.         return $CFG->wwwroot.'/'.$source;
  41.     }
  42.  
  43.     /**
  44.     * Render the given slide for browser output -- NOTE: render to a string, and return the string.
  45.     * The title of the slide need not be included -- simply the basic iFrame or embedded player etc.
  46.     * @param SloodlePresenterSlide $slide An object containing the raw slide data.
  47.     * @return string 
  48.     */
  49.     function render_slide_for_browser($slide)
  50.     {
  51.         $url = $this->get_absolute_url($slide->source);
  52.         $output = "<img src=\"{$url}\" alt=\"{$slide->name}\" />";
  53.         return $output;
  54.     }
  55.  
  56.     /**
  57.     * Render the given slide for virtual-world output.
  58.     * This returns two items of data in a numeric array.
  59.     * The first is the virtual world compatible type identifier: web, image, video, or audio (or a mime type).
  60.     * The second is the absolute URL to give it.
  61.     * @param SloodlePresenterSlide $slide An object containing the raw slide data.
  62.     * @return array Numeric array containg (type, url)
  63.     */
  64.     function render_slide_for_sl($slide)
  65.     {
  66.         return array('image/*', $this->get_absolute_url($slide->source));
  67.     }
  68.  
  69.     /**
  70.     * Gets the human-readable name of this plugin.
  71.     * This MUST be overridden by base classes. If not, it will just return the name of the class.
  72.     * @param string $lang 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.
  73.     * @access public
  74.     * @return string The human-readable name of this plugin
  75.     */
  76.     function get_plugin_name($lang = null)
  77.     {
  78.         return 'Image';
  79.     }
  80.  
  81.     /**
  82.     * Gets the internal version number of this plugin.
  83.     * This MUST be overridden.
  84.     * This should be a number like the internal version number for Moodle modules, containing the date and release number.
  85.     * Format is: YYYYMMDD##.
  86.     * For example, "2009012302" would be the 3rd release on the 23rd January 2009.
  87.     * @return int The version number of this module.
  88.     */
  89.     function get_version()
  90.     {
  91.         return 2009050600;
  92.     }
  93.  
  94.  
  95. }
  96.  
  97.  
  98. ?>

Documentation generated on Fri, 17 Jul 2009 11:01:22 +0100 by phpDocumentor 1.4.0