Docs For Class SloodleModuleAviLister

Description

The Sloodle AviLister module class.

Search for real/avatar name associations.

Located in /lib/modules/module_avilister.php (line 25)

SloodleModule
   |
   --SloodleModuleAviLister

Method Summary

SloodleModuleAviLister SloodleModuleAviLister ( &$_session)

string|bool find_real_name (string $avatar_uuid, string $avatar_name)

array find_real_names (array $avatar_names)

array|bool find_real_names_course ()

string get_name ()

string get_type ()

string get_type_full ()

Variables

Inherited Variables

Inherited from SloodleModule

SloodleModule::$_session

Methods

Constructor SloodleModuleAviLister (line 37)

Constructor

SloodleModuleAviLister SloodleModuleAviLister ( &$_session)

&$_session

find_real_name (line 52)

Fetch the real name to match the given avatar.

Either parameter can be used. If the UUID is empty, then the name is used. If both are specified, then the UUID is used first, but with the name as a fall-back.

return: The full real name of the user if found, or FALSE otherwise.

string|bool find_real_name (string $avatar_uuid, string $avatar_name)

string $avatar_uuid: Avatar UUID
string $avatar_name: Full avatar name

find_real_names (line 69)

Lookup the realnames for all the given avatar names.

Note: the output array may not correspond to the input array, as avatars/users who are not found will not be returned.

return: An associative array of avatar names to (full) real names

array find_real_names (array $avatar_names)

array $avatar_names: An array of avatar names

find_real_names_course (line 94)

Lookup the avatar/real name associations for everybody in the current course.

NOTE: fails if a course is not loaded in the current SloodleSession

return: An associative array of avatar names to (full) real names if successful, or false if a course is not available

array|bool find_real_names_course ()

get_name (line 124)

Gets the name of this module instance.

return: The name of this instance

string get_name ()

Redefinition of:

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

get_type (line 133)

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

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.

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