Full index

Package indexes


a b c d e f g h i l m n o p q r s t u v w _
a
top
Variable $assignment
SloodleModuleSloodleObject::$assignment in module_sloodleobject.php
Internal only - the Moodle assignment structure.
Variable $authorized
Indicates whether or not this object is currently authorized.
Variable $avatar_data
Internal only - avatar data.
Variable $avatar_name
SloodleAviListName::$avatar_name in module_avilister.php
Avatar name ("firstname lastname")
Variable $avatar_uuid
Avatar UUID.
Variable $avuuid
SloodleUserObject::$avuuid in user_object.php
The UUID of the object's user
Method add_data_line
Adds one line of data to the $data member
Method add_entry
Attempts to write a new blog entry to the database, attributed to the user currently loaded in the SloodleSession.
Method add_linked_avatar
Adds a new avatar to the database, and link it to the specified user.
Method add_message
Adds a new chat message.
Method add_pending_avatar
Adds a new unlinked avatar to the database (the entry is pending linking)
Method add_side_effect
Adds a single side effect code to member $status_code
Method add_side_effects
Adds one or more integer side effect codes to member $status_code.
Method add_user_object
Adds or udpates the given user object as unauthorised.
Method allow_update
Checks if users are allowed to re-select their answer in this choice.
Method assignment_sloodleobject
Class assignment_sloodleobject
assignment_sloodleobject in assignment.class.php
Extend the base assignment class for assignments where you submit an SL object in-world.
Class assignment_sloodleobject_submission
assignment_sloodleobject_submission in assignment.class.php
Defines a submission for a Sloodle assignment.
Method authenticate_request
Verifies security for the incoming request (but does not check user access).
Method authenticate_user_request
Verifies security for the incoming user-centric request.
Method authorise_object
Authorises an otherwise unauthorised active object against the given user and the current controller.
Method authorise_user_object
Authorises the given object for the current avatar.
Method autoregister_avatar_user
Auto-register a new user account for the current avatar.
Page active_object_ping_linker.php
active_object_ping_linker.php in active_object_ping_linker.php
Page auth_check_linker.php
auth_check_linker.php in auth_check_linker.php
Page auth_object_linker.php
auth_object_linker.php in auth_object_linker.php
Page access.php
access.php in access.php
Page active_object.php
active_object.php in active_object.php
Page assignment.class.php
assignment.class.php in assignment.class.php
Page avilister_linker.php
avilister_linker.php in avilister_linker.php
b
top
Variable $body
SloodleBlogPost::$body in module_blog.php
The body of the post.
Page blog_linker.php
blog_linker.php in blog_linker.php
c
top
Variable $cm
SloodleController::$cm in controller.php
Internal for Moodle only - course module instance.
Variable $cm
SloodleModuleDistributor::$cm in module_distributor.php
Internal for Moodle only - course module instance.
Variable $cm
SloodleModuleGlossary::$cm in module_glossary.php
Internal for Moodle only - course module instance.
Variable $cm
SloodleModuleSloodleObject::$cm in module_sloodleobject.php
Internal for Moodle only - course module instance.
Variable $cm
SloodleModuleChoice::$cm in module_choice.php
Internal for Moodle only - course module instance.
Variable $cm
SloodleModuleChat::$cm in module_chat.php
Internal for Moodle only - course module instance.
Variable $concept
SloodleGlossaryEntry::$concept in module_glossary.php
The name of this entry.
Variable $controller
The SloodleController object being used to access this course, if available.
Variable $course
SloodleSession::$course in sloodle_session.php
The Sloodle course structure for the course this session is accessing
Variable $course
SloodleActiveObject::$course in active_object.php
The course/controller which this object is authorised for.
Variable $course_object
The database object of the course to which this object relates.
Method can_show_results
Checks if results are to be shown.
Method can_user_authorise_objects
Checks whether or not the CURRENTLY LOGGED-IN user can authorise objects on this course.
Method check_authorisation
Checks if the specified object is authorised for this controller with the given password.
Method check_autoenrol
Is auto enrolment permitted on this site AND course? Takes into account the site-wide setting as well.
Method check_autoreg
Is auto registration permitted on this site AND course? Takes into account the site-wide setting as well.
Page configure_object.php
configure_object.php in configure_object.php
Page course_info_linker.php
course_info_linker.php in course_info_linker.php
Method clear_data
Clears all data from member $data
Page controller.php
controller.php in controller.php
Page course.php
course.php in course.php
Page check_user_auth_linker.php
check_user_auth_linker.php in check_user_auth_linker.php
d
top
Variable $data
Data to render following the status line in the response.
Variable $definition
SloodleGlossaryEntry::$definition in module_glossary.php
The definition of this entry.
Method data_preprocessing
Pre-processes form initial values.
Method definition
Defines the form
Method definition_after_data
Performs extra processing on the form after existing/default data has been specified.
Method delete_avatar
Deletes the current avatar from the database.
Method delete_layout
Deletes the named layout.
Method delete_loginzone_allocation
Deletes any loginzone allocations for the given user If there are multiple for the same user (which there should never be) it will delete them all.
Method delete_user_object
Deletes a user-centric object by UUID.
Method disable
Disables this controller
Method disable_autoenrol
Disables auto-enrolment for this course.
Method disable_autoreg
Disables auto-registration for this course.
e
top
Method enable
SloodleController::enable() in controller.php
Enables this controller
Method enable_autoenrol
Enables auto-enrolment for this course.
Method enable_autoreg
Enables auto-registration for this course.
Method enrol
Enrols the current user in the specified course
f
top
Variable $field_separator
The separation string between fields of a response line (by default, a pipe character |).
Method find_real_name
Fetch the real name to match the given avatar.
Method find_real_names
Lookup the realnames for all the given avatar names.
Method find_real_names_course
Lookup the avatar/real name associations for everybody in the current course.
Page file.php
file.php in file.php
g
top
Method generate_loginzone_allocation
Generates a new LoginZone allocation for the specified user.
Method get_authorizing_user
Gets the ID of the user who authorised the specified object.
Method get_autoenrol
Gets the auto enrolment value for this course only.
Method get_autoreg
Gets the autoregistration value for this course only.
Method get_avatar_id
Gets the unique ID of the avatar.
Method get_avatar_last_active
Gets the timestamp of whenever the avatar was last active
Method get_avatar_name
Gets the name of the avatar
Method get_avatar_name
Fetches the avatar name request parameter.
Method get_avatar_uuid
Gets the UUID of the avatar
Method get_avatar_uuid
Fetches the avatar UUID request parameter.
Method get_chat_history
Gets a recent history of messages from the chatroom.
Method get_closing_time
Gets the time at which this choice closes.
Method get_controller_id
Fetches the controller ID request parameter.
Method get_controller_id
Gets the identifier for controller (unique among all Sloodle controlers - may be the same as get_id() in some environments
Method get_course_id
Gets the identifier of the course this controller belongs to.
Method get_course_id
Gets the identifier of the course this controller belongs to.
Method get_course_id
Gets the identifier of the course this controller belongs to.
Method get_course_id
Fetches the course ID request parameter.
Method get_course_id
Gets the identifier of the course this controller belongs to.
Method get_course_id
Gets the identifier of the course this controller belongs to.
Method get_course_id
Gets the identifier of the course this controller belongs to.
Method get_course_id
Gets the identifier of the course this controller belongs to.
Method get_course_id
Gets the identifier of the course this controller belongs to.
Method get_course_id
Gets the identifier of the course in the VLE.
Method get_course_module_instance
Get a course module instance for the module specified in the request Uses the ID specified in $module_id.
Method get_course_object
Gets the VLE course object.
Method get_course_record
Gets a database record for the course identified in the request.
Method get_creation_time
Gets the time at which this controller was created.
Method get_creation_time
Gets the time at which this instance was created, or 0 if unknown.
Method get_creation_time
Gets the time at which this instance was created, or 0 if unknown.
Method get_creation_time
Gets the time at which this instance was created, or 0 if unknown.
Method get_creation_time
Gets the time at which this instance was created, or 0 if unknown.
Method get_creation_time
Gets the time at which this instance was created, or 0 if unknown.
Method get_creation_time
Gets the time at which this instance was created, or 0 if unknown.
Method get_creation_time
Gets the time at which this instance was created, or 0 if unknown.
Method get_enrolled_courses
Gets a numeric array of SloodleCourse objects for courses the user is enrolled in.
Method get_field_separator
Gets the field separator.
Method get_full_name
Gets the full name of this course in the VLE.
Method get_full_real_name
Gets the full real name of the user ("firstname lastname")
Method get_id
SloodleController::get_id() in controller.php
Gets the site-wide unique identifier for this module.
Method get_intro
Gets the intro description of this module instance, if available.
Method get_intro
SloodleModule::get_intro() in module_base.php
Gets the intro description of this module instance, if available.
Method get_intro
SloodleModuleDistributor::get_intro() in module_distributor.php
Gets the intro description of this module instance, if available.
Method get_intro
SloodleModuleSloodleObject::get_intro() in module_sloodleobject.php
Gets the intro description of this module instance, if available.
Method get_intro
Gets the intro description of this controller.
Method get_intro
SloodleModuleGlossary::get_intro() in module_glossary.php
Gets the intro description of this module instance, if available.
Method get_intro
Gets the intro description of this module instance, if available.
Method get_intro
Gets the intro description of this module instance, if available.
Method get_latest_public_post
Gets the most recent public post.
Method get_latest_site_post
Gets the most recent public/site level post.
Method get_latest_user_post
Gets the most recent post by a particular user, regardless of visibility.
Method get_layout_entries
Gets all the entries in the named layout.
Method get_layout_names
Gets an array associating layout ID's to names
Method get_line_separator
Gets the line separator.
Method get_loginzone_allocation
Gets the SLurl for the specified user's loginzone alloation
Method get_loginzone_position
Gets the position of the loginzone as a string vector <x,y,z>
Method get_loginzone_region
Gets the region of the loginzone
Method get_loginzone_size
Gets the size of the loginzone as a string vector <x,y,z>
Method get_loginzone_time_updated
Gets the timestamp of the last time the loginzone was updated
Method get_modification_time
Gets the time at which this instance was last modified, or 0 if unknown.
Method get_modification_time
Gets the time at which this instance was last modified, or 0 if unknown.
Method get_modification_time
Gets the time at which this instance was last modified, or 0 if unknown.
Method get_modification_time
Gets the time at which this instance was last modified, or 0 if unknown.
Method get_modification_time
Gets the time at which this instance was last modified, or 0 if unknown.
Method get_modification_time
Gets the time at which this instance was last modified, or 0 if unknown.
Method get_modification_time
Gets the time at which this instance was last modified, or 0 if unknown.
Method get_modification_time
Gets the time at which this controller was last modified.
Method get_module_id
Fetches the module ID request parameter.
Method get_name
SloodleModuleAviLister::get_name() in module_avilister.php
Gets the name of this module instance.
Method get_name
Gets the name of this module instance.
Method get_name
SloodleModuleChoice::get_name() in module_choice.php
Gets the name of this module instance.
Method get_name
SloodleModuleGlossary::get_name() in module_glossary.php
Gets the name of this module instance.
Method get_name
SloodleModuleDistributor::get_name() in module_distributor.php
Gets the name of this module instance.
Method get_name
SloodleModuleSloodleObject::get_name() in module_sloodleobject.php
Gets the name of this module instance.
Method get_name
SloodleModule::get_name() in module_base.php
Gets the name of this module instance.
Method get_name
Gets the name of this module instance.
Method get_name
Gets the name of this controller.
Method get_num_unanswered
Gets the number of people who have not yet answered the choice.
Method get_object
Gets data about an active object.
Method get_objects
SloodleModuleDistributor::get_objects() in module_distributor.php
Gets a list of all objects for this Distributor.
Method get_object_configuration
Gets an array of object configuration settings.
Method get_opening_time
Gets the time at which this choice opens.
Method get_param
Obtains a named HTTP request parameter, optionally requiring it or not
Method get_password
Gets the prim password of this controller.
Method get_password
Fetches the password request parameter.
Method get_post
Gets the identified post.
Method get_request_descriptor
Fetches the request descriptor request parameter.
Method get_server_access_level
Fetches the server access level parameter, if specified.
Method get_short_name
Gets the short name of this course in the VLE.
Method get_staff_courses
Gets a numeric array of SloodleCourse objects for courses the user is Sloodle staff.
Method get_type
Gets the short type name of this instance.
Method get_type
SloodleModuleGlossary::get_type() in module_glossary.php
Gets the short type name of this instance.
Method get_type
SloodleModuleSloodleObject::get_type() in module_sloodleobject.php
Gets the short type name of this instance.
Method get_type
SloodleModuleChoice::get_type() in module_choice.php
Gets the short type name of this instance.
Method get_type
SloodleModule::get_type() in module_base.php
Gets the short type name of this instance.
Method get_type
SloodleModuleDistributor::get_type() in module_distributor.php
Gets the short type name of this instance.
Method get_type
Gets the short type name of this instance.
Method get_type
SloodleModuleAviLister::get_type() in module_avilister.php
Gets the short type name of this instance.
Method get_type_full
Gets the full type name of this instance, according to the current language pack, if available.
Method get_type_full
Gets the full type name of this instance, according to the current language pack, if available.
Method get_type_full
Gets the full type name of this instance, according to the current language pack, if available.
Method get_type_full
Gets the full type name of this instance, according to the current language pack, if available.
Method get_type_full
Gets the full type name of this instance, according to the current language pack, if available.
Method get_type_full
Gets the full type name of this instance, according to the current language pack, if available.
Method get_type_full
Gets the full type name of this instance, according to the current language pack, if available.
Method get_type_full
Gets the full type name of this instance, according to the current language pack, if available.
Method get_username
Gets the user's username
Method get_user_email
Gets the user's email address.
Method get_user_firstname
Gets the first name of the user
Method get_user_id
Gets the unique ID of the VLE user.
Method get_user_lastname
Gets the last name of the user
Method get_user_objects
Gets a list of all user-centric objects authorised for the current avatar.
Method get_x
Gets the X coordinate of the position
Method get_y
Gets the Y coordinate of the position
Method get_z
Gets the Z coordinate of the position
Page general.php
general.php in general.php
h
top
Method has_loginzone_data
Determines whether or not LoginZone data exists for this course.
i
top
Variable $id
SloodleChoiceOption::$id in module_choice.php
The ID of the option (should be unique across the site).
Variable $id
SloodleGlossaryEntry::$id in module_glossary.php
The ID of the entry.
Variable $id
SloodleUserObject::$id in user_object.php
The database record ID of this object's entry.
Variable $id
SloodleBlogPost::$id in module_blog.php
The ID of the message.
Variable $id
SloodleChatMessage::$id in module_chat.php
The ID of the message.
Variable $is_loaded
Indicates whether or not a submission is loaded
Page index.php
index.php in index.php
Method is_available
Determines whether or not this controller is available (i.e. not hidden).
Method is_available
Determines whether or not the course is available.
Method is_avatar_linked
Determines whether or not the current user and avatar are linked.
Method is_avatar_loaded
Determines whether or not an avatar is loaded.
Method is_early
SloodleModuleChoice::is_early() in module_choice.php
Determines if the choice has not opened yet.
Method is_enabled
Determines if this controller is enabled or not.
Method is_enabled
Checks if blogging is enabled on the site.
Method is_enrolled
Is the current user enrolled in the specified course?
Method is_late
SloodleModuleChoice::is_late() in module_choice.php
Determines if the choice has already closed.
Method is_loaded
Determines whether or not this controller is loaded.
Method is_loaded
Determines whether or not course data has been loaded.
Method is_object_request
Checks the parameters to determine if the request relates to an object rather than a user
Method is_open
SloodleModuleChoice::is_open() in module_choice.php
Determines if the choice is currently open.
Method is_request_data_processed
Checks whether or not the request data has already been processed.
Method is_staff
Is the current user Sloodle staff in the specified course?
Method is_too_early
SloodleModuleSloodleObject::is_too_early() in module_sloodleobject.php
Checks if an assignment submitted at the specified time would be too early for submission.
Method is_too_late
SloodleModuleSloodleObject::is_too_late() in module_sloodleobject.php
Checks if an assignment submitted at the specified time would be too late for submission.
Method is_user_loaded
Determines whether or not a VLE user is loaded.
Page io.php
io.php in io.php
l
top
Variable $line_separator
The separation string between lines of the response (typically just a newline).
Page loginzone.php
loginzone.php in loginzone.php
Page layout_profile.php
layout_profile.php in layout_profile.php
Page lib.php
lib.php in lib.php
Method link_avatar
Links the current avatar to the current user.
Method load
SloodleModuleGlossary::load() in module_glossary.php
Loads data from the database.
Method load
SloodleModuleSloodleObject::load() in module_sloodleobject.php
Loads data from the database.
Method load
SloodleModuleChoice::load() in module_choice.php
Loads data from the database.
Method load
SloodleModule::load() in module_base.php
Loads data from the database.
Method load
SloodleModuleChat::load() in module_chat.php
Loads data from the database.
Method load
SloodleModuleDistributor::load() in module_distributor.php
Loads data from the database.
Method load
SloodleCourse::load() in course.php
Reads fresh data into the structure from the database.
Method load
SloodleController::load() in controller.php
Loads data from the database.
Method load_avatar
Finds an avatar with the given UUID and/or name, and loads its data.
Method load_avatar_by_id
Loads the specified avatar from the database.
Method load_by_controller
Loads course and controller data by the unqiue site-wide identifier of a Sloodle controller.
Method load_data
SloodleBlogPost::load_data() in module_blog.php
Loads the data from a post record object.
Method load_linked_avatar
Load the avatar linked to the current user.
Method load_linked_user
Find the VLE user linked to the current avatar.
Method load_module
SloodleSession::load_module() in sloodle_session.php
Constructs and loads the appropriate module part of the session.
Method load_submission
Parses the data from a Submission database record object.
Method load_user
Load the specified user from the database
Method load_user_by_loginzone
Finds the user identified by LoginZone allocation, and loads it into the given user object.
Method login
Internally 'log-in' the current user.
Page linker.php
linker.php in linker.php
Page linker.php
linker.php in linker.php
Page linker.php
linker.php in linker.php
Page linker.php
linker.php in linker.php
Page linker.php
linker.php in linker.php
Page linker.php
linker.php in linker.php
Page linker.php
linker.php in linker.php
Page linker.php
linker.php in linker.php
Page layout_linker.php
layout_linker.php in layout_linker.php
m
top
Variable $maxselections
Maximum allowed number of selections for this option.
Variable $message
SloodleChatMessage::$message in module_chat.php
The text of the message.
Variable $module
SloodleSession::$module in sloodle_session.php
The Sloodle module this session relates to, if any.
Variable $moodle_assignment_instance
Internal only - Moodle assignment module instance database object.
Variable $moodle_chat_instance
Internal only - Moodle chat module instance database object.
Variable $moodle_choice_instance
Internal only - Moodle choice module instance database object.
Variable $moodle_glossary_instance
Internal only - Moodle glossary module instance database object.
Page mail.php
mail.php in mail.php
Page module_avilister.php
module_avilister.php in module_avilister.php
Page module_base.php
module_base.php in module_base.php
Page module_blog.php
module_blog.php in module_blog.php
Page module_chat.php
module_chat.php in module_chat.php
Page module_choice.php
module_choice.php in module_choice.php
Page module_distributor.php
module_distributor.php in module_distributor.php
Page module_glossary.php
module_glossary.php in module_glossary.php
Page module_sloodleobject.php
module_sloodleobject.php in module_sloodleobject.php
Page modules.php
modules.php in modules.php
Page mod_form.php
mod_form.php in mod_form.php
Class mod_sloodle_mod_form
mod_sloodle_mod_form in mod_form.php
Used to define the Sloodle module instance add/edit form.
n
top
Variable $name
SloodleActiveObject::$name in active_object.php
The name of this object.
Variable $name
SloodleLayoutEntry::$name in layout_profile.php
The name of the object this entry represents.
Variable $numselections
Number of selections so far of this option.
Variable $numunanswered
The number of (non-admin) users on the course who have not yet answered this choice.
Variable $num_prims
Number of prims in the object which has been submitted
Page notecard_configuration_form.php
notecard_configuration_form.php in notecard_configuration_form.php
Page notecard_configuration_view.php
notecard_configuration_view.php in notecard_configuration_view.php
o
top
Variable $objname
SloodleUserObject::$objname in user_object.php
The name of this object.
Variable $objuuid
SloodleUserObject::$objuuid in user_object.php
The UUID of this object.
Variable $obj_name
Name of the object which has been submitted.
Variable $options
SloodleModuleChoice::$options in module_choice.php
The options available for this choice, as an associative array of IDs to SloodleChoiceOption objects.
Page object_config_linker.php
object_config_linker.php in object_config_linker.php
Page object_config.php
object_config.php in object_config.php
Page object_config.php
object_config.php in object_config.php
Page object_config.php
object_config.php in object_config.php
Page object_config.php
object_config.php in object_config.php
Page object_config.php
object_config.php in object_config.php
Page object_config.php
object_config.php in object_config.php
Page object_config.php
object_config.php in object_config.php
Page object_config.php
object_config.php in object_config.php
Page object_config.php
object_config.php in object_config.php
Page object_config.php
object_config.php in object_config.php
Page object_config.php
object_config.php in object_config.php
Page object_config.php
object_config.php in object_config.php
Page object_config.php
object_config.php in object_config.php
Method optional_param
Obtains a named HTTP request parameter, or NULL if it has not been provided.
p
top
Variable $page_number
Current page number.
Variable $page_total
Total number of pages.
Variable $password
SloodleActiveObject::$password in active_object.php
The password of this object.
Variable $password
SloodleUserObject::$password in user_object.php
The password of this object.
Variable $position
SloodleLayoutEntry::$position in layout_profile.php
The position of the object, as a 3d vector, in string format "<x,y,z>"
Variable $primdrop_name
Name of the PrimDrop object into which this object was submitted.
Variable $primdrop_pos
Position where this object was submitted (as a vector, "<x,y,z>")
Variable $primdrop_region
Name of the region where this object was submitted
Variable $primdrop_uuid
UUID of the PrimDrop object into which this object was submitted.
Method ping_object
Updates the last active timer on an object.
Method preprocess_submission
Method print_student_answer
Method print_user_files
Method process_request_data
Process all of the standard data provided by the HTTP request, and write it into our SloodleSession object.
Method purge_password_notifications
If the system is waiting to send a password notification to this user, then remove it
q
top
Method quick_output
Quick output of data to avoid several accessor calls if the response is very basic.
r
top
Variable $real_first_name
SloodleAviListName::$real_first_name in module_avilister.php
Real first name
Variable $real_last_name
SloodleAviListName::$real_last_name in module_avilister.php
Real last name
Variable $request
SloodleSession::$request in sloodle_session.php
Incoming HTTP request.
Variable $request_data_processed
Indicates whether or not the basic request data has already been processed.
Variable $request_descriptor
Request descriptor.
Variable $request_timestamp
Timestamp when the request was originally made by the LSL script.
Variable $response
SloodleSession::$response in sloodle_session.php
Outgoing response - can be rendered to HTTP or as a string.
Variable $response_timestamp
Timestamp when the response was generated on the Moodle site.
Variable $rotation
SloodleLayoutEntry::$rotation in layout_profile.php
The rotation of the object, as a 3d vector of Euler angles, in string format "<x,y,z>"
Page regenrol_linker.php
regenrol_linker.php in regenrol_linker.php
Method register_object
Registers a new active object (or renew an existing authorisation) with this controller.
Method register_unauth_object
Registers a new unauthorised object.
Method remove_object
Removes an active object and all its related items.
Method render_to_output
Outputs the response directly to the HTTP response.
Method render_to_string
Renders the response to a string.
Method required_param
Obtains a named HTTP request parameter, or terminates with an error message if it has not been provided.
Method reset_password
Resets the user's password
Method resubmit_allowed
Checks if re-submissions are permitted.
s
top
Variable $side_effects
Integer side effect(s) codes.
Variable $sloodle_controller_instance
Internal only - Sloodle Controller instance database object.
Variable $sloodle_course_data
The Sloodle course data object, if it exists.
Variable $sloodle_distributor_instance
Internal only - Sloodle Distributor instance database object.
Variable $sloodle_module_instance
Internal only - Sloodle module instance database object.
Variable $sloodle_module_instance
Internal only - Sloodle module instance database object.
Variable $status_code
Integer status code of the response.
Variable $status_descriptor
Status descriptor string.
Variable $subject
SloodleBlogPost::$subject in module_blog.php
The subject of the post.
Page store_object_config.php
store_object_config.php in store_object_config.php
Page sloodle.php
sloodle.php in sloodle.php
Page sloodle_session.php
sloodle_session.php in sloodle_session.php
Page sl_welcome_reg.php
sl_welcome_reg.php in sl_welcome_reg.php
Method save_layout
Save the given entries in the named profile.
Method search
SloodleModuleGlossary::search() in module_glossary.php
Searches all entries in the current glossary for the given term.
Method select_option
Selects an option in this choice on behalf of the specified user.
Method send_object
SloodleModuleDistributor::send_object() in module_distributor.php
Request that the specified object be sent to the specified avatar.
Method set
SloodleGlossaryEntry::set() in module_glossary.php
Accessor - set all members in a single call.
Method set
SloodleAviListName::set() in module_avilister.php
Accessor - set all members in a single call.
Method set
SloodleBlogPost::set() in module_blog.php
Accessor - set all members in a single call.
Method set
SloodleChatMessage::set() in module_chat.php
Accessor - set all members in a single call.
Page settings.php
settings.php in settings.php
Method setup_elements
Method set_avatar_last_active
Sets the timestamp of when the user was last active
Method set_avatar_name
Sets the name of the avatar
Method set_avatar_uuid
Accessor function to set member value $avatar_uuid
Method set_avatar_uuid
Sets the UUID of the avatar
Method set_channel
SloodleModuleDistributor::set_channel() in module_distributor.php
Sets the UUID of the XMLRPC channel used for requests.
Method set_data
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_field_separator
Sets the field separator.
Method set_intro
Sets the intro description of this controller.
Method set_line_separator
Sets the line separator.
Method set_loginzone_position
Sets the position of the loginzone as a string vector <x,y,z>
Method set_loginzone_position_xyz
Sets the position of the loginzone as a set of components
Method set_loginzone_region
Sets the region of the loginzone
Method set_loginzone_size
Sets the size of the loginzone as a string vector <x,y,z>
Method set_loginzone_size_xyz
Sets the size of the loginzone as a set of components
Method set_loginzone_time_updated
Sets the timestamp of the last time the loginzone was updated
Method set_name
Sets the name of this controller.
Method set_objects
SloodleModuleDistributor::set_objects() in module_distributor.php
Sets the list of objects in this Distributor
Method set_page_number
Accessor function to set member value $page_number
Method set_page_total
Accessor function to set member value $page_total
Method set_password
Sets the prim password of this controller.
Method set_pos
Sets the position as 3 components.
Method set_position_xyz
Sets the position as separate X,Y,Z components
Method set_request_descriptor
Accessor function to set member value $request_descriptor
Method set_request_timestamp
Accessor function to set member value $request_timestamp
Method set_response_timestamp
Accessor function to set member value $response_timestamp
Method set_rotation_xyz
Sets the rotation as separate X,Y,Z components
Method set_side_effects
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_status_code
Accessor function to set member value $status_code
Method set_status_descriptor
Accessor function to set member value $status_descriptor
Method set_tracking_code
Accessor function to set member value $tracking_code
Class SloodleActiveObject
SloodleActiveObject in active_object.php
An active object, relating to the Sloodle active objects DB table.
Class SloodleAviListName
SloodleAviListName in module_avilister.php
Represents a single avatar list name association
Class SloodleBlogPost
SloodleBlogPost in module_blog.php
Represents a single blog post
Method SloodleChatMessage
Constructor - initialises members.
Class SloodleChatMessage
SloodleChatMessage in module_chat.php
Represents a single chat message
Method SloodleChatMessage
Constructor - initialises members.
Method SloodleChatMessage
Constructor - initialises members.
Class SloodleChoiceOption
SloodleChoiceOption in module_choice.php
Class to represent a single available option for a choice.
Method SloodleController
Constructor
Class SloodleController
SloodleController in controller.php
Represents a Sloodle Controller, including data such as prim password.
Method SloodleCourse
Constructor
Class SloodleCourse
SloodleCourse in course.php
The Sloodle course data class
Class SloodleGlossaryEntry
SloodleGlossaryEntry in module_glossary.php
Represents a single glossary entry
Method SloodleGlossaryEntry
Constructor - initialises members.
Class SloodleLayoutEntry
SloodleLayoutEntry in layout_profile.php
Stores data for a single entry in a layout profile.
Class SloodleModule
SloodleModule in module_base.php
Sloodle module base class.
Method SloodleModule
Constructor - initialises the session variable
Class SloodleModuleAviLister
SloodleModuleAviLister in module_avilister.php
The Sloodle AviLister module class.
Method SloodleModuleAviLister
Constructor
Class SloodleModuleBlog
SloodleModuleBlog in module_blog.php
The Sloodle blog module class.
Method SloodleModuleBlog
Constructor
Method SloodleModuleChat
Constructor
Class SloodleModuleChat
SloodleModuleChat in module_chat.php
The Sloodle chat module class.
Class SloodleModuleChoice
SloodleModuleChoice in module_choice.php
The Sloodle choice module class.
Method SloodleModuleChoice
Constructor
Class SloodleModuleDistributor
SloodleModuleDistributor in module_distributor.php
The Sloodle Distributor module class.
Method SloodleModuleDistributor
Constructor
Class SloodleModuleGlossary
SloodleModuleGlossary in module_glossary.php
The Sloodle glossary module class.
Method SloodleModuleGlossary
Constructor
Class SloodleModuleSloodleObject
SloodleModuleSloodleObject in module_sloodleobject.php
The Sloodle Object assignment module class.
Method SloodleModuleSloodleObject
Constructor
Class SloodleRequest
SloodleRequest in io.php
Handles incoming HTTP requests, typically from LSL if dealing with Second Life.
Method SloodleRequest
Constructor
Method SloodleResponse
Constructor
  • can intialise some variables
Class SloodleResponse
SloodleResponse in io.php
A helper class to validate and structure data for output according to the Sloodle communications specification.
Class SloodleSession
SloodleSession in sloodle_session.php
The primary API class, which manages all other parts.
Method SloodleSession
SloodleSession::SloodleSession() in sloodle_session.php
Constructor - initialises members
Class SloodleUser
SloodleUser in user.php
A class to represent a single user, including Moodle and Sloodle data.
Method SloodleUser
Class constructor.
Class SloodleUserObject
SloodleUserObject in user_object.php
A user-centric object, relating to the Sloodle user objects DB table.
Function sloodle_add_instance
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 general.php
Old logging function
Function sloodle_array_to_vector
Converts an array vector to a string vector.
Function sloodle_autoenrol_enabled_site
Determines whether or not auto-enrolment is allowed for the site.
Function sloodle_autoreg_enabled_site
Determines whether or not auto-registration is allowed for the site.
Constant SLOODLE_BLOG_VISIBILITY_PRIVATE
Blog visibility identifier for private posts. (These can only be viewed by the person who posted them)
Constant SLOODLE_BLOG_VISIBILITY_PUBLIC
Blog visibility identifier for public posts. (These can be viewed by anybody)
Constant SLOODLE_BLOG_VISIBILITY_SITE
SLOODLE_BLOG_VISIBILITY_SITE in module_blog.php
Blog visibility identifier for site posts. (These can be viewed by anybody who is registered on the site)
Function sloodle_check_course_module_instance_type
Determines if the specified course module instance is of the named type.
Function sloodle_cron
sloodle_cron() in lib.php
Function to be run periodically according to the Moodle cron.
Function sloodle_debug
sloodle_debug() in sl_config.php
Outputs messages if in debug mode.
Constant SLOODLE_DEBUG
SLOODLE_DEBUG in sl_config.php
Constant SLOODLE_DEBUG_MODE_PARAM_NAME
The name of the HTTP parameter which can be used to activate Sloodle debug mode.
Function sloodle_delete_instance
Given an ID of an instance of this module, this function will permanently delete the instance and any data that depends on it.
Function sloodle_describe_approx_time
Returns a very approximate natural language description of a period of time (in minutes, hours, days, or weeks).
Constant SLOODLE_DIRROOT
SLOODLE_DIRROOT in sl_config.php
The data path for the root of the Sloodle folder.
Function sloodle_display_config_form
sloodle_display_config_form() in object_config.php
Function sloodle_display_config_form
sloodle_display_config_form() in object_config.php
Function sloodle_display_config_form
sloodle_display_config_form() in object_config.php
Function sloodle_display_config_form
sloodle_display_config_form() in object_config.php
Function sloodle_display_config_form
sloodle_display_config_form() in object_config.php
Function sloodle_display_config_form
sloodle_display_config_form() in object_config.php
Function sloodle_display_config_form
sloodle_display_config_form() in object_config.php
Function sloodle_display_config_form
sloodle_display_config_form() in object_config.php
Function sloodle_finished_login_coordinates
Generates teleport coordinates for a user who has already finished the LoginZone process.
Function sloodle_get_config
sloodle_get_config() in general.php
Gets a Sloodle configuration value from Moodle's "config" table.
Function sloodle_get_course_module_instance
Obtains the identified course module instance database record.
Function sloodle_get_files
sloodle_get_files() in general.php
Gets an array of files within the given directory.
Function sloodle_get_installed_object_types
Gets all object types and versions available in this installation.
Function sloodle_get_module_id
Obtains the ID number of the specified module (type not instance).
Function sloodle_get_participants
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_subdirectories
Gets an array of subdirectories within the given directory.
Function sloodle_get_types
Gets the different sub-types of Sloodle module available as a list for the "Add Activity..." menu.
Function sloodle_get_value
sloodle_get_value() in general.php
Extracts a value from a name-value associative array if it is set.
Function sloodle_get_web_path
sloodle_get_web_path() in general.php
Gets the basic URL of the current web-page being accessed.
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_course_module_instance_visible
Determines whether or not the specified course module instance is visible.
Function sloodle_is_installed
sloodle_is_installed() in general.php
Determines whether or not Sloodle is installed.
Constant SLOODLE_LIBROOT
SLOODLE_LIBROOT in sl_config.php
The data path for the root of the Sloodle library folder.
Constant SLOODLE_LINKER_SCRIPT
SLOODLE_LINKER_SCRIPT in check_user_auth_linker.php
Lets Sloodle know we are in a linker script.
Constant SLOODLE_LINKER_SCRIPT
SLOODLE_LINKER_SCRIPT in active_object_ping_linker.php
Lets Sloodle know we are in a linker script.
Constant SLOODLE_LINKER_SCRIPT
SLOODLE_LINKER_SCRIPT in linker.php
Lets Sloodle know we are in a linker script.
Constant SLOODLE_LINKER_SCRIPT
SLOODLE_LINKER_SCRIPT in linker.php
Lets Sloodle know we are in a linker script.
Constant SLOODLE_LINKER_SCRIPT
SLOODLE_LINKER_SCRIPT in layout_linker.php
Lets Sloodle know we are in a linker script.
Constant SLOODLE_LINKER_SCRIPT
SLOODLE_LINKER_SCRIPT in regenrol_linker.php
Lets Sloodle know we are in a linker script.
Constant SLOODLE_LINKER_SCRIPT
SLOODLE_LINKER_SCRIPT in linker.php
Lets Sloodle know we are in a linker script.
Constant SLOODLE_LINKER_SCRIPT
SLOODLE_LINKER_SCRIPT in linker.php
Lets Sloodle know we are in a linker script.
Constant SLOODLE_LINKER_SCRIPT
SLOODLE_LINKER_SCRIPT in linker.php
Lets Sloodle know we are in a linker script.
Constant SLOODLE_LINKER_SCRIPT
SLOODLE_LINKER_SCRIPT in linker.php
Lets Sloodle know we are in a linker script.
Constant SLOODLE_LINKER_SCRIPT
SLOODLE_LINKER_SCRIPT in linker.php
Lets Sloodle know we are in a linker script.
Function sloodle_load_module
sloodle_load_module() in modules.php
Constructs a appropriate Sloodle module object based on the named type.
Function sloodle_login_notification
Stores a pending login notification for an auto-registered user.
Function sloodle_login_zone_bounds
Calculates the maximum and minimum bounds of the specified LoginZone Returns the bounds as a numeric array of two associate array vectors: ($max, $min).
Constant SLOODLE_OBJECT_ACCESS_LEVEL_GROUP
Indicates that only in-world group-members may access an object in-world.
Constant SLOODLE_OBJECT_ACCESS_LEVEL_OWNER
Indicates that only the owner may access an object in-world.
Constant SLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC
Indicates that anybody may access an object in-world.
Constant SLOODLE_PARAM_AVATAR_NAME
Defines the HTTP parameter name for an avatar name.
Constant SLOODLE_PARAM_AVATAR_UUID
Defines the HTTP parameter name for an avatar UUID.
Constant SLOODLE_PARAM_CONTROLLER_ID
Defines the HTTP parameter name for a Sloodle controller ID.
Constant SLOODLE_PARAM_COURSE_ID
Defines the HTTP parameter name for a course ID.
Constant SLOODLE_PARAM_IS_OBJECT
Defines the HTTP parameter name for indicating a request which relates to an object instead of a user.
Constant SLOODLE_PARAM_MODULE_ID
Defines the HTTP parameter name for a module ID.
Constant SLOODLE_PARAM_PASSWORD
Defines the HTTP parameter name for a Sloodle password.
Constant SLOODLE_PARAM_REQUEST_DESC
Defines the HTTP parameter name for a request descriptor.
Constant SLOODLE_PARAM_SERVER_ACCESS_LEVEL
Defines the HTTP parameter name for specifying server access level.
Function sloodle_parse_object_identifier
Extracts the object name and version number from an object identifier.
Function sloodle_position_is_in_login_zone
Checks if the specified position is in the current (site-wide) loginzone.
Function sloodle_print_access_level_options
Outputs the standard form elements for access levels in object configuration.
Function sloodle_print_recent_activity
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_login_notifications
Processes pending login notifications, up to a certain limit.
Function sloodle_process_options
Processes the module configuration options prior to saving them.
Function sloodle_random_position_in_zone
Generates a random position within a cuboid zone of the specified size.
Function sloodle_random_prim_password
Generates a random prim password (7 to 9 digit number).
Function sloodle_random_security_token
Generates a random login security token.
Function sloodle_random_web_password
Generates a random web password Uses mixed-case letters and numbers to generate a random 8-character string.
Function sloodle_required_param
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 general.php
Rounds the specified 3d vector integer values.
Function sloodle_scale_used
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_login_notification
Send a login notification.
Function sloodle_send_xmlrpc_message
Sends an XMLRPC message into Second Life.
Constant SLOODLE_SERVER_ACCESS_LEVEL_COURSE
Indicates that only those registered and enrolled in a specific course may access a server resource.
Constant SLOODLE_SERVER_ACCESS_LEVEL_PUBLIC
Indicates that anybody may access a server resource (still requires an authenticated request).
Constant SLOODLE_SERVER_ACCESS_LEVEL_SITE
Indicates that only those registered on the site may access a server resource.
Constant SLOODLE_SERVER_ACCESS_LEVEL_STAFF
Indicates that only those with Sloodle staff status on a course may access a server resource.
Function sloodle_set_config
sloodle_set_config() in general.php
Sets a Sloodle configuration value.
Function sloodle_text_email
Send an email to a specific address, using the Moodle system.
Function sloodle_text_email_sl
Send an email to an object in SL.
Constant SLOODLE_TYPE_CTRL
SLOODLE_TYPE_CTRL in sl_config.php
Constant SLOODLE_TYPE_DISTRIB
SLOODLE_TYPE_DISTRIB in sl_config.php
Function sloodle_update_instance
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
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
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_prim_password
Checks if the given prim password is valid.
Function sloodle_validate_prim_password_verbose
Checks if the given prim password is valid, and provides feedback.
Function sloodle_vector_to_array
Converts a string vector to an array vector.
Constant SLOODLE_VERSION
SLOODLE_VERSION in sl_config.php
The Sloodle version number.
Function sloodle_view_controller
sloodle_view_controller() in view_controller.php
Displays information about the given Sloodle module.
Function sloodle_view_distributor
sloodle_view_distributor() in view_distributor.php
Displays information about the given Sloodle Distributor.
Constant SLOODLE_WWWROOT
SLOODLE_WWWROOT in sl_config.php
The path for browsing to the root of the Sloodle folder.
Page sl_config.php
sl_config.php in sl_config.php
Method submit
SloodleModuleSloodleObject::submit() in module_sloodleobject.php
Add a new submission (or replace an existing one).
t
top
Variable $text
SloodleChoiceOption::$text in module_choice.php
The text of this option.
Variable $timemodified
Timestamp of when this option was last modified.
Variable $timestamp
Timestamp of the message.
Variable $timestamp_created
Timestamp of when this message was created.
Variable $timestamp_modified
Timestamp of when this message was last modified.
Variable $timeupdated
Timestamp for when this object was last used.
Variable $tracking_code
Tracking code of the request.
Variable $type
SloodleActiveObject::$type in active_object.php
The type of this object.
Method text_summary
Construct a text summary of this submission.
u
top
Variable $user
SloodleChatMessage::$user in module_chat.php
The user who wrote this message.
Variable $user
SloodleActiveObject::$user in active_object.php
The user who authorised this object.
Variable $user
SloodleSession::$user in sloodle_session.php
Current user information.
Variable $user
SloodleBlogPost::$user in module_blog.php
The user who wrote this message.
Variable $user_data
Internal only - user data. (i.e. VLE user) In Moodle, corresponds to a record from the 'user' table.
Variable $uuid
SloodleActiveObject::$uuid in active_object.php
The UUID of this object.
Page user.php
user.php in user.php
Page user_object.php
user_object.php in user_object.php
Page user_object_auth.php
user_object_auth.php in user_object_auth.php
Page user_object_linker.php
user_object_linker.php in user_object_linker.php
Method update_object_type
Updates the type of a given active object to the specified type.
Method update_submission
Update the submission with the provided data.
Method user_can_submit
Checks if the specified user is permitted to submit to this assignment.
Method user_can_view
Checks if the specified user is permitted to view submissions to this assignment.
Method user_can_write
Checks if the currently logged-in user has permission to create blog entries.
Method user_has_submitted
Checks if the specified user has submitted to this assignment already.
v
top
Variable $visibility
SloodleBlogPost::$visibility in module_blog.php
The visibility of this post.
Method validate_avatar
SloodleSession::validate_avatar() in sloodle_session.php
Validate the avatar specified in the request, to ensure it is registered to a Moodle account.
Method validate_user
SloodleSession::validate_user() in sloodle_session.php
Validates the user account and enrolment (ensures there is an avatar linked to a VLE account, and that the VLE account is enrolled in the current course).
Method validation
Validates the form data.
Page version.php
version.php in version.php
Page version_linker.php
version_linker.php in version_linker.php
Method view
assignment_sloodleobject::view() in assignment.class.php
Page view_controller.php
view_controller.php in view_controller.php
Page view_course.php
view_course.php in view_course.php
Page view_distributor.php
view_distributor.php in view_distributor.php
Page view_user.php
view_user.php in view_user.php
Page view_users.php
view_users.php in view_users.php
Page view.php
view.php in view.php
Method view_dates
w
top
Method write
SloodleController::write() in controller.php
Updates the currently loaded entry in the database.
Method write
Writes current Sloodle course data back to the database.
Method write_avatar
Uses the current avatar data to update the database.
_
top
Variable $_session
SloodleModule::$_session in module_base.php
Reference to the containing SloodleSession object.
Variable $_session
Reference to the containing SloodleSession object.
Variable $_session
Internal only - reference to the containing SloodleSession object.
Method _internal_validation_error
Internal function to report a data validation error.
a b c d e f g h i l m n o p q r s t u v w _