Source for file _base.php

Documentation is available at _base.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 base classes for SLOODLE Presenter plugins.
  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. * Base class for plugins which provide slide types for the SLOODLE Presenter.
  19. * Sub-classes should override the essential functions, in addition to those in the SloodlePluginBase class.
  20. * The purpose of the plugin is to render slides for output to a browser or to SL.
  21. *
  22. * @package sloodle
  23. */
  24. class SloodlePluginBasePresenterSlide extends SloodlePluginBase
  25. {
  26.  
  27.     // DATA //
  28.  
  29.  
  30.     // OVERRIDABLE FUNCTIONS //
  31.     // These are functions which can be overridden by sub-classes.
  32.  
  33.     /**
  34.     * Render the given slide for browser output -- NOTE: render to a string, and return the string.
  35.     * The title of the slide need not be included -- simply the basic iFrame or embedded player etc.
  36.     * @param SloodlePresenterSlide $slide An object containing the raw slide data.
  37.     * @return string 
  38.     */
  39.     function render_slide_for_browser($slide)
  40.     {
  41.         // In case this function isn't overridden, just output a basic link.
  42.         $output = "<a href=\"{$slide->source}\" title=\"\">".get_string('directlink', 'sloodle')."</a>";
  43.         return $output;
  44.     }
  45.  
  46.     /**
  47.     * Render the given slide for virtual-world output.
  48.     * This returns two items of data in a numeric array.
  49.     * The first is the virtual world compatible type identifier: web, image, video, or audio (or a mime type).
  50.     * The second is the absolute URL to give it.
  51.     * @param SloodlePresenterSlide $slide An object containing the raw slide data.
  52.     * @return array Numeric array containg (type, url)
  53.     */
  54.     function render_slide_for_sl($slide)
  55.     {
  56.         // In case this function isn't overridden, just output a basic web URL
  57.         return array('web', $slide->source);
  58.     }
  59.  
  60. }
  61.  
  62.  
  63. /**
  64. * Base class for plugins which provide slide importers for the SLOODLE Presenter.
  65. * Sub-classes should override the essential functions, in addition to those in the SloodlePluginBase class.
  66. * The purpose of the plugin is to take a specified file (locally), process it, and add slides to the Presentation at the given point.
  67. */
  68. class SloodlePluginBasePresenterImporter extends SloodlePluginBase
  69. {
  70.     // DATA //
  71.  
  72.  
  73.     // OVERRIDABLE FUNCTIONS //
  74.     // These are functions which can be overridden by sub-classes.
  75.  
  76.     /**
  77.     * Import the given file, and insert the new slides at the specified position in the Presentation.
  78.     * The best approach to inserting slides is to insert the first one at the specified position,
  79.     *  and then increment the position on each insertion.
  80.     * Inserting at the same point repeatedly will cause the slides to appear in reverse order! :-)
  81.     * @param string $file The path of the file to import.
  82.     * @param int $position Position at which the first new slide should be imported. (If negative, then insert at end)
  83.     * @return bool True if successful, or false otherwise.
  84.     */
  85.     function import($file, $position = -1)
  86.     {
  87.         return false;
  88.     }
  89. }
  90.  
  91.  
  92. ?>

Documentation generated on Fri, 17 Jul 2009 11:02:49 +0100 by phpDocumentor 1.4.0