Docs For Class SloodlePluginBase

Description

Base class for all SLOODLE plugins.

All SLOODLE plugins should be derived from this (directly or indirectly). Specific plugin types will likely have their own base classes, which should be sub-classes of this. For example, the Presenter has plugin base classes for "slide" and "import" plugins. New plugins should be derived directly from those.

Plugin classes should have names starting with "SloodlePlugin". Make sure your class name does not conflict with any existing plugin classes, even if it is a different type of plugin. 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.

Located in /plugin/_base.php (line 32)

Direct descendents

Class	Description
SloodlePluginBasePresenterSlide	Base class for plugins which provide slide types for the SLOODLE Presenter.
SloodlePluginBasePresenterImporter	Base class for plugins which provide slide importers for the SLOODLE Presenter.

Method Summary

void get_id ()

string get_plugin_description ([string $lang = null])

string get_plugin_name ([string $lang = null])

int get_version ()

Methods

get_id (line 70)

Gets the identifier of this plugin.

This can be overridden, but should usually not be. This ID is just the name of the class

void get_id ()

get_plugin_description (line 60)

Gets the human-readable description of this plugin.

This should be overridden by base classes. If not, it will just return an empty string.

return: The human-readable description of this plugin
access: public

string get_plugin_description ([string $lang = null])

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.

Redefined in descendants as:

SloodlePluginPresenterPDFImporter::get_plugin_description() : Gets the human-readable description of this plugin.

get_plugin_name (line 48)

Gets the human-readable name of this plugin.

This MUST be overridden by base classes. If not, it will just return the name of the class.

return: The human-readable name of this plugin
access: public

string get_plugin_name ([string $lang = null])

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.

Redefined in descendants as:

SloodlePluginPresenterSlideImage::get_plugin_name() : Gets the human-readable name of this plugin.
SloodlePluginPresenterSlideVideo::get_plugin_name() : Gets the human-readable name of this plugin.
SloodlePluginPresenterSlideWeb::get_plugin_name() : Gets the human-readable name of this plugin.
SloodlePluginPresenterPDFImporter::get_plugin_name() : Gets the human-readable name of this plugin.

get_version (line 85)

Gets the internal version number of this plugin.

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, "2009012302" would be the 3rd release on the 23rd January 2009.

return: The version number of this module.

int get_version ()

Redefined in descendants as:

SloodlePluginPresenterSlideImage::get_version() : Gets the internal version number of this plugin.
SloodlePluginPresenterSlideVideo::get_version() : Gets the internal version number of this plugin.
SloodlePluginPresenterSlideWeb::get_version() : Gets the internal version number of this plugin.
SloodlePluginPresenterPDFImporter::get_version() : Gets the internal version number of this plugin.