Docs For Class SloodleModuleGlossary

Description

The Sloodle glossary module class.

Located in /sloodle/lib/modules/module_glossary.php (line 23)

SloodleModule
   |
   --SloodleModuleGlossary

Variable Summary

object $cm

object $moodle_glossary_instance

Method Summary

SloodleModuleGlossary SloodleModuleGlossary ( &$_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)

array search (string $term, [bool $matchPartial = true], [bool $searchAliases = false], [bool $searchDefinitions = false])

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 $moodle_glossary_instance = null (line 41)

Internal only - Moodle glossary module instance database object.

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

access: private

Inherited Variables

Inherited from SloodleModule

SloodleModule::$_session

Methods

Constructor SloodleModuleGlossary (line 50)

Constructor

SloodleModuleGlossary SloodleModuleGlossary ( &$_session)

&$_session

get_course_id (line 169)

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

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

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

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

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_type (line 197)

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

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

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.

search (line 97)

Searches all entries in the current glossary for the given term.

return: An array of SloodleGlossaryEntry objects

array search (string $term, [bool $matchPartial = true], [bool $searchAliases = false], [bool $searchDefinitions = false])

string $term: The term to search for
bool $matchPartial: If TRUE (default) then partial matches will be returned (e.g. 'vat' would partially match 'avatar')
bool $searchAliases: If TRUE (not default) then aliases will be searched as well
bool $searchDefinitions: If TRUE (not default) then definitions will be searched as well (can be SLOW, and always gets partial matches)

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