Docs For Class SloodleModuleDistributor

Description

The Sloodle Distributor module class.

Located in /lib/modules/module_distributor.php (line 23)

SloodleModule
   |
   --SloodleModuleDistributor

Variable Summary

object $cm

object $sloodle_distributor_instance

object $sloodle_module_instance

Method Summary

SloodleModuleDistributor SloodleModuleDistributor ( &$_session)

mixed get_course_id ()

int get_creation_time ()

string get_intro ()

int get_modification_time ()

string get_name ()

array get_objects ()

string get_type ()

string get_type_full ()

bool load (mixed $id)

bool send_object (string $objname, string $uuid)

bool set_channel (string $uuid)

bool set_objects (array $objects)

Variables

object $cm = null (line 33)

Internal for Moodle only - course module instance.

Corresponds to one record from the Moodle 'course_modules' table.

access: private

object $sloodle_distributor_instance = null (line 49)

Internal only - Sloodle Distributor instance database object.

Corresponds to one record from the Moodle 'sloodle_distributor' table.

access: private

object $sloodle_module_instance = null (line 41)

Internal only - Sloodle module instance database object.

Corresponds to one record from the Moodle 'sloodle' table.

access: private

Inherited Variables

Inherited from SloodleModule

SloodleModule::$_session

Methods

Constructor SloodleModuleDistributor (line 57)

Constructor

SloodleModuleDistributor SloodleModuleDistributor ( &$_session)

&$_session

get_course_id (line 185)

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

Redefinition of:

SloodleModule::get_course_id(): Gets the identifier of the course this controller belongs to.

get_creation_time (line 194)

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

return: Timestamp

int get_creation_time ()

Redefinition of:

SloodleModule::get_creation_time(): Gets the time at which this instance was created, or 0 if unknown.

get_intro (line 176)

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

return: The intro description of this controller

string get_intro ()

Redefinition of:

SloodleModule::get_intro(): Gets the intro description of this module instance, if available.

get_modification_time (line 203)

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

return: Timestamp

int get_modification_time ()

Redefinition of:

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

get_name (line 167)

Gets the name of this module instance.

return: The name of this controller

string get_name ()

Redefinition of:

SloodleModule::get_name(): Gets the name of this module instance.

get_objects (line 92)

Gets a list of all objects for this Distributor.

return: An array of strings, each string containing the name of an object in this Distributor.

array get_objects ()

get_type (line 213)

Gets the short type name of this instance.

string get_type ()

Redefinition of:

SloodleModule::get_type(): Gets the short type name of this instance.

get_type_full (line 223)

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

Redefinition of:

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

load (line 69)

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)

Redefinition of:

SloodleModule::load(): Loads data from the database.

send_object (line 152)

Request that the specified object be sent to the specified avatar.

return: True if successful, or false if not.

bool send_object (string $objname, string $uuid)

string $objname: Name of the object to send
string $uuid: UUID of the avatar to send the object to

set_channel (line 136)

Sets the UUID of the XMLRPC channel used for requests.

return: True if successful, or false if not

bool set_channel (string $uuid)

string $uuid: The UUID of an XMLRPC channel

set_objects (line 112)

Sets the list of objects in this Distributor

return: True if successful, or false if not

bool set_objects (array $objects)

array $objects: An array of strings, each string containing the name of an object in the Distributor.

Inherited Methods

Inherited From SloodleModule

SloodleModule::SloodleModule()
SloodleModule::get_course_id()
SloodleModule::get_creation_time()
SloodleModule::get_intro()
SloodleModule::get_modification_time()
SloodleModule::get_name()
SloodleModule::get_type()
SloodleModule::get_type_full()
SloodleModule::load()