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 the base class for all SLOODLE 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.  
  19. /**
  20. * Base class for all SLOODLE plugins.
  21. * All SLOODLE plugins should be derived from this (directly or indirectly).
  22. * Specific plugin types will likely have their own base classes, which should be sub-classes of this.
  23. * For example, the Presenter has plugin base classes for "slide" and "import" plugins.
  24. * New plugins should be derived directly from those.
  25. *
  26. * Plugin classes should have names starting with "SloodlePlugin".
  27. * Make sure your class name does not conflict with any existing plugin classes, even if it is a different type of plugin.
  28. * Instantiating a plugin class should require no parameters, and should perform minimal processing. This is to allow the plugin loader to be as efficient as possible.
  29. *
  30. * @package sloodle
  31. */
  32. class SloodlePluginBase
  33. {
  34.  
  35.     // DATA //
  36.  
  37.  
  38.     // OVERRIDABLE FUNCTIONS //
  39.     // These are functions which can be overridden by sub-classes.
  40.  
  41.     /**
  42.     * Gets the human-readable name of this plugin.
  43.     * This MUST be overridden by base classes. If not, it will just return the name of the class.
  44.     * @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.
  45.     * @access public
  46.     * @return string The human-readable name of this plugin
  47.     */
  48.     function get_plugin_name($lang = null)
  49.     {
  50.         return get_class($this);
  51.     }
  52.  
  53.     /**
  54.     * Gets the human-readable description of this plugin.
  55.     * This should be overridden by base classes. If not, it will just return an empty string.
  56.     * @param string $lang Optional -- can specify the language we want the description in, as an identifier like "en_utf8". If unspecified, then the current Moodle language should be used.
  57.     * @access public
  58.     * @return string The human-readable description of this plugin
  59.     */
  60.     function get_plugin_description($lang = null)
  61.     {
  62.         return '';
  63.     }
  64.  
  65.     /**
  66.     * Gets the identifier of this plugin.
  67.     * This can be overridden, but should usually not be.
  68.     * This ID is just the name of the class
  69.     */
  70.     function get_id()
  71.     {
  72.         $className = get_class($this);
  73.         if (strpos($className, 'SloodlePlugin') === 0) return substr($className, 13);
  74.         return $className;
  75.     }
  76.  
  77.     /**
  78.     * Gets the internal version number of this plugin.
  79.     * This MUST be overridden.
  80.     * This should be a number like the internal version number for Moodle modules, containing the date and release number.
  81.     * Format is: YYYYMMDD##.
  82.     * For example, "2009012302" would be the 3rd release on the 23rd January 2009.
  83.     * @return int The version number of this module.
  84.     */
  85.     function get_version()
  86.     {
  87.         return 0;
  88.     }
  89.  
  90. }
  91.  
  92.  
  93. ?>

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