Docs For Class SloodlePluginPresenterSlideImage

Description

Presenter plugin for showing image slides.

Located in /plugin/presenter/image.php (line 22)

SloodlePluginBase
   |
   --SloodlePluginBasePresenterSlide
      |
      --SloodlePluginPresenterSlideImage

Method Summary

string get_absolute_url (string $source)

string get_plugin_name ([string $lang = null])

int get_version ()

string render_slide_for_browser (SloodlePresenterSlide $slide)

array render_slide_for_sl (SloodlePresenterSlide $slide)

Methods

get_absolute_url (line 32)

Construct an absolute URL, based on the given source data.

Leaves existing absolute URLs alone, but converts relative URLs as necessary. (This allows the site to be moved without disrupting these slides.)

return: An absolute URL.

string get_absolute_url (string $source)

string $source: The source data from the slide.

get_plugin_name (line 76)

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.

Redefinition of:

SloodlePluginBase::get_plugin_name(): Gets the human-readable name of this plugin.

get_version (line 89)

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 ()

Redefinition of:

SloodlePluginBase::get_version(): Gets the internal version number of this plugin.

render_slide_for_browser (line 49)

Render the given slide for browser output -- NOTE: render to a string, and return the string.

The title of the slide need not be included -- simply the basic iFrame or embedded player etc.

string render_slide_for_browser (SloodlePresenterSlide $slide)

SloodlePresenterSlide $slide: An object containing the raw slide data.

Redefinition of:

SloodlePluginBasePresenterSlide::render_slide_for_browser(): Render the given slide for browser output -- NOTE: render to a string, and return the string.

render_slide_for_sl (line 64)

Render the given slide for virtual-world output.

This returns two items of data in a numeric array. The first is the virtual world compatible type identifier: web, image, video, or audio (or a mime type). The second is the absolute URL to give it.

return: Numeric array containg (type, url)

array render_slide_for_sl (SloodlePresenterSlide $slide)

SloodlePresenterSlide $slide: An object containing the raw slide data.

Redefinition of:

SloodlePluginBasePresenterSlide::render_slide_for_sl(): Render the given slide for virtual-world output.

Inherited Methods

Inherited From SloodlePluginBasePresenterSlide

SloodlePluginBasePresenterSlide::render_slide_for_browser()
SloodlePluginBasePresenterSlide::render_slide_for_sl()

Inherited From SloodlePluginBase

SloodlePluginBase::get_id()
SloodlePluginBase::get_plugin_description()
SloodlePluginBase::get_plugin_name()
SloodlePluginBase::get_version()