Docs For Class SloodleModule

Description

Sloodle module base class.

An abstract class which must be overridden by sub-classes.

Located in /sloodle/lib/modules/module_base.php (line 20)

Direct descendents

Class	Description
SloodleModuleChat	The Sloodle chat module class.
SloodleModuleDistributor	The Sloodle Distributor module class.
SloodleModuleGlossary	The Sloodle glossary module class.
SloodleModuleSloodleObject	The Sloodle Object assignment module class.

Variable Summary

object $_session

Method Summary

SloodleModule SloodleModule (object &$_session)

mixed get_course_id ()

int get_creation_time ()

string get_intro ()

int get_modification_time ()

string get_name ()

string get_type ()

string get_type_full ()

bool load (mixed $id)

Variables

object $_session = null (line 31)

Reference to the containing SloodleSession object.

If null, then this module is being used outwith the framework. Always check the status of the variable before using it!

access: protected

Methods

Constructor SloodleModule (line 40)

Constructor - initialises the session variable

SloodleModule SloodleModule (object &$_session)

object &$_session: A reference to the containing SloodleSession object, if available.

get_course_id (line 82)

Gets the identifier of the course this controller belongs to.

return: Course identifier. Type depends on VLE. (In Moodle, it will be an integer).

mixed get_course_id ()

Redefined in descendants as:

SloodleModuleChat::get_course_id() : Gets the identifier of the course this controller belongs to.
SloodleModuleDistributor::get_course_id() : Gets the identifier of the course this controller belongs to.
SloodleModuleGlossary::get_course_id() : Gets the identifier of the course this controller belongs to.
SloodleModuleSloodleObject::get_course_id() : Gets the identifier of the course this controller belongs to.

get_creation_time (line 91)

Gets the time at which this instance was created, or 0 if unknown.

return: Timestamp

int get_creation_time ()

Redefined in descendants as:

SloodleModuleChat::get_creation_time() : Gets the time at which this instance was created, or 0 if unknown.
SloodleModuleDistributor::get_creation_time() : Gets the time at which this instance was created, or 0 if unknown.
SloodleModuleGlossary::get_creation_time() : Gets the time at which this instance was created, or 0 if unknown.
SloodleModuleSloodleObject::get_creation_time() : Gets the time at which this instance was created, or 0 if unknown.

get_intro (line 73)

Gets the intro description of this module instance, if available.

return: The intro description of this controller

string get_intro ()

Redefined in descendants as:

SloodleModuleChat::get_intro() : Gets the intro description of this module instance, if available.
SloodleModuleDistributor::get_intro() : Gets the intro description of this module instance, if available.
SloodleModuleGlossary::get_intro() : Gets the intro description of this module instance, if available.
SloodleModuleSloodleObject::get_intro() : Gets the intro description of this module instance, if available.

get_modification_time (line 100)

Gets the time at which this instance was last modified, or 0 if unknown.

return: Timestamp

int get_modification_time ()

Redefined in descendants as:

SloodleModuleChat::get_modification_time() : Gets the time at which this instance was last modified, or 0 if unknown.
SloodleModuleDistributor::get_modification_time() : Gets the time at which this instance was last modified, or 0 if unknown.
SloodleModuleGlossary::get_modification_time() : Gets the time at which this instance was last modified, or 0 if unknown.
SloodleModuleSloodleObject::get_modification_time() : Gets the time at which this instance was last modified, or 0 if unknown.

get_name (line 64)

Gets the name of this module instance.

return: The name of this controller

string get_name ()

Redefined in descendants as:

SloodleModuleChat::get_name() : Gets the name of this module instance.
SloodleModuleDistributor::get_name() : Gets the name of this module instance.
SloodleModuleGlossary::get_name() : Gets the name of this module instance.
SloodleModuleSloodleObject::get_name() : Gets the name of this module instance.

get_type (line 110)

Gets the short type name of this instance.

string get_type ()

Redefined in descendants as:

SloodleModuleChat::get_type() : Gets the short type name of this instance.
SloodleModuleDistributor::get_type() : Gets the short type name of this instance.
SloodleModuleGlossary::get_type() : Gets the short type name of this instance.
SloodleModuleSloodleObject::get_type() : Gets the short type name of this instance.

get_type_full (line 120)

Gets the full type name of this instance, according to the current language pack, if available.

Note: should be overridden by sub-classes.

return: Full type name if possible, or the short name otherwise.

string get_type_full ()

Redefined in descendants as:

SloodleModuleChat::get_type_full() : Gets the full type name of this instance, according to the current language pack, if available.
SloodleModuleDistributor::get_type_full() : Gets the full type name of this instance, according to the current language pack, if available.
SloodleModuleGlossary::get_type_full() : Gets the full type name of this instance, according to the current language pack, if available.
SloodleModuleSloodleObject::get_type_full() : Gets the full type name of this instance, according to the current language pack, if available.

load (line 52)

Loads data from the database.

Note: even if the function fails, it may still have overwritten some or all existing data in the object.

return: True if successful, or false otherwise

bool load (mixed $id)

mixed $id: The site-wide unique identifier for all modules. Type depends on VLE. On Moodle, it is an integer course module identifier ('id' field of 'course_modules' table)

Redefined in descendants as:

SloodleModuleChat::load() : Loads data from the database.
SloodleModuleDistributor::load() : Loads data from the database.
SloodleModuleGlossary::load() : Loads data from the database.
SloodleModuleSloodleObject::load() : Loads data from the database.