[sloodle] element index

Package indexes

All elements
a c d e f g h i l m p q r s t u v _
_
top
Method _internal_validation_error
SloodleLSLResponse::_internal_validation_error() in sl_iolib.php
Internal function to report a data validation error.
a
top
Variable $auth_status
SloodleLSLRequest::$auth_status in sl_iolib.php
Indicates the status of request authentication.
Variable $avatar_name
SloodleLSLRequest::$avatar_name in sl_iolib.php
String name of the SL agent specified in the request (or NULL if not specified).
Variable $avatar_uuid
SloodleLSLRequest::$avatar_uuid in sl_iolib.php
String UUID of the SL user agent specified in the request (or NULL if not specified).
Method add_data_line
SloodleLSLResponse::add_data_line() in sl_iolib.php
Adds one line of data to the $data member
Method add_side_effect
SloodleLSLResponse::add_side_effect() in sl_iolib.php
Adds a single side effect code to member $status_code
Method add_side_effects
SloodleLSLResponse::add_side_effects() in sl_iolib.php
Adds one or more integer side effect codes to member $status_code.
Method authenticate_request
SloodleLSLRequest::authenticate_request() in sl_iolib.php
Authenticates the request against the site using the password parameter.
c
top
Variable $course_id
SloodleLSLRequest::$course_id in sl_iolib.php
Integer ID of the course specified in the request (or NULL if not specified).
Method clear_data
SloodleLSLResponse::clear_data() in sl_iolib.php
Clears all data from member $data
Page config.php
config.php in config.php
Method confirm_by_login_security_token
SloodleLSLHandler::confirm_by_login_security_token() in sl_lsllib.php
Authenticates the avatar identified in the request by the login security token.
Method create_moodle_user
SloodleUser::create_moodle_user() in sl_userlib.php
Create a Moodle user account with the specified first name, last name and email address.
Method create_sloodle_user
SloodleUser::create_sloodle_user() in sl_userlib.php
Create a new Sloodle user.
d
top
Variable $data
SloodleLSLResponse::$data in sl_iolib.php
Data to render following the status line in the response.
Method delete_login_position
SloodleUser::delete_login_position() in sl_userlib.php
Clears the login position from the currently selected Sloodle user.
Method delete_sloodle_user
SloodleUser::delete_sloodle_user() in sl_userlib.php
Deletes the Sloodle user identified by {@link:$sloodle_user_id}.
e
top
Variable $enrolled_courses_cache
SloodleUser::$enrolled_courses_cache in sl_userlib.php
Cache of courses which the Moodle user is enrolled in Used by some functions fetching database data about a Moodle user's courses.
f
top
Method find_linked_moodle_user
SloodleUser::find_linked_moodle_user() in sl_userlib.php
Find the Moodle user linked to the current Sloodle user.
Method find_linked_sloodle_user
SloodleUser::find_linked_sloodle_user() in sl_userlib.php
Find the Sloodle user linked to the current Moodle user.
Method find_sloodle_user
SloodleUser::find_sloodle_user() in sl_userlib.php
Attempts to find a Sloodle user by their UUID and/or avatar nam.
Method find_sloodle_user_by_login_position
SloodleUser::find_sloodle_user_by_login_position() in sl_userlib.php
Attempt to find a Sloodle user by their loginzone position If successful, the user ID is stored in {@link:$sloodle_user_id} and the function returns true.
g
top
Method generate_login_position
SloodleUser::generate_login_position() in sl_userlib.php
Generates a new login position for the current Sloodle user.
Method get_auth_status
SloodleLSLRequest::get_auth_status() in sl_iolib.php
Returns member variable $auth_status.
Method get_avatar_name
SloodleLSLRequest::get_avatar_name() in sl_iolib.php
Returns member value $avatar_name.
Method get_avatar_uuid
SloodleLSLRequest::get_avatar_uuid() in sl_iolib.php
Returns member value $avatar_uuid.
Method get_course_id
SloodleLSLRequest::get_course_id() in sl_iolib.php
Returns member value $course_id.
Method get_course_module_instance
SloodleLSLRequest::get_course_module_instance() in sl_iolib.php
Get a course module instance for the module specified in the request Uses the ID specified in $module_id.
Method get_course_record
SloodleLSLRequest::get_course_record() in sl_iolib.php
Gets a database record for the course identified in the request.
Method get_login_security_token
SloodleLSLRequest::get_login_security_token() in sl_iolib.php
Returns member value $login_security_token.
Method get_module_id
SloodleLSLRequest::get_module_id() in sl_iolib.php
Returns member value $module_id.
Method get_moodle_user_id
SloodleUser::get_moodle_user_id() in sl_userlib.php
Accessor: gets the Moodle user ID member, {@link: $moodle_user_id}.
Method get_password
SloodleLSLRequest::get_password() in sl_iolib.php
Returns member value $password.
Method get_response
SloodleLSLRequest::get_response() in sl_iolib.php
Returns member value $response.
Method get_sloodle_user_id
SloodleUser::get_sloodle_user_id() in sl_userlib.php
Accessor: gets the Sloodle user ID member, {@link: $sloodle_user_id}.
Method get_user
SloodleLSLRequest::get_user() in sl_iolib.php
Returns member value $user.
h
top
Method has_login_security_token
SloodleUser::has_login_security_token() in sl_userlib.php
Checks if the current Sloodle user has a login security token
i
top
Method insert_sloodle_user_cache_to_db
SloodleUser::insert_sloodle_user_cache_to_db() in sl_userlib.php
Use the Sloodle user cache to insert a new entry in the Sloodle user database table.
Method is_authenticated
SloodleLSLRequest::is_authenticated() in sl_iolib.php
Indicates whether or not request authentication has succeeded.
Method is_auth_failed
SloodleLSLRequest::is_auth_failed() in sl_iolib.php
Indicates whether or not request authentication has failed.
Method is_request_data_processed
SloodleLSLRequest::is_request_data_processed() in sl_iolib.php
Returns member variable $request_data_processed.
Method is_user_enrolled_by_request
SloodleLSLHandler::is_user_enrolled_by_request() in sl_lsllib.php
Checks that a user is enrolled in a course, based on request data.
Method is_user_in_course
SloodleUser::is_user_in_course() in sl_userlib.php
Checks if the current Moodle user is already enrolled in the specified course.
l
top
Variable $login_security_token
SloodleLSLRequest::$login_security_token in sl_iolib.php
String containing the login security token specified in the request (or NULL if not specified).
Variable $login_zone_pos
SloodleLSLRequest::$login_zone_pos in sl_iolib.php
A 3-element array containing the LoginZone position vector specified in HTTP request parameters (or NULL if not specified).
Page lib.php
lib.php in lib.php
Method link_users
SloodleUser::link_users() in sl_userlib.php
Links the current Sloodle and Moodle accounts together.
Method login_by_request
SloodleLSLHandler::login_by_request() in sl_lsllib.php
Performs an internal 'login' based on user identified in request.
Method login_moodle_user
SloodleUser::login_moodle_user() in sl_userlib.php
Performs an internal login of the current Moodle user.
m
top
Variable $module_id
SloodleLSLRequest::$module_id in sl_iolib.php
Integer ID of the course module instance specified in the request (or NULL if not specified).
Variable $moodle_user_cache
SloodleUser::$moodle_user_cache in sl_userlib.php
Moodle user data cache.
Variable $moodle_user_id
SloodleUser::$moodle_user_id in sl_userlib.php
Integer ID of a Moodle user entry in the database.
p
top
Variable $page_number
SloodleLSLResponse::$page_number in sl_iolib.php
Current page number.
Variable $page_total
SloodleLSLResponse::$page_total in sl_iolib.php
Total number of pages.
Variable $password
SloodleLSLRequest::$password in sl_iolib.php
Contains the password specified in HTTP request parameters (or NULL if not specified).
Method process_request_data
SloodleLSLRequest::process_request_data() in sl_iolib.php
Process all of the standard data provided by the HTTP request.
q
top
Method quick_output
SloodleLSLResponse::quick_output() in sl_iolib.php
Quick output of data to avoid several accessor calls if the response is very basic.
r
top
Variable $request
SloodleLSLHandler::$request in sl_lsllib.php
A Sloodle request handling object.
Variable $request_data_processed
SloodleLSLRequest::$request_data_processed in sl_iolib.php
Indicates whether or not the request data has been processed by the process_request_data() function.
Variable $request_descriptor
SloodleLSLResponse::$request_descriptor in sl_iolib.php
Request descriptor.
Variable $request_timestamp
SloodleLSLResponse::$request_timestamp in sl_iolib.php
Timestamp when the request was originally made by the LSL script.
Variable $response
SloodleLSLHandler::$response in sl_lsllib.php
A Sloodle response handling object.
Variable $response
SloodleLSLRequest::$response in sl_iolib.php
The object used to output response data.
Variable $response_timestamp
SloodleLSLResponse::$response_timestamp in sl_iolib.php
Timestamp when the response was generated on the Moodle site.
Method regenerate_login_security_token
SloodleUser::regenerate_login_security_token() in sl_userlib.php
Generates a new login security token for the current Sloodle user
Method render_to_output
SloodleLSLResponse::render_to_output() in sl_iolib.php
Outputs the response directly to the HTTP response.
Method render_to_string
SloodleLSLResponse::render_to_string() in sl_iolib.php
Renders the response to a string.
Method required_param
SloodleLSLRequest::required_param() in sl_iolib.php
Obtains a named HTTP request parameter, and terminate with an error message if it has not been provided.
s
top
Variable $side_effects
SloodleLSLResponse::$side_effects in sl_iolib.php
Integer side effect(s) codes.
Variable $sloodle_user_cache
SloodleUser::$sloodle_user_cache in sl_userlib.php
Sloodle user data cache.
Variable $sloodle_user_id
SloodleUser::$sloodle_user_id in sl_userlib.php
Integer ID of a Sloodle user entry in the database.
Variable $status_code
SloodleLSLResponse::$status_code in sl_iolib.php
Integer status code of the response.
Variable $status_descriptor
SloodleLSLResponse::$status_descriptor in sl_iolib.php
Status descriptor string.
Page sl_classroomlib.php
sl_classroomlib.php in sl_classroomlib.php
Page sl_generallib.php
sl_generallib.php in sl_generallib.php
Page sl_iolib.php
sl_iolib.php in sl_iolib.php
Page sl_lsllib.php
sl_lsllib.php in sl_lsllib.php
Page sl_userlib.php
sl_userlib.php in sl_userlib.php
Page sl_avilister_linker.php
sl_avilister_linker.php in sl_avilister_linker.php
Method set_data
SloodleLSLResponse::set_data() in sl_iolib.php
Accessor function to set member value $data. Note: it is recommended that you use the add_data_line() and clear_data() functions instead of this.
Method set_moodle_user_id
SloodleUser::set_moodle_user_id() in sl_userlib.php
Accessor: sets the Moodle user ID member, {@link: $moodle_user_id}.
Method set_page_number
SloodleLSLResponse::set_page_number() in sl_iolib.php
Accessor function to set member value $page_number
Method set_page_total
SloodleLSLResponse::set_page_total() in sl_iolib.php
Accessor function to set member value $page_total
Method set_request_descriptor
SloodleLSLResponse::set_request_descriptor() in sl_iolib.php
Accessor function to set member value $request_descriptor
Method set_request_timestamp
SloodleLSLResponse::set_request_timestamp() in sl_iolib.php
Accessor function to set member value $request_timestamp
Method set_response
SloodleLSLRequest::set_response() in sl_iolib.php
Sets the SloodleLSLRequest::$response member.
Method set_response_timestamp
SloodleLSLResponse::set_response_timestamp() in sl_iolib.php
Accessor function to set member value $response_timestamp
Method set_side_effects
SloodleLSLResponse::set_side_effects() in sl_iolib.php
Accessor function to set member value $side_effects. Note: it is recommended that you use add_side_effect() or add_side_effects() instead.
Method set_sloodle_user_id
SloodleUser::set_sloodle_user_id() in sl_userlib.php
Accessor: sets the Sloodle user ID member, {@link: $sloodle_user_id}.
Method set_status_code
SloodleLSLResponse::set_status_code() in sl_iolib.php
Accessor function to set member value $status_code
Method set_status_descriptor
SloodleLSLResponse::set_status_descriptor() in sl_iolib.php
Accessor function to set member value $status_descriptor
Method set_tracking_code
SloodleLSLResponse::set_tracking_code() in sl_iolib.php
Accessor function to set member value $tracking_code
Method set_user
SloodleLSLRequest::set_user() in sl_iolib.php
Sets the SloodleLSLRequest::$user member.
Method set_user_key
SloodleLSLResponse::set_user_key() in sl_iolib.php
Accessor function to set member value $user_key
Class SloodleLSLHandler
SloodleLSLHandler in sl_lsllib.php
A helper class to automate many API features.
Method SloodleLSLHandler
SloodleLSLHandler::SloodleLSLHandler() in sl_lsllib.php
Class constructor.
Class SloodleLSLRequest
SloodleLSLRequest in sl_iolib.php
Handles incoming HTTP requests, typically from LSL scripts.
Method SloodleLSLRequest
SloodleLSLRequest::SloodleLSLRequest() in sl_iolib.php
Constructor
  • initialises the user and response objects.
Class SloodleLSLResponse
SloodleLSLResponse in sl_iolib.php
A helper class to validate and structure data for output according to the Sloodle communications specification.
Method SloodleLSLResponse
SloodleLSLResponse::SloodleLSLResponse() in sl_iolib.php
Constructor
  • can intialise some variables
Class SloodleUser
SloodleUser in sl_userlib.php
A class to represent a single user, including Moodle and Sloodle data.
Method SloodleUser
SloodleUser::SloodleUser() in sl_userlib.php
Class constructor.
Function sloodle_add_classroom_profile
sloodle_add_classroom_profile() in sl_classroomlib.php
Function sloodle_add_classroom_profile_entry
sloodle_add_classroom_profile_entry() in sl_classroomlib.php
Function sloodle_add_instance
sloodle_add_instance() in lib.php
Given an object containing all the necessary data, (defined by the form in mod.html) this function will create a new instance and return the id number of the new instance.
Function sloodle_add_to_log
sloodle_add_to_log() in sl_generallib.php
Old logging function
Function sloodle_array_to_vector
sloodle_array_to_vector() in sl_generallib.php
Converts an array vector to a string vector.
Function sloodle_authorize_object
sloodle_authorize_object() in sl_classroomlib.php
Constant SLOODLE_AUTH_FAILED
SLOODLE_AUTH_FAILED in sl_iolib.php
Used to indicate that authentication has failed.
Constant SLOODLE_AUTH_OK
SLOODLE_AUTH_OK in sl_iolib.php
Used to indicate that authentication has been successful.
Constant SLOODLE_AUTH_UNKNOWN
SLOODLE_AUTH_UNKNOWN in sl_iolib.php
Used to indicate that authentication has not yet been attempted.
Function sloodle_check_course_module_instance_type
sloodle_check_course_module_instance_type() in sl_generallib.php
Determines if the specified course module instance is of the named type.
Function sloodle_classroom_profile_exists_by_name
sloodle_classroom_profile_exists_by_name() in sl_classroomlib.php
Function sloodle_cron
sloodle_cron() in lib.php
Function to be run periodically according to the moodle cron This function searches for things that need to be done, such as sending out mail, toggling flags etc ...
Constant SLOODLE_DEBUG
SLOODLE_DEBUG in sl_debug.php
Constant SLOODLE_DEBUG_MODE_PARAM_NAME
SLOODLE_DEBUG_MODE_PARAM_NAME in sl_debug.php
Function sloodle_debug_output
sloodle_debug_output() in sl_debug.php
Function sloodle_delete_instance
sloodle_delete_instance() in lib.php
Given an ID of an instance of this module, this function will permanently delete the instance and any data that depends on it.
Constant SLOODLE_DIRROOT
SLOODLE_DIRROOT in config.php
Constant SLOODLE_FIELD_SEPARATOR
SLOODLE_FIELD_SEPARATOR in sl_iolib.php
Defines what character(s) will be used to separate individual fields in the Sloodle communications specification.
Function sloodle_finished_login_coordinates
sloodle_finished_login_coordinates() in sl_generallib.php
Generates teleport coordinates for a user who has already finished the LoginZone process.
Function sloodle_get_auth_method
sloodle_get_auth_method() in sl_generallib.php
Gets the site-wide authentication from the configuration table.
Function sloodle_get_classroom_profile
sloodle_get_classroom_profile() in sl_classroomlib.php
Function sloodle_get_classroom_profiles
sloodle_get_classroom_profiles() in sl_classroomlib.php
Function sloodle_get_classroom_profile_by_name
sloodle_get_classroom_profile_by_name() in sl_classroomlib.php
Function sloodle_get_classroom_profile_entries
sloodle_get_classroom_profile_entries() in sl_classroomlib.php
Function sloodle_get_config
sloodle_get_config() in sl_generallib.php
Gets a Sloodle configuration value from Moodle's "config" table.
Function sloodle_get_course_module_instance
sloodle_get_course_module_instance() in sl_generallib.php
Obtains the identified course module instance database record.
Function sloodle_get_distribution_list
sloodle_get_distribution_list() in sl_generallib.php
Gets an array of the names of all objects in the Object Distributor.
Function sloodle_get_loginzone_pos
sloodle_get_loginzone_pos() in sl_generallib.php
Gets the position of the site-wide LoginZone object.
Function sloodle_get_loginzone_region
sloodle_get_loginzone_region() in sl_generallib.php
Gets the name of the region where the site-wide LoginZone object was most recently rezzed.
Function sloodle_get_loginzone_size
sloodle_get_loginzone_size() in sl_generallib.php
Gets the size of the site-wide LoginZone object.
Function sloodle_get_module_id
sloodle_get_module_id() in sl_generallib.php
Obtains the ID number of the specified module (type not instance).
Function sloodle_get_participants
sloodle_get_participants() in lib.php
Must return an array of user records (all data) who are participants for a given instance of sloodle. Must include every user involved in the instance, independient of his role (student, teacher, admin...) See other modules as example.
Function sloodle_get_prim_password
sloodle_get_prim_password() in sl_generallib.php
Gets the site-wide Sloodle prim password from the configuration table.
Function sloodle_grades
sloodle_grades() in lib.php
Must return an array of grades for a given instance of this module, indexed by user. It also returns a maximum allowed grade.
Function sloodle_is_automatic_registration_on
sloodle_is_automatic_registration_on() in sl_generallib.php
Determines whether or not automatic registration is enabled.
Function sloodle_is_course_module_instance_visible
sloodle_is_course_module_instance_visible() in sl_generallib.php
Determines whether or not the specified course module instance is visible.
Function sloodle_is_installed
sloodle_is_installed() in sl_generallib.php
Determines whether or not Sloodle is installed.
Constant SLOODLE_LINE_SEPARATOR
SLOODLE_LINE_SEPARATOR in sl_iolib.php
Defines what character(s) will be used to separate lines in the Sloodle communications specification.
Function sloodle_login_zone_coordinates
sloodle_login_zone_coordinates() in sl_generallib.php
Calculates the maximum and minimum bounds of the site-wide LoginZone.
Function sloodle_position_is_in_login_zone
sloodle_position_is_in_login_zone() in sl_generallib.php
Checks if the specified position is in the current (site-wide) loginzone.
Function sloodle_prim_password
sloodle_prim_password() in sl_generallib.php
Old form of the {@link: sloodle_set_prim_password()} function.
Function sloodle_print_config_notecard
sloodle_print_config_notecard() in sl_setup_notecard.php
Function sloodle_print_recent_activity
sloodle_print_recent_activity() in lib.php
Given a course and a time, this module should find recent activity that has occurred in sloodle activities and print it out.
Function sloodle_process_options
sloodle_process_options() in lib.php
Function sloodle_random_object_pwd
sloodle_random_object_pwd() in sl_classroomlib.php
Function sloodle_random_position_in_zone
sloodle_random_position_in_zone() in sl_generallib.php
Generates a random position within the specified cubic zone.
Function sloodle_random_security_token
sloodle_random_security_token() in sl_generallib.php
Generates a random login security token.
Function sloodle_random_web_password
sloodle_random_web_password() in sl_generallib.php
Generates a random web password Uses mixed-case letters and numbers to generate a random 8-character string.
Function sloodle_register_object
sloodle_register_object() in sl_classroomlib.php
Function sloodle_required_param
sloodle_required_param() in sl_iolib.php
Obtains a named HTTP request parameter, and terminates script with an error message if it was not provided.
Function sloodle_round_vector
sloodle_round_vector() in sl_generallib.php
Rounds the specified 3d vector integer values.
Function sloodle_save_classroom_profile
sloodle_save_classroom_profile() in sl_classroomlib.php
Function sloodle_save_classroom_profile_entries
sloodle_save_classroom_profile_entries() in sl_classroomlib.php
Function sloodle_scale_used
sloodle_scale_used() in lib.php
This function returns if a scale is being used by one sloodle it it has support for grading and scales. Commented code should be modified if necessary. See forum, glossary or journal modules as reference.
Function sloodle_send_xmlrpc_message
sloodle_send_xmlrpc_message() in sl_generallib.php
Sends an XMLRPC message into Second Life.
Function sloodle_set_auth_method
sloodle_set_auth_method() in sl_generallib.php
Sets the site-wide authentication method in the Moodle configuration table.
Function sloodle_set_config
sloodle_set_config() in sl_generallib.php
Sets a Sloodle configuration value.
Function sloodle_set_loginzone_pos
sloodle_set_loginzone_pos() in sl_generallib.php
Sets the position of the site-wide LoginZone object (stored in the Moodle configuration table).
Function sloodle_set_loginzone_region
sloodle_set_loginzone_region() in sl_generallib.php
Sets the name of the region where the site-wide LoginZone object was most recently rezzed.
Function sloodle_set_loginzone_size
sloodle_set_loginzone_size() in sl_generallib.php
Sets the size of the site-wide LoginZone object (stored in the Moodle configuration table).
Function sloodle_set_prim_password
sloodle_set_prim_password() in sl_generallib.php
Sets the site-wide Sloodle prim password from the configuration table.
Function sloodle_update_instance
sloodle_update_instance() in lib.php
Given an object containing all the necessary data, (defined by the form in mod.html) this function will update an existing instance with new data.
Function sloodle_user_complete
sloodle_user_complete() in lib.php
Print a detailed representation of what a user has done with a given particular instance of this module, for user activity reports.
Function sloodle_user_outline
sloodle_user_outline() in lib.php
Return a small object with summary information about what a user has done with a given particular instance of this module Used for user activity reports.
Function sloodle_validate_object_for_pwd
sloodle_validate_object_for_pwd() in sl_classroomlib.php
Function sloodle_vector_to_array
sloodle_vector_to_array() in sl_generallib.php
Converts a string vector to an array vector.
Constant SLOODLE_VERSION
SLOODLE_VERSION in config.php
Constant SLOODLE_WWWROOT
SLOODLE_WWWROOT in config.php
Page sl_debug.php
sl_debug.php in sl_debug.php
Page sl_setup_notecard.php
sl_setup_notecard.php in sl_setup_notecard.php
t
top
Variable $tracking_code
SloodleLSLResponse::$tracking_code in sl_iolib.php
Tracking code of the request.
u
top
Variable $user
SloodleLSLRequest::$user in sl_iolib.php
The object used to store and process incoming user data.
Variable $user
SloodleLSLHandler::$user in sl_lsllib.php
A Sloodle user object.
Variable $user_key
SloodleLSLResponse::$user_key in sl_iolib.php
SL agent key.
Method unlink_sloodle_user
SloodleUser::unlink_sloodle_user() in sl_userlib.php
Completely unlinks the Sloodle user from any Moodle account.
Method update_enrolled_courses_cache_from_db
SloodleUser::update_enrolled_courses_cache_from_db() in sl_userlib.php
Use the database to update the cache of courses which the current Moodle user is enrolled in.
Method update_moodle_user_cache_from_db
SloodleUser::update_moodle_user_cache_from_db() in sl_userlib.php
Update the Moodle user cache ({@link:$moodle_user_cache}) from the database
Method update_sloodle_user_cache_from_db
SloodleUser::update_sloodle_user_cache_from_db() in sl_userlib.php
Updates the Sloodle user cache ({@link:$sloodle_user_cache}) from the database
Method update_sloodle_user_cache_to_db
SloodleUser::update_sloodle_user_cache_to_db() in sl_userlib.php
Use the Sloodle user cache to update an entry in the Sloodle users database table.
Method users_linked
SloodleUser::users_linked() in sl_userlib.php
Determines whether or not the current Sloodle and Moodle users are linked.
v
top
Page version.php
version.php in version.php
Page version_linker.php
version_linker.php in version_linker.php
Page view_user.php
view_user.php in view_user.php
Page view_users.php
view_users.php in view_users.php
a c d e f g h i l m p q r s t u v _