Docs For Class SloodleModuleiBank

Description

The Sloodle StipendGiver module class.

Located in /lib/modules/module_ibank.php (line 31)

SloodleModule
   |
   --SloodleModuleiBank

Variable Summary

object $cm

mixed $sCourseObj

mixed $sloodleid

object $sloodle_module_instance

object $sloodle_stipendgiver_instance

Method Summary

SloodleModuleiBank SloodleModuleiBank ( &$_session)

void get_amount ()

void get_class_list ()

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)

Variables

object $cm = null (line 41)

Internal for Moodle only - course module instance.

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

access: private

mixed $sCourseObj = null (line 59)

mixed $sloodleid = null (line 63)

object $sloodle_module_instance = null (line 49)

Internal only - Sloodle module instance database object.

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

access: private

object $sloodle_stipendgiver_instance = null (line 57)

Internal only - Sloodle StipendGiver instance database object.

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

access: private

Inherited Variables

Inherited from SloodleModule

SloodleModule::$_session

Methods

Constructor SloodleModuleiBank (line 70)

Constructor

SloodleModuleiBank SloodleModuleiBank ( &$_session)

&$_session

get_amount (line 187)

void get_amount ()

get_class_list (line 123)

Gets a list of students in the class

void get_class_list ()

get_course_id (line 174)

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

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

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

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

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

Gets a list of all objects for this StipendGiver.

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

array get_objects ()

get_type (line 205)

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

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

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.

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