[sloodle] element index

Package indexes

All elements

top

$_session: SloodleRequest::$_session in io.php

Reference to the containing SloodleSession object.
$_session: SloodleUser::$_session in user.php

Internal only - reference to the containing SloodleSession object.
$_session: SloodleModule::$_session in module_base.php

Reference to the containing SloodleSession object.
$_session: sloodle_view_presenter::$_session in presenter.php

A SLOODLE session object to give us access to plugins and other functionality.
$_session: SloodlePluginManager::$_session in plugins.php

Internal only - reference to the containing SloodleSession object.
_base.php: _base.php in _base.php
_base.php: _base.php in _base.php
_import_ImageMagick: SloodlePluginPresenterPDFImporter::_import_ImageMagick() in pdfimporter.php

Imports the given file using the ImageMagick command line programs if possible. (Internal only)
_import_MagickWand: SloodlePluginPresenterPDFImporter::_import_MagickWand() in pdfimporter.php

Imports the given file using the MagickWand extension if possible. (Internal only)
_internal_validation_error: SloodleResponse::_internal_validation_error() in io.php

Internal function to report a data validation error.

top

$assignment: SloodleModuleSloodleObject::$assignment in module_sloodleobject.php

Internal only - the Moodle assignment structure.
$authorized: SloodleUserObject::$authorized in user_object.php

Indicates whether or not this object is currently authorized.
$avatarList: sloodleCourseObj::$avatarList in sloodlecourseobject.php
$avatar_data: SloodleUser::$avatar_data in user.php

Internal only - avatar data.
$avatar_name: SloodleAviListName::$avatar_name in module_avilister.php

Avatar name ("firstname lastname")
$avatar_uuid: SloodleResponse::$avatar_uuid in io.php

Avatar UUID.
$avuuid: SloodleUserObject::$avuuid in user_object.php

The UUID of the object's user
addCommas: sloodle_view_ibank::addCommas() in ibank.php

addCommas takes an array of strings and add commas between elements except at the last element, or if there is only one element
add_data_line: SloodleResponse::add_data_line() in io.php

Adds one line of data to the $data member
add_entry: SloodleModulePresenter::add_entry() in module_presenter.php

Adds a new entry to the presentation.
add_entry: SloodleModuleBlog::add_entry() in module_blog.php

Attempts to write a new blog entry to the database, attributed to the user currently loaded in the SloodleSession.
add_entry: SloodleLayout::add_entry() in layout_profile.php
add_linked_avatar: SloodleUser::add_linked_avatar() in user.php

Adds a new avatar to the database, and link it to the specified user.
add_location: SloodleModuleMap::add_location() in module_map.php

Adds a new location to this map.
add_message: SloodleModuleChat::add_message() in module_chat.php

Adds a new chat message.
add_pending_avatar: SloodleUser::add_pending_avatar() in user.php

Adds a new unlinked avatar to the database (the entry is pending linking)
add_side_effect: SloodleResponse::add_side_effect() in io.php

Adds a single side effect code to member $status_code
add_side_effects: SloodleResponse::add_side_effects() in io.php

Adds one or more integer side effect codes to member $status_code.
add_user_object: SloodleUser::add_user_object() in user.php

Adds or udpates the given user object as unauthorised.
allow_update: SloodleModuleChoice::allow_update() in module_choice.php

Checks if users are allowed to re-select their answer in this choice.
authenticate_request: SloodleSession::authenticate_request() in sloodle_session.php

Verifies security for the incoming request (but does not check user access).
authenticate_user_request: SloodleSession::authenticate_user_request() in sloodle_session.php

Verifies security for the incoming user-centric request.
authorise_object: SloodleController::authorise_object() in controller.php

Authorises an otherwise unauthorised active object against the given user and the current controller.
authorise_user_object: SloodleUser::authorise_user_object() in user.php

Authorises the given object for the current avatar.
autoregister_avatar_user: SloodleUser::autoregister_avatar_user() in user.php

Auto-register a new user account for the current avatar.
access.php: access.php in access.php
active_object.php: active_object.php in active_object.php
avilister_linker.php: avilister_linker.php in avilister_linker.php

top

$body: SloodleBlogPost::$body in module_blog.php

The body of the post.
buildAvTable: sloodle_view_ibank::buildAvTable() in ibank.php

Simply sets up the inner avatar table, alignment, and sizes
blog_linker.php: blog_linker.php in blog_linker.php
base_view.php: base_view.php in base_view.php
base_view_module.php: base_view_module.php in base_view_module.php

top

$canedit: sloodle_view_user::$canedit in user.php

Can the user edit the data they are viewing?
$canedit: sloodle_base_view_module::$canedit in base_view_module.php

Indicates whether or the user can edit (or 'manage') this module, according to the VLE permissions.
$cm: SloodleController::$cm in controller.php

Internal for Moodle only - course module instance.
$cm: SloodleModuleGlossary::$cm in module_glossary.php

Internal for Moodle only - course module instance.
$cm: SloodleModuleDistributor::$cm in module_distributor.php

Internal for Moodle only - course module instance.
$cm: SloodleModuleChat::$cm in module_chat.php

Internal for Moodle only - course module instance.
$cm: SloodleModuleiBank::$cm in module_ibank.php

Internal for Moodle only - course module instance.
$cm: SloodleModuleChoice::$cm in module_choice.php

Internal for Moodle only - course module instance.
$cm: SloodleModuleMap::$cm in module_map.php

Internal for Moodle only - course module instance.
$cm: sloodleCourseObj::$cm in sloodlecourseobject.php
$cm: SloodleModuleSloodleObject::$cm in module_sloodleobject.php

Internal for Moodle only - course module instance.
$cm: sloodle_view_ibank::$cm in ibank.php

The course module instance, retrieved directly from the database (table: course_modules)
$cm: SloodleModulePresenter::$cm in module_presenter.php

Internal for Moodle only - course module instance.
$cm: sloodle_base_view_module::$cm in base_view_module.php

The course module instance, retrieved directly from the database (table: course_modules)
$concept: SloodleGlossaryEntry::$concept in module_glossary.php

The name of this entry.
$configs: SloodleLayoutEntry::$configs in layout_profile.php
$controller: sloodle_view_controller::$controller in controller.php

SLOODLE Controller data object, retreived directly from the database (table: sloodle_controller).
$controller: SloodleCourse::$controller in course.php

The SloodleController object being used to access this course, if available.
$course: sloodle_view_ibank::$course in ibank.php

The VLE course object, retrieved directly from the database (table: course)
$course: sloodle_base_view_module::$course in base_view_module.php

The VLE course object, retrieved directly from the database (table: course)
$course: SloodleActiveObject::$course in active_object.php

The course/controller which this object is authorised for.
$course: sloodle_view_user::$course in user.php

The VLE course object, retrieved directly from database.
$course: SloodleSession::$course in sloodle_session.php

The Sloodle course structure for the course this session is accessing
$course: sloodle_view_course::$course in course.php

The VLE course object, retrieved directly from database.
$course: sloodle_view_users::$course in users.php

The VLE course object, retrieved directly from database.
$courseContext: sloodleCourseObj::$courseContext in sloodlecourseobject.php
$coursefullname: sloodle_view_users::$coursefullname in users.php

Full name of the current course.
$courseFullName: sloodleCourseObj::$courseFullName in sloodlecourseobject.php

Full name of the current course.
$courseid: SloodleLayout::$courseid in layout_profile.php
$courseId: sloodleCourseObj::$courseId in sloodlecourseobject.php
$courseid: sloodle_view_user::$courseid in user.php

Integer ID of the course which is being accessed.
$courseid: sloodle_view_users::$courseid in users.php

Integer ID of the course which is being accessed.
$courseRec: sloodleCourseObj::$courseRec in sloodlecourseobject.php
$courseshortname: sloodle_view_users::$courseshortname in users.php

Short name of the current course.
$courseShortName: sloodleCourseObj::$courseShortName in sloodlecourseobject.php

Short name of the current course.
$courseUrl: sloodleCourseObj::$courseUrl in sloodlecourseobject.php

URL for accessing the current course.
$courseurl: sloodle_view_users::$courseurl in users.php

URL for accessing the current course.
$course_context: sloodle_view_user::$course_context in user.php

Moodle permissions context for the current course.
$course_context: sloodle_view_ibank::$course_context in ibank.php

Context object for permissions in the Moodle course.
$course_context: sloodle_base_view_module::$course_context in base_view_module.php

Context object for permissions in the Moodle course.
$course_context: sloodle_view_users::$course_context in users.php

Moodle permissions context for the current course.
$course_context: sloodle_view_course::$course_context in course.php

Course context for Moodle permissions.
$course_object: SloodleCourse::$course_object in course.php

The database object of the course to which this object relates.
can_show_results: SloodleModuleChoice::can_show_results() in module_choice.php

Checks if results are to be shown.
can_user_authorise_objects: SloodleCourse::can_user_authorise_objects() in course.php

Checks whether or not the CURRENTLY LOGGED-IN user can authorise objects on this course.
check_allow_drag: SloodleModuleMap::check_allow_drag() in module_map.php

Checks if map dragging should be enabled.
check_authorisation: SloodleController::check_authorisation() in controller.php

Checks if the specified object is authorised for this controller with the given password.
check_autoenrol: SloodleCourse::check_autoenrol() in course.php

Is auto enrolment permitted on this site AND course? Takes into account the site-wide setting as well.
check_autoreg: SloodleCourse::check_autoreg() in course.php

Is auto registration permitted on this site AND course? Takes into account the site-wide setting as well.
check_pan_controls: SloodleModuleMap::check_pan_controls() in module_map.php

Checks if the pan controls should be visible.
check_permission: sloodle_base_view::check_permission() in base_view.php

Check that the user has permission to access the current resources.
check_permission: sloodle_base_view_module::check_permission() in base_view_module.php

Check that the user has permission to view this module, and check if they can edit it too.
check_permission: sloodle_view_ibank::check_permission() in ibank.php

Check that the user has permission to view this module, and check if they can edit it too.
check_permission: sloodle_view_user::check_permission() in user.php

Check that the user is logged-in and has permission to alter course settings.
check_permission: sloodle_view_users::check_permission() in users.php

Check that the user is logged-in and has permission to alter course settings.
check_permission: sloodle_view_course::check_permission() in course.php

Check that the user is logged-in and has permission to alter course settings.
check_zoom_controls: SloodleModuleMap::check_zoom_controls() in module_map.php

Checks if the zoom controls should be visible.
clear_data: SloodleResponse::clear_data() in io.php

Clears all data from member $data
configure_object_from_layout_entry: SloodleController::configure_object_from_layout_entry() in controller.php

Configures a registered object based on the defaults for its layout entry id
configure_object_from_parent: SloodleController::configure_object_from_parent() in controller.php
controller.php: controller.php in controller.php
course.php: course.php in course.php
check.php: check.php in check.php
check_user_auth_linker.php: check_user_auth_linker.php in check_user_auth_linker.php
controller.php: controller.php in controller.php
course.php: course.php in course.php

top

$data: SloodleResponse::$data in io.php

Data to render following the status line in the response.
$definition: SloodleGlossaryEntry::$definition in module_glossary.php

The definition of this entry.
$deletesloodleentry: sloodle_view_user::$deletesloodleentry in user.php

Integer ID of a SLOODLE user entry to delete, where supplied by request parameter.
$deleteuserobjects: sloodle_view_user::$deleteuserobjects in user.php

List of user objects to be deleted (stored as a string, retrieved from request parameters).
$distributor: sloodle_view_distributor::$distributor in distributor.php

SLOODLE data about a Distributor, retrieved directly from the database (table: sloodle_distributor)
data_preprocessing: mod_sloodle_mod_form::data_preprocessing() in mod_form.php

Pre-processes form initial values.
DEFAULT_CENTER_X: DEFAULT_CENTER_X in view_layout.php
DEFAULT_CENTER_Y: DEFAULT_CENTER_Y in view_layout.php
DEFAULT_SPACING_X: DEFAULT_SPACING_X in view_layout.php
DEFAULT_SPACING_Y: DEFAULT_SPACING_Y in view_layout.php
definition: mod_sloodle_mod_form::definition() in mod_form.php

Defines the form
definition_after_data: mod_sloodle_mod_form::definition_after_data() in mod_form.php

Performs extra processing on the form after existing/default data has been specified.
delete: SloodleLayoutEntry::delete() in layout_profile.php
delete_avatar: SloodleUser::delete_avatar() in user.php

Deletes the current avatar from the database.
delete_configs: SloodleLayoutEntry::delete_configs() in layout_profile.php
delete_entry: SloodleModulePresenter::delete_entry() in module_presenter.php

Deletes the identified entry by ID.
delete_layout: SloodleCourse::delete_layout() in course.php

Deletes the named layout.
delete_loginzone_allocation: SloodleCourse::delete_loginzone_allocation() in course.php

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.
delete_user_object: SloodleUser::delete_user_object() in user.php

Deletes a user-centric object by UUID.
destroy: sloodle_view_ibank::destroy() in ibank.php
disable: SloodleController::disable() in controller.php

Disables this controller
disable_autoenrol: SloodleCourse::disable_autoenrol() in course.php

Disables auto-enrolment for this course.
disable_autoreg: SloodleCourse::disable_autoreg() in course.php

Disables auto-registration for this course.
distributor.php: distributor.php in distributor.php

top

$entries: SloodleLayout::$entries in layout_profile.php
edit_entry: SloodleModulePresenter::edit_entry() in module_presenter.php

Edits an existing entry in the presentation.
enable: SloodleController::enable() in controller.php

Enables this controller
enable_autoenrol: SloodleCourse::enable_autoenrol() in course.php

Enables auto-enrolment for this course.
enable_autoreg: SloodleCourse::enable_autoreg() in course.php

Enables auto-registration for this course.
enrol: SloodleUser::enrol() in user.php

Enrols the current user in the specified course

top

$feedback: sloodle_view_presenter::$feedback in presenter.php

Stores an optional feedback string which we may pick up from session data.
$field_separator: SloodleResponse::$field_separator in io.php

The separation string between fields of a response line (by default, a pipe character |).
find_real_name: SloodleModuleAviLister::find_real_name() in module_avilister.php

Fetch the real name to match the given avatar.
find_real_names: SloodleModuleAviLister::find_real_names() in module_avilister.php

Lookup the realnames for all the given avatar names.
find_real_names_course: SloodleModuleAviLister::find_real_names_course() in module_avilister.php

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

top

generate_loginzone_allocation: SloodleCourse::generate_loginzone_allocation() in course.php

Generates a new LoginZone allocation for the specified user.
getAvatarDebits: iPointBank::getAvatarDebits() in ipointbank_object.php

This function will search through all the transactions for this stipend based on avatar uuid and return the TOTAL debits amount
getAvatarList: sloodleCourseObj::getAvatarList() in sloodlecourseobject.php
geticurrency: stipendGiverObject::geticurrency() in stipendgiver_object.php
getRenderMessage: sloodle_view_ibank::getRenderMessage() in ibank.php
getSloodleId: iPointBank::getSloodleId() in ipointbank_object.php
getSloodleId: stipendGiverObject::getSloodleId() in stipendgiver_object.php
getSloodleId: sloodleCourseObj::getSloodleId() in sloodlecourseobject.php
getStartingBalance: stipendGiverObject::getStartingBalance() in stipendgiver_object.php
getStipendBudget: stipendGiverObject::getStipendBudget() in stipendgiver_object.php
getStipendRec: stipendGiverObject::getStipendRec() in stipendgiver_object.php
getTransactionRecords: iPointBank::getTransactionRecords() in ipointbank_object.php
getUserDebits: iPointBank::getUserDebits() in ipointbank_object.php

This function will search through all the transactions and return TOTAL debits for this course user
getUserList: sloodleCourseObj::getUserList() in sloodlecourseobject.php
get_absolute_url: SloodlePluginPresenterSlideImage::get_absolute_url() in image.php

Construct an absolute URL, based on the given source data.
get_absolute_url: SloodlePluginPresenterSlideVideo::get_absolute_url() in video.php

Construct an absolute URL, based on the given source data.
get_absolute_url: SloodlePluginPresenterSlideWeb::get_absolute_url() in web.php

Construct an absolute URL, based on the given source data.
get_amount: SloodleModuleiBank::get_amount() in module_ibank.php
get_authorizing_user: SloodleController::get_authorizing_user() in controller.php

Gets the ID of the user who authorised the specified object.
get_autoenrol: SloodleCourse::get_autoenrol() in course.php

Gets the auto enrolment value for this course only.
get_autoreg: SloodleCourse::get_autoreg() in course.php

Gets the autoregistration value for this course only.
get_avatars: sloodleCourseObj::get_avatars() in sloodlecourseobject.php
get_avatar_id: SloodleUser::get_avatar_id() in user.php

Gets the unique ID of the avatar.
get_avatar_last_active: SloodleUser::get_avatar_last_active() in user.php

Gets the timestamp of whenever the avatar was last active
get_avatar_name: SloodleUser::get_avatar_name() in user.php

Gets the name of the avatar
get_avatar_name: SloodleRequest::get_avatar_name() in io.php

Fetches the avatar name request parameter.
get_avatar_uuid: SloodleUser::get_avatar_uuid() in user.php

Gets the UUID of the avatar
get_avatar_uuid: SloodleRequest::get_avatar_uuid() in io.php

Fetches the avatar UUID request parameter.
get_chat_history: SloodleModuleChat::get_chat_history() in module_chat.php

Gets a recent history of messages from the chatroom.
get_class_list: SloodleModuleiBank::get_class_list() in module_ibank.php

Gets a list of students in the class
get_closing_time: SloodleModuleChoice::get_closing_time() in module_choice.php

Gets the time at which this choice closes.
get_controller_id: SloodleController::get_controller_id() in controller.php

Gets the identifier for controller (unique among all Sloodle controlers - may be the same as get_id() in some environments
get_controller_id: SloodleRequest::get_controller_id() in io.php

Fetches the controller ID request parameter.
get_course: SloodleLayout::get_course() in layout_profile.php
get_course_id: SloodleModule::get_course_id() in module_base.php

Gets the identifier of the course this controller belongs to.
get_course_id: SloodleCourse::get_course_id() in course.php

Gets the identifier of the course in the VLE.
get_course_id: SloodleModuleChoice::get_course_id() in module_choice.php

Gets the identifier of the course this controller belongs to.
get_course_id: SloodleModuleBlog::get_course_id() in module_blog.php

Gets the identifier of the course this controller belongs to.
get_course_id: SloodleModuleiBank::get_course_id() in module_ibank.php

Gets the identifier of the course this controller belongs to.
get_course_id: SloodleModuleDistributor::get_course_id() in module_distributor.php

Gets the identifier of the course this controller belongs to.
get_course_id: SloodleModuleSloodleObject::get_course_id() in module_sloodleobject.php

Gets the identifier of the course this controller belongs to.
get_course_id: SloodleModuleGlossary::get_course_id() in module_glossary.php

Gets the identifier of the course this controller belongs to.
get_course_id: SloodleController::get_course_id() in controller.php

Gets the identifier of the course this controller belongs to.
get_course_id: SloodleModuleMap::get_course_id() in module_map.php

Gets the identifier of the course this controller belongs to.
get_course_id: SloodleRequest::get_course_id() in io.php

Fetches the course ID request parameter.
get_course_id: SloodleModulePresenter::get_course_id() in module_presenter.php

Gets the identifier of the course this controller belongs to.
get_course_id: SloodleModuleChat::get_course_id() in module_chat.php

Gets the identifier of the course this controller belongs to.
get_course_module_instance: SloodleRequest::get_course_module_instance() in io.php

Get a course module instance for the module specified in the request Uses the ID specified in $module_id.
get_course_object: SloodleCourse::get_course_object() in course.php

Gets the VLE course object.
get_course_record: SloodleRequest::get_course_record() in io.php

Gets a database record for the course identified in the request.
get_creation_time: SloodleModuleiBank::get_creation_time() in module_ibank.php

Gets the time at which this instance was created, or 0 if unknown.
get_creation_time: SloodleModulePresenter::get_creation_time() in module_presenter.php

Gets the time at which this instance was created, or 0 if unknown.
get_creation_time: SloodleModuleSloodleObject::get_creation_time() in module_sloodleobject.php

Gets the time at which this instance was created, or 0 if unknown.
get_creation_time: SloodleModuleDistributor::get_creation_time() in module_distributor.php

Gets the time at which this instance was created, or 0 if unknown.
get_creation_time: SloodleModuleBlog::get_creation_time() in module_blog.php

Gets the time at which this instance was created, or 0 if unknown.
get_creation_time: SloodleController::get_creation_time() in controller.php

Gets the time at which this controller was created.
get_creation_time: SloodleModuleChat::get_creation_time() in module_chat.php

Gets the time at which this instance was created, or 0 if unknown.
get_creation_time: SloodleModuleChoice::get_creation_time() in module_choice.php

Gets the time at which this instance was created, or 0 if unknown.
get_creation_time: SloodleModuleGlossary::get_creation_time() in module_glossary.php

Gets the time at which this instance was created, or 0 if unknown.
get_creation_time: SloodleModuleMap::get_creation_time() in module_map.php

Gets the time at which this instance was created, or 0 if unknown.
get_creation_time: SloodleModule::get_creation_time() in module_base.php

Gets the time at which this instance was created, or 0 if unknown.
get_enrolled_courses: SloodleUser::get_enrolled_courses() in user.php

Gets a numeric array of SloodleCourse objects for courses the user is enrolled in.
get_entries: SloodleLayout::get_entries() in layout_profile.php
get_entry_urls: SloodleModulePresenter::get_entry_urls() in module_presenter.php

Gets an array of absolute URLs to images in this slideshow, all correctly ordered.
get_field_separator: SloodleResponse::get_field_separator() in io.php

Gets the field separator.
get_frame_height: SloodleModulePresenter::get_frame_height() in module_presenter.php

Gets the height of the Presenter frame (for viewing in Moodle).
get_frame_width: SloodleModulePresenter::get_frame_width() in module_presenter.php

Gets the width of the Presenter frame (for viewing in Moodle).
get_full_name: SloodleCourse::get_full_name() in course.php

Gets the full name of this course in the VLE.
get_full_real_name: SloodleAviListName::get_full_real_name() in module_avilister.php

Gets the full real name of the user ("firstname lastname")
get_id: SloodlePluginBase::get_id() in _base.php

Gets the identifier of this plugin.
get_id: SloodleController::get_id() in controller.php

Gets the site-wide unique identifier for this module.
get_initial_coordinates: SloodleModuleMap::get_initial_coordinates() in module_map.php

Gets the initial coordinates of the map.
get_initial_zoom: SloodleModuleMap::get_initial_zoom() in module_map.php

Gets the initial zoom factor of the map (1 - 6).
get_intro: SloodleModuleChat::get_intro() in module_chat.php

Gets the intro description of this module instance, if available.
get_intro: SloodleModuleiBank::get_intro() in module_ibank.php

Gets the intro description of this module instance, if available.
get_intro: SloodleModuleChoice::get_intro() in module_choice.php

Gets the intro description of this module instance, if available.
get_intro: SloodleModuleDistributor::get_intro() in module_distributor.php

Gets the intro description of this module instance, if available.
get_intro: SloodleModuleMap::get_intro() in module_map.php

Gets the intro description of this module instance, if available.
get_intro: SloodleModulePresenter::get_intro() in module_presenter.php

Gets the intro description of this module instance, if available.
get_intro: SloodleModuleGlossary::get_intro() in module_glossary.php

Gets the intro description of this module instance, if available.
get_intro: SloodleModuleSloodleObject::get_intro() in module_sloodleobject.php

Gets the intro description of this module instance, if available.
get_intro: SloodleModule::get_intro() in module_base.php

Gets the intro description of this module instance, if available.
get_intro: SloodleController::get_intro() in controller.php

Gets the intro description of this controller.
get_intro: SloodleModuleBlog::get_intro() in module_blog.php

Gets the intro description of this module instance, if available.
get_latest_public_post: SloodleModuleBlog::get_latest_public_post() in module_blog.php

Gets the most recent public post.
get_latest_site_post: SloodleModuleBlog::get_latest_site_post() in module_blog.php

Gets the most recent public/site level post.
get_latest_user_post: SloodleModuleBlog::get_latest_user_post() in module_blog.php

Gets the most recent post by a particular user, regardless of visibility.
get_layout: SloodleLayoutEntry::get_layout() in layout_profile.php
get_layout: SloodleCourse::get_layout() in course.php
get_layouts: SloodleCourse::get_layouts() in course.php

Gets SloodleLayout objects for all the layouts in the course.
get_layout_entries: SloodleCourse::get_layout_entries() in course.php

Gets all the entries in the named layout.
get_layout_entries_for_layout_id: SloodleCourse::get_layout_entries_for_layout_id() in course.php

Gets all the entries in the named layout.
get_layout_entry_configs: SloodleLayoutEntry::get_layout_entry_configs() in layout_profile.php

Return an array of layout_entry_config objects
get_layout_entry_configs_as_hidden_fields: SloodleLayoutEntry::get_layout_entry_configs_as_hidden_fields() in layout_profile.php
get_layout_entry_configs_as_name_value_hash: SloodleLayoutEntry::get_layout_entry_configs_as_name_value_hash() in layout_profile.php
get_layout_names: SloodleCourse::get_layout_names() in course.php

Gets an array associating layout ID's to names
get_line_separator: SloodleResponse::get_line_separator() in io.php

Gets the line separator.
get_locations: SloodleModuleMap::get_locations() in module_map.php

Returns a numeric array of locations associated with this map. Sorted by name.
get_loginzone_allocation: SloodleCourse::get_loginzone_allocation() in course.php

Gets the SLurl for the specified user's loginzone alloation
get_loginzone_position: SloodleCourse::get_loginzone_position() in course.php

Gets the position of the loginzone as a string vector <x,y,z>
get_loginzone_region: SloodleCourse::get_loginzone_region() in course.php

Gets the region of the loginzone
get_loginzone_size: SloodleCourse::get_loginzone_size() in course.php

Gets the size of the loginzone as a string vector <x,y,z>
get_loginzone_time_updated: SloodleCourse::get_loginzone_time_updated() in course.php

Gets the timestamp of the last time the loginzone was updated
get_modification_time: SloodleModuleChoice::get_modification_time() in module_choice.php

Gets the time at which this instance was last modified, or 0 if unknown.
get_modification_time: SloodleModuleGlossary::get_modification_time() in module_glossary.php

Gets the time at which this instance was last modified, or 0 if unknown.
get_modification_time: SloodleModuleBlog::get_modification_time() in module_blog.php

Gets the time at which this instance was last modified, or 0 if unknown.
get_modification_time: SloodleController::get_modification_time() in controller.php

Gets the time at which this controller was last modified.
get_modification_time: SloodleModuleChat::get_modification_time() in module_chat.php

Gets the time at which this instance was last modified, or 0 if unknown.
get_modification_time: SloodleModuleMap::get_modification_time() in module_map.php

Gets the time at which this instance was last modified, or 0 if unknown.
get_modification_time: SloodleModuleDistributor::get_modification_time() in module_distributor.php

Gets the time at which this instance was last modified, or 0 if unknown.
get_modification_time: SloodleModuleSloodleObject::get_modification_time() in module_sloodleobject.php

Gets the time at which this instance was last modified, or 0 if unknown.
get_modification_time: SloodleModule::get_modification_time() in module_base.php

Gets the time at which this instance was last modified, or 0 if unknown.
get_modification_time: SloodleModulePresenter::get_modification_time() in module_presenter.php

Gets the time at which this instance was last modified, or 0 if unknown.
get_modification_time: SloodleModuleiBank::get_modification_time() in module_ibank.php

Gets the time at which this instance was last modified, or 0 if unknown.
get_module_id: SloodleRequest::get_module_id() in io.php

Fetches the module ID request parameter.
get_moodleUserProfile: sloodleCourseObj::get_moodleUserProfile() in sloodlecourseobject.php
get_name: SloodleModuleChat::get_name() in module_chat.php

Gets the name of this module instance.
get_name: SloodleController::get_name() in controller.php

Gets the name of this controller.
get_name: SloodleModuleAviLister::get_name() in module_avilister.php

Gets the name of this module instance.
get_name: SloodleModuleDistributor::get_name() in module_distributor.php

Gets the name of this module instance.
get_name: SloodleModulePresenter::get_name() in module_presenter.php

Gets the name of this module instance.
get_name: SloodleModuleMap::get_name() in module_map.php

Gets the name of this module instance.
get_name: SloodleModuleChoice::get_name() in module_choice.php

Gets the name of this module instance.
get_name: SloodleModuleGlossary::get_name() in module_glossary.php

Gets the name of this module instance.
get_name: SloodleModuleiBank::get_name() in module_ibank.php

Gets the name of this module instance.
get_name: SloodleModuleSloodleObject::get_name() in module_sloodleobject.php

Gets the name of this module instance.
get_name: SloodleModuleBlog::get_name() in module_blog.php

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

Gets the name of this module instance.
get_num_unanswered: SloodleModuleChoice::get_num_unanswered() in module_choice.php

Gets the number of people who have not yet answered the choice.
get_object: SloodleController::get_object() in controller.php

Gets data about an active object.
get_objects: SloodleModuleiBank::get_objects() in module_ibank.php

Gets a list of all objects for this StipendGiver.
get_objects: SloodleModuleDistributor::get_objects() in module_distributor.php

Gets a list of all objects for this Distributor.
get_object_configuration: SloodleController::get_object_configuration() in controller.php

Gets an array of object configuration settings.
get_opening_time: SloodleModuleChoice::get_opening_time() in module_choice.php

Gets the time at which this choice opens.
get_param: SloodleRequest::get_param() in io.php

Obtains a named HTTP request parameter, optionally requiring it or not
get_password: SloodleRequest::get_password() in io.php

Fetches the password request parameter.
get_password: SloodleController::get_password() in controller.php

Gets the prim password of this controller.
get_plugin: SloodlePluginManager::get_plugin() in plugins.php

Gets an instance of the specified plugin type.
get_plugin_description: SloodlePluginPresenterPDFImporter::get_plugin_description() in pdfimporter.php

Gets the human-readable description of this plugin.
get_plugin_description: SloodlePluginBase::get_plugin_description() in _base.php

Gets the human-readable description of this plugin.
get_plugin_name: SloodlePluginPresenterSlideWeb::get_plugin_name() in web.php

Gets the human-readable name of this plugin.
get_plugin_name: SloodlePluginBase::get_plugin_name() in _base.php

Gets the human-readable name of this plugin.
get_plugin_name: SloodlePluginPresenterPDFImporter::get_plugin_name() in pdfimporter.php

Gets the human-readable name of this plugin.
get_plugin_name: SloodlePluginPresenterSlideVideo::get_plugin_name() in video.php

Gets the human-readable name of this plugin.
get_plugin_name: SloodlePluginPresenterSlideImage::get_plugin_name() in image.php

Gets the human-readable name of this plugin.
get_plugin_names: SloodlePluginManager::get_plugin_names() in plugins.php

Gets an array of the names of all SLOODLE plugins derived from the specified type.
get_post: SloodleModuleBlog::get_post() in module_blog.php

Gets the identified post.
get_request_descriptor: SloodleRequest::get_request_descriptor() in io.php

Fetches the request descriptor request parameter.
get_server_access_level: SloodleRequest::get_server_access_level() in io.php

Fetches the server access level parameter, if specified.
get_short_name: SloodleCourse::get_short_name() in course.php

Gets the short name of this course in the VLE.
get_slides: SloodleModulePresenter::get_slides() in module_presenter.php

Gets an ordered associative array of slides in presentation order.
get_sloodleprofile: sloodleCourseObj::get_sloodleprofile() in sloodlecourseobject.php
get_sloodle_course: SloodleLayout::get_sloodle_course() in layout_profile.php
get_staff_courses: SloodleUser::get_staff_courses() in user.php

Gets a numeric array of SloodleCourse objects for courses the user is Sloodle staff.
get_type: SloodleModuleAviLister::get_type() in module_avilister.php

Gets the short type name of this instance.
get_type: SloodleModule::get_type() in module_base.php

Gets the short type name of this instance.
get_type: SloodleModuleChat::get_type() in module_chat.php

Gets the short type name of this instance.
get_type: SloodleModuleDistributor::get_type() in module_distributor.php

Gets the short type name of this instance.
get_type: SloodleModuleChoice::get_type() in module_choice.php

Gets the short type name of this instance.
get_type: SloodleModuleBlog::get_type() in module_blog.php

Gets the short type name of this instance.
get_type: SloodleModuleSloodleObject::get_type() in module_sloodleobject.php

Gets the short type name of this instance.
get_type: SloodleModuleGlossary::get_type() in module_glossary.php

Gets the short type name of this instance.
get_type: SloodleModuleiBank::get_type() in module_ibank.php

Gets the short type name of this instance.
get_type: SloodleModulePresenter::get_type() in module_presenter.php

Gets the short type name of this instance.
get_type: SloodleModuleMap::get_type() in module_map.php

Gets the short type name of this instance.
get_type_full: SloodleModuleMap::get_type_full() in module_map.php

Gets the full type name of this instance, according to the current language pack, if available.
get_type_full: SloodleModuleGlossary::get_type_full() in module_glossary.php

Gets the full type name of this instance, according to the current language pack, if available.
get_type_full: SloodleModuleDistributor::get_type_full() in module_distributor.php

Gets the full type name of this instance, according to the current language pack, if available.
get_type_full: SloodleModuleChoice::get_type_full() in module_choice.php

Gets the full type name of this instance, according to the current language pack, if available.
get_type_full: SloodleModuleSloodleObject::get_type_full() in module_sloodleobject.php

Gets the full type name of this instance, according to the current language pack, if available.
get_type_full: SloodleModuleAviLister::get_type_full() in module_avilister.php

Gets the full type name of this instance, according to the current language pack, if available.
get_type_full: SloodleModuleiBank::get_type_full() in module_ibank.php

Gets the full type name of this instance, according to the current language pack, if available.
get_type_full: SloodleModule::get_type_full() in module_base.php

Gets the full type name of this instance, according to the current language pack, if available.
get_type_full: SloodleModuleBlog::get_type_full() in module_blog.php

Gets the full type name of this instance, according to the current language pack, if available.
get_type_full: SloodleModuleChat::get_type_full() in module_chat.php

Gets the full type name of this instance, according to the current language pack, if available.
get_type_full: SloodleModulePresenter::get_type_full() in module_presenter.php

Gets the full type name of this instance, according to the current language pack, if available.
get_username: SloodleUser::get_username() in user.php

Gets the user's username
get_user_email: SloodleUser::get_user_email() in user.php

Gets the user's email address.
get_user_firstname: SloodleUser::get_user_firstname() in user.php

Gets the first name of the user
get_user_id: SloodleUser::get_user_id() in user.php

Gets the unique ID of the VLE user.
get_user_lastname: SloodleUser::get_user_lastname() in user.php

Gets the last name of the user
get_user_objects: SloodleUser::get_user_objects() in user.php

Gets a list of all user-centric objects authorised for the current avatar.
get_version: SloodlePluginPresenterSlideImage::get_version() in image.php

Gets the internal version number of this plugin.
get_version: SloodlePluginBase::get_version() in _base.php

Gets the internal version number of this plugin.
get_version: SloodlePluginPresenterPDFImporter::get_version() in pdfimporter.php

Gets the internal version number of this plugin.
get_version: SloodlePluginPresenterSlideWeb::get_version() in web.php

Gets the internal version number of this plugin.
get_version: SloodlePluginPresenterSlideVideo::get_version() in video.php

Gets the internal version number of this plugin.
general.php: general.php in general.php

top

has_loginzone_data: SloodleCourse::has_loginzone_data() in course.php

Determines whether or not LoginZone data exists for this course.

top

$icurrency: sloodle_view_ibank::$icurrency in ibank.php
$icurrency: stipendGiverObject::$icurrency in stipendgiver_object.php
$id: SloodleChatMessage::$id in module_chat.php

The ID of the message.
$id: SloodleBlogPost::$id in module_blog.php

The ID of the message.
$id: SloodleLayoutEntry::$id in layout_profile.php
$id: SloodleGlossaryEntry::$id in module_glossary.php

The ID of the entry.
$id: SloodleUserObject::$id in user_object.php

The database record ID of this object's entry.
$id: SloodlePresenterSlide::$id in module_presenter.php

The ID of this slide in the DB table of slides.
$id: SloodleLayout::$id in layout_profile.php
$id: SloodleChoiceOption::$id in module_choice.php

The ID of the option (should be unique across the site).
$id: SloodleLayoutEntryConfig::$id in layout_profile.php
$initialized: sloodle_view_ibank::$initialized in ibank.php
$iPb: sloodle_view_ibank::$iPb in ibank.php
$iPts: sloodle_view_ibank::$iPts in ibank.php
import: SloodlePluginBasePresenterImporter::import() in _base.php

Import the given file, and insert the new slides at the specified position in the Presentation.
import_file: SloodlePluginPresenterPDFImporter::import_file() in pdfimporter.php

Import a file to this Presenter.
index.php: index.php in index.php
insert: SloodleLayoutEntryConfig::insert() in layout_profile.php
insert: SloodleLayout::insert() in layout_profile.php
insert: SloodleLayoutEntry::insert() in layout_profile.php
iPointBank: iPointBank::iPointBank() in ipointbank_object.php
iPointBank: iPointBank in ipointbank_object.php

The iPointBank class provides basic transaction functions for the Sloodle iBank module.
is_available: SloodleCourse::is_available() in course.php

Determines whether or not the course is available.
is_available: SloodleController::is_available() in controller.php

Determines whether or not this controller is available (i.e. not hidden).
is_avatar_linked: SloodleUser::is_avatar_linked() in user.php

Determines whether or not the current user and avatar are linked.
is_avatar_loaded: SloodleUser::is_avatar_loaded() in user.php

Determines whether or not an avatar is loaded.
is_early: SloodleModuleChoice::is_early() in module_choice.php

Determines if the choice has not opened yet.
is_enabled: SloodleModuleBlog::is_enabled() in module_blog.php

Checks if blogging is enabled on the site.
is_enabled: SloodleController::is_enabled() in controller.php

Determines if this controller is enabled or not.
is_enrolled: SloodleUser::is_enrolled() in user.php

Is the current user enrolled in the specified course?
is_late: SloodleModuleChoice::is_late() in module_choice.php

Determines if the choice has already closed.
is_loaded: SloodleController::is_loaded() in controller.php

Determines whether or not this controller is loaded.
is_loaded: SloodleCourse::is_loaded() in course.php

Determines whether or not course data has been loaded.
is_object_request: SloodleRequest::is_object_request() in io.php

Checks the parameters to determine if the request relates to an object rather than a user
is_open: SloodleModuleChoice::is_open() in module_choice.php

Determines if the choice is currently open.
is_request_data_processed: SloodleRequest::is_request_data_processed() in io.php

Checks whether or not the request data has already been processed.
is_staff: SloodleUser::is_staff() in user.php

Is the current user Sloodle staff in the specified course?
is_teacher: sloodleCourseObj::is_teacher() in sloodlecourseobject.php
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.
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.
is_user_loaded: SloodleUser::is_user_loaded() in user.php

Determines whether or not a VLE user is loaded.
io.php: io.php in io.php
ipointbank_object.php: ipointbank_object.php in ipointbank_object.php
ipointbank_object.php: ipointbank_object.php in ipointbank_object.php
image.php: image.php in image.php
ibank.php: ibank.php in ibank.php

top

$layout: SloodleLayoutEntry::$layout in layout_profile.php
$layout_entry: SloodleLayoutEntryConfig::$layout_entry in layout_profile.php
$line_separator: SloodleResponse::$line_separator in io.php

The separation string between lines of the response (typically just a newline).
$locations: sloodle_view_map::$locations in map.php

Numeric array of locations, obtained from the SloodleModuleMap object.
loginzone.php: loginzone.php in loginzone.php
layout_profile.php: layout_profile.php in layout_profile.php
lib.php: lib.php in lib.php
link_avatar: SloodleUser::link_avatar() in user.php

Links the current avatar to the current user.
load: SloodleController::load() in controller.php

Loads data from the database.
load: SloodleLayout::load() in layout_profile.php
load: SloodleModule::load() in module_base.php

Loads data from the database.
load: SloodleModuleiBank::load() in module_ibank.php

Loads data from the database.
load: SloodleModuleDistributor::load() in module_distributor.php

Loads data from the database.
load: SloodleModuleChoice::load() in module_choice.php

Loads data from the database.
load: SloodleModuleChat::load() in module_chat.php

Loads data from the database.
load: SloodleModuleMap::load() in module_map.php

Loads data from the database.
load: SloodleModuleSloodleObject::load() in module_sloodleobject.php

Loads data from the database.
load: SloodleCourse::load() in course.php

Reads fresh data into the structure from the database.
load: SloodleLayoutEntry::load() in layout_profile.php
load: SloodleModulePresenter::load() in module_presenter.php

Loads data from the database.
load: SloodleLayoutEntryConfig::load() in layout_profile.php
load: SloodleModuleGlossary::load() in module_glossary.php

Loads data from the database.
load_avatar: SloodleUser::load_avatar() in user.php

Finds an avatar with the given UUID and/or name, and loads its data.
load_avatar_by_id: SloodleUser::load_avatar_by_id() in user.php

Loads the specified avatar from the database.
load_by_controller: SloodleCourse::load_by_controller() in course.php

Loads course and controller data by the unqiue site-wide identifier of a Sloodle controller.
load_data: SloodleBlogPost::load_data() in module_blog.php

Loads the data from a post record object.
load_from_row: SloodleLayout::load_from_row() in layout_profile.php
load_from_row: SloodleLayoutEntry::load_from_row() in layout_profile.php
load_from_row: SloodleLayoutEntryConfig::load_from_row() in layout_profile.php
load_linked_avatar: SloodleUser::load_linked_avatar() in user.php

Load the avatar linked to the current user.
load_linked_user: SloodleUser::load_linked_user() in user.php

Find the VLE user linked to the current avatar.
load_module: SloodleSession::load_module() in sloodle_session.php

Constructs and loads the appropriate module part of the session.
load_plugins: SloodlePluginManager::load_plugins() in plugins.php

Loads all available plugins from the specified folder.
load_user: SloodleUser::load_user() in user.php

Load the specified user from the database
load_user_by_loginzone: SloodleCourse::load_user_by_loginzone() in course.php

Finds the user identified by LoginZone allocation, and loads it into the given user object.
login: SloodleUser::login() in user.php

Internally 'log-in' the current user.
linker.php: linker.php in linker.php
linker.php: linker.php in linker.php
linker.php: linker.php in linker.php

top

$maxselections: SloodleChoiceOption::$maxselections in module_choice.php

Maximum allowed number of selections for this option.
$message: SloodleChatMessage::$message in module_chat.php

The text of the message.
$module: SloodleSession::$module in sloodle_session.php

The Sloodle module this session relates to, if any.
$module_context: sloodle_base_view_module::$module_context in base_view_module.php

Context object for permissions in the Moodle module.
$moodleuserid: sloodle_view_user::$moodleuserid in user.php

Integer ID of the Moodle user being viewed.
$moodle_assignment_instance: SloodleModuleSloodleObject::$moodle_assignment_instance in module_sloodleobject.php

Internal only - Moodle assignment module instance database object.
$moodle_chat_instance: SloodleModuleChat::$moodle_chat_instance in module_chat.php

Internal only - Moodle chat module instance database object.
$moodle_choice_instance: SloodleModuleChoice::$moodle_choice_instance in module_choice.php

Internal only - Moodle choice module instance database object.
$moodle_glossary_instance: SloodleModuleGlossary::$moodle_glossary_instance in module_glossary.php

Internal only - Moodle glossary module instance database object.
$movingentryid: sloodle_view_presenter::$movingentryid in presenter.php

ID of the entry we are moving.
mail.php: mail.php in mail.php
module_avilister.php: module_avilister.php in module_avilister.php
module_base.php: module_base.php in module_base.php
module_blog.php: module_blog.php in module_blog.php
module_chat.php: module_chat.php in module_chat.php
module_choice.php: module_choice.php in module_choice.php
module_distributor.php: module_distributor.php in module_distributor.php
module_glossary.php: module_glossary.php in module_glossary.php
module_ibank.php: module_ibank.php in module_ibank.php
module_map.php: module_map.php in module_map.php
module_presenter.php: module_presenter.php in module_presenter.php
module_sloodleobject.php: module_sloodleobject.php in module_sloodleobject.php
modules.php: modules.php in modules.php
makeTransaction: iPointBank::makeTransaction() in ipointbank_object.php
mod_form.php: mod_form.php in mod_form.php
mod_sloodle_mod_form: mod_sloodle_mod_form in mod_form.php

Used to define the Sloodle module instance add/edit form.
move_entry: SloodleModulePresenter::move_entry() in module_presenter.php

Moves the ID'd entry forward or back in the presentation ordering.
map.php: map.php in map.php

top

$name: SloodleActiveObject::$name in active_object.php

The name of this object.
$name: SloodlePresenterSlide::$name in module_presenter.php

The name of this slide
$name: SloodleLayoutEntry::$name in layout_profile.php

The name of the object this entry represents.
$name: SloodleLayoutEntryConfig::$name in layout_profile.php
$name: iPointBank::$name in ipointbank_object.php
$name: SloodleLayout::$name in layout_profile.php
$numselections: SloodleChoiceOption::$numselections in module_choice.php

Number of selections so far of this option.
$numunanswered: SloodleModuleChoice::$numunanswered in module_choice.php

The number of (non-admin) users on the course who have not yet answered this choice.
notecard_configuration_form.php: notecard_configuration_form.php in notecard_configuration_form.php
notecard_configuration_view.php: notecard_configuration_view.php in notecard_configuration_view.php

top

$objname: SloodleUserObject::$objname in user_object.php

The name of this object.
$objuuid: SloodleUserObject::$objuuid in user_object.php

The UUID of this object.
$options: SloodleModuleChoice::$options in module_choice.php

The options available for this choice, as an associative array of IDs to SloodleChoiceOption objects.
$ordering: SloodlePresenterSlide::$ordering in module_presenter.php

The ordering value for this slide. This should not generally be used. Refer to 'slideposition' instead.
$originalconfigs: SloodleLayoutEntry::$originalconfigs in layout_profile.php
$originalentryids: SloodleLayout::$originalentryids in layout_profile.php
object_config.php: object_config.php in object_config.php
object_config.php: object_config.php in object_config.php
optional_param: SloodleRequest::optional_param() in io.php

Obtains a named HTTP request parameter, or NULL if it has not been provided.

top

$page_number: SloodleResponse::$page_number in io.php

Current page number.
$page_total: SloodleResponse::$page_total in io.php

Total number of pages.
$password: SloodleUserObject::$password in user_object.php

The password of this object.
$password: SloodleActiveObject::$password in active_object.php

The password of this object.
$plugins: SloodleSession::$plugins in sloodle_session.php

A plugin manager to help give access to plugins for various features.
$plugin_cache: SloodlePluginManager::$plugin_cache in plugins.php

Plugin instance cache.
$position: SloodleLayoutEntry::$position in layout_profile.php

The position of the object, as a 3d vector, in string format "<x,y,z>"
$presenter: SloodlePresenterSlide::$presenter in module_presenter.php

The SloodleModulePresenter object relating the presentation this slide is in
$presenter: SloodleModulePresenter::$presenter in module_presenter.php

Internal only - a database objects representing the Presenter itself.
$presenter: sloodle_view_presenter::$presenter in presenter.php

A Presenter object (secondary table).
$presenter_mode: sloodle_view_presenter::$presenter_mode in presenter.php

Our current mode of access to the Presenter.
plugins.php: plugins.php in plugins.php
ping_object: SloodleController::ping_object() in controller.php

Updates the last active timer on an object.
pdfimporter.php: pdfimporter.php in pdfimporter.php
populate_entries_from_active_objects: SloodleLayout::populate_entries_from_active_objects() in layout_profile.php
populate_from_active_object: SloodleLayoutEntry::populate_from_active_object() in layout_profile.php
printUserTable: sloodle_view_ibank::printUserTable() in ibank.php

This function will display an HTML table of the users transactions Columns displayed will be: UserName | Avatar | Amount Alloted | Balance Remaining
print_footer: sloodle_view_users::print_footer() in users.php

Print the page footer.
print_footer: sloodle_view_course::print_footer() in course.php

Print the footer for this course.
print_footer: sloodle_base_view_module::print_footer() in base_view_module.php

Print the footer for this course.
print_footer: sloodle_base_view::print_footer() in base_view.php

Output the page footer.
print_footer: sloodle_view_user::print_footer() in user.php

Print the page footer.
print_header: sloodle_view_map::print_header() in map.php

Print the page header (requires special scripts to be added into the header)
print_header: sloodle_view_ibank::print_header() in ibank.php

Override the base_view_module print_header for formatting reasons
print_header: sloodle_view_users::print_header() in users.php

Print the course settings page header.
print_header: sloodle_view_course::print_header() in course.php

Print the course settings page header.
print_header: sloodle_view_user::print_header() in user.php

Print the course settings page header.
print_header: sloodle_base_view_module::print_header() in base_view_module.php

Print module header info.
print_header: sloodle_base_view::print_header() in base_view.php

Print the standard page header.
print_slide_position_menu: SloodlePluginPresenterPDFImporter::print_slide_position_menu() in pdfimporter.php

Display a drop-down menu of slides in the current presentation.
process_form: sloodle_view_presenter::process_form() in presenter.php

Process any form data which has been submitted.
process_form: sloodle_base_view::process_form() in base_view.php

Process any form data which has been submitted.
process_form: sloodle_view_map::process_form() in map.php

Process any form data which has been submitted.
process_form: sloodle_view_ibank::process_form() in ibank.php

Process any form data which has been submitted.
process_form: sloodle_view_distributor::process_form() in distributor.php

Process any form data which has been submitted.
process_form: sloodle_view_controller::process_form() in controller.php

Process any form data which has been submitted.
process_form: sloodle_base_view_module::process_form() in base_view_module.php

Process any form data which has been submitted.
process_request: sloodle_view_course::process_request() in course.php

Check the request parameters to see which course was specified.
process_request: sloodle_base_view_module::process_request() in base_view_module.php

Checks for incoming request data identifying a particular module (parameter 'id').
process_request: sloodle_view_controller::process_request() in controller.php

Uses the parent class to process basic request information, then obtains additional Controller data.
process_request: sloodle_view_users::process_request() in users.php

Check and process the request parameters.
process_request: sloodle_view_user::process_request() in user.php

Check and process the request parameters.
process_request: sloodle_view_presenter::process_request() in presenter.php

Processes request data to determine which Presenter is being accessed.
process_request: sloodle_base_view::process_request() in base_view.php

Check for incoming request data identifying a particular course or module.
process_request: sloodle_view_map::process_request() in map.php

Processes request data to determine which Map is being accessed.
process_request: sloodle_view_ibank::process_request() in ibank.php

Check and process the request parameters.
process_request: sloodle_view_distributor::process_request() in distributor.php

Processes request data to determine which Distributor is being accessed.
process_request_data: SloodleRequest::process_request_data() in io.php

Process all of the standard data provided by the HTTP request, and write it into our SloodleSession object.
process_upload: SloodlePluginPresenterPDFImporter::process_upload() in pdfimporter.php

Attempt to process a file upload.
purge_password_notifications: SloodleUser::purge_password_notifications() in user.php

If the system is waiting to send a password notification to this user, then remove it
presenter.php: presenter.php in presenter.php

top

quick_output: SloodleResponse::quick_output() in io.php

Quick output of data to avoid several accessor calls if the response is very basic.

top

$real_first_name: SloodleAviListName::$real_first_name in module_avilister.php

Real first name
$real_last_name: SloodleAviListName::$real_last_name in module_avilister.php

Real last name
$renderMessage: sloodle_view_ibank::$renderMessage in ibank.php
$request: SloodleSession::$request in sloodle_session.php

Incoming HTTP request.
$request_data_processed: SloodleRequest::$request_data_processed in io.php

Indicates whether or not the basic request data has already been processed.
$request_descriptor: SloodleResponse::$request_descriptor in io.php

Request descriptor.
$request_timestamp: SloodleResponse::$request_timestamp in io.php

Timestamp when the request was originally made by the LSL script.
$response: SloodleSession::$response in sloodle_session.php

Outgoing response - can be rendered to HTTP or as a string.
$response_timestamp: SloodleResponse::$response_timestamp in io.php

Timestamp when the response was generated on the Moodle site.
$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>"
register_object: SloodleController::register_object() in controller.php

Registers a new active object (or renew an existing authorisation) with this controller.
register_unauth_object: SloodleController::register_unauth_object() in controller.php

Registers a new unauthorised object.
relocate_entry: SloodleModulePresenter::relocate_entry() in module_presenter.php

Relocates the identified entry to the specified position in the presentation.
removeTransaction: iPointBank::removeTransaction() in ipointbank_object.php
remove_object: SloodleController::remove_object() in controller.php

Removes an active object and all its related items.
render: sloodle_view_distributor::render() in distributor.php

Render the view of the Distributor.
render: sloodle_view_ibank::render() in ibank.php

Render the view of the Stipend Giver.
render: sloodle_view_users::render() in users.php

Render the view of the module or feature.
render: sloodle_view_user::render() in user.php

Render the view of the module or feature.
render: sloodle_view_map::render() in map.php

Render the view of the Map.
render: sloodle_view_course::render() in course.php

Render the view of the module or feature.
render: sloodle_view_presenter::render() in presenter.php

Render the view of the Presenter.
render: sloodle_base_view::render() in base_view.php

Render the view of the module or feature.
render: SloodlePluginPresenterPDFImporter::render() in pdfimporter.php

Render this importer on a web page.
render: sloodle_base_view_module::render() in base_view_module.php

Render the view of the module or feature.
render: sloodle_view_controller::render() in controller.php

Render the view of the Controller.
render_add_files: sloodle_view_presenter::render_add_files() in presenter.php

Render the slide editing form of the Presenter (lets you edit a single slide).
render_edit: sloodle_view_presenter::render_edit() in presenter.php

Render the Edit mode of the Presenter (lists all the slides and allows re-ordering).
render_import_slides: sloodle_view_presenter::render_import_slides() in presenter.php

Render the tab for importing slides from some source.
render_slide_edit: sloodle_view_presenter::render_slide_edit() in presenter.php

Render the slide editing form of the Presenter (lets you edit a single slide).
render_slide_for_browser: SloodlePluginPresenterSlideImage::render_slide_for_browser() in image.php

Render the given slide for browser output -- NOTE: render to a string, and return the string.
render_slide_for_browser: SloodlePluginBasePresenterSlide::render_slide_for_browser() in _base.php

Render the given slide for browser output -- NOTE: render to a string, and return the string.
render_slide_for_browser: SloodlePluginPresenterSlideVideo::render_slide_for_browser() in video.php

Render the given slide for browser output -- NOTE: render to a string, and return the string.
render_slide_for_browser: SloodlePluginPresenterSlideWeb::render_slide_for_browser() in web.php

Render the given slide for browser output -- NOTE: render to a string, and return the string.
render_slide_for_sl: SloodlePluginPresenterSlideVideo::render_slide_for_sl() in video.php

Render the given slide for virtual-world output.
render_slide_for_sl: SloodlePluginPresenterSlideImage::render_slide_for_sl() in image.php

Render the given slide for virtual-world output.
render_slide_for_sl: SloodlePluginBasePresenterSlide::render_slide_for_sl() in _base.php

Render the given slide for virtual-world output.
render_slide_for_sl: SloodlePluginPresenterSlideWeb::render_slide_for_sl() in web.php

Render the given slide for virtual-world output.
render_to_output: SloodleResponse::render_to_output() in io.php

Outputs the response directly to the HTTP response.
render_to_string: SloodleResponse::render_to_string() in io.php

Renders the response to a string.
render_view: sloodle_view_presenter::render_view() in presenter.php

Render the View of the Presenter.
required_param: SloodleRequest::required_param() in io.php

Obtains a named HTTP request parameter, or terminates with an error message if it has not been provided.
reset_password: SloodleUser::reset_password() in user.php

Resets the user's password
resubmit_allowed: SloodleModuleSloodleObject::resubmit_allowed() in module_sloodleobject.php

Checks if re-submissions are permitted.
rowForItem: rowForItem() in view_layout.php

top

$sCourseObj

SloodleModuleiBank::$sCourseObj in module_ibank.php

$sCourseObj

sloodle_view_ibank::$sCourseObj in ibank.php

$searchstr

sloodle_view_user::$searchstr in user.php

The search string for users where appropriate.

$searchstr

sloodle_view_users::$searchstr in users.php

The search string for users where appropriate.

$session

sloodle_view_ibank::$session in ibank.php

session is a dummy session object to be used as a parameter when creating a sloodleUser object

$showInitForm

sloodle_view_ibank::$showInitForm in ibank.php

$side_effects

SloodleResponse::$side_effects in io.php

Integer side effect(s) codes.

$slideposition

SloodlePresenterSlide::$slideposition in module_presenter.php

The position of this slide in the presentation. This is a 1-based count.

$sloodle

sloodle_view_ibank::$sloodle in ibank.php

The main SLOODLE module instance, retreived directly from the database (table: sloodle)

$sloodle

sloodle_base_view_module::$sloodle in base_view_module.php

The main SLOODLE module instance, retreived directly from the database (table: sloodle)

$sloodleCourse

sloodle_view_ibank::$sloodleCourse in ibank.php

SLOODLE course object, retrieved directly from database.

$sloodleCourseObject

sloodleCourseObj::$sloodleCourseObject in sloodlecourseobject.php

$sloodleId

sloodle_view_ibank::$sloodleId in ibank.php

sloodleId The instance of this moodle module

$sloodleId

sloodleCourseObj::$sloodleId in sloodlecourseobject.php

$sloodleId

stipendGiverObject::$sloodleId in stipendgiver_object.php

$sloodleid

SloodleModuleiBank::$sloodleid in module_ibank.php

$sloodleid

iPointBank::$sloodleid in ipointbank_object.php

$sloodleonly

sloodle_view_users::$sloodleonly in users.php

Indicates if we should only show users who have avatars. Fetched from request parameters where given.

$sloodleRec

sloodleCourseObj::$sloodleRec in sloodlecourseobject.php

$sloodle_controller_instance

SloodleController::$sloodle_controller_instance in controller.php

Internal only - Sloodle Controller instance database object.

$sloodle_course

sloodle_view_ibank::$sloodle_course in ibank.php

The SLOODLE course object.

$sloodle_course

sloodle_view_user::$sloodle_course in user.php

SLOODLE course object, retrieved directly from database.

$sloodle_course

sloodle_base_view_module::$sloodle_course in base_view_module.php

The SLOODLE course object.

$sloodle_course

sloodle_view_users::$sloodle_course in users.php

SLOODLE course object, retrieved directly from database.

$sloodle_course

sloodle_view_course::$sloodle_course in course.php

SLOODLE course object, retrieved directly from database.

$sloodle_course_data

SloodleCourse::$sloodle_course_data in course.php

The Sloodle course data object, if it exists.

$sloodle_distributor_instance

SloodleModuleDistributor::$sloodle_distributor_instance in module_distributor.php

Internal only - Sloodle Distributor instance database object.

$sloodle_instance

SloodleModuleMap::$sloodle_instance in module_map.php

Internal only - Sloodle module instance database object.

$sloodle_instance

SloodleModulePresenter::$sloodle_instance in module_presenter.php

Internal only - Sloodle module instance database object.

$sloodle_map

SloodleModuleMap::$sloodle_map in module_map.php

Instance of the extra Map data from the sloodle_map table.

$sloodle_map_module

sloodle_view_map::$sloodle_map_module in map.php

A SLOODLE map module object to wrap the basic map functionality.

$sloodle_module_instance

SloodleModuleDistributor::$sloodle_module_instance in module_distributor.php

Internal only - Sloodle module instance database object.

$sloodle_module_instance

SloodleController::$sloodle_module_instance in controller.php

Internal only - Sloodle module instance database object.

$sloodle_module_instance

SloodleModuleiBank::$sloodle_module_instance in module_ibank.php

Internal only - Sloodle module instance database object.

$sloodle_stipendgiver_instance

SloodleModuleiBank::$sloodle_stipendgiver_instance in module_ibank.php

Internal only - Sloodle StipendGiver instance database object.

$source

SloodlePresenterSlide::$source in module_presenter.php

The source data for this slide. Normally this would be an absolute url (starting with a protocol specifier like HTTP), or a relative path, in which case it is treated as an internal Moodle file.

$start

sloodle_view_users::$start in users.php

The result number to start displaying from

$start

sloodle_view_user::$start in user.php

The result number to start displaying from

$start

sloodle_view_ibank::$start in ibank.php

The result number to start displaying from

$startingBalance

stipendGiverObject::$startingBalance in stipendgiver_object.php

$status_code

SloodleResponse::$status_code in io.php

Integer status code of the response.

$status_descriptor

SloodleResponse::$status_descriptor in io.php

Status descriptor string.

$stipendCollectors_moodleid

sloodle_view_ibank::$stipendCollectors_moodleid in ibank.php

A List of usrs moodle id's who have collected a stipend

$stipendCollectors_uuid

sloodle_view_ibank::$stipendCollectors_uuid in ibank.php

A List of all users avatar UUID's who have collected a stipend

$stipendGiverObj

sloodle_view_ibank::$stipendGiverObj in ibank.php

$stipendGiverRec

stipendGiverObject::$stipendGiverRec in stipendgiver_object.php

$subject

SloodleBlogPost::$subject in module_blog.php

The subject of the post.

$system_context

sloodle_view_users::$system_context in users.php

Moodle permissions context for the system.

$system_context

sloodle_view_user::$system_context in user.php

Moodle permissions context for the system.

sloodlecourseobject.php

sloodlecourseobject.php in sloodlecourseobject.php

sloodle_session.php

sloodle_session.php in sloodle_session.php

stipendgiver_object.php

stipendgiver_object.php in stipendgiver_object.php

save_configs

SloodleLayoutEntry::save_configs() in layout_profile.php

save_entries

SloodleLayout::save_entries() in layout_profile.php

save_layout

SloodleCourse::save_layout() in course.php

Save the given entries in the named profile.

save_layout_by_id

SloodleCourse::save_layout_by_id() in course.php

Save the given entries in the profile specified by id.

search

SloodleModuleGlossary::search() in module_glossary.php

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

searchUserList

stipendGiverObject::searchUserList() in stipendgiver_object.php

select_option

SloodleModuleChoice::select_option() in module_choice.php

Selects an option in this choice on behalf of the specified user.

send_object

SloodleModuleDistributor::send_object() in module_distributor.php

Request that the specified object be sent to the specified avatar.

set

SloodleAviListName::set() in module_avilister.php

Accessor - set all members in a single call.

set

SloodleChatMessage::set() in module_chat.php

Accessor - set all members in a single call.

set

SloodleBlogPost::set() in module_blog.php

Accessor - set all members in a single call.

set

SloodleGlossaryEntry::set() in module_glossary.php

Accessor - set all members in a single call.

setRenderMessage

sloodle_view_ibank::setRenderMessage() in ibank.php

setStartingBalance

stipendGiverObject::setStartingBalance() in stipendgiver_object.php

setStipendBudget

stipendGiverObject::setStipendBudget() in stipendgiver_object.php

settings.php

settings.php in settings.php

setUserList

sloodleCourseObj::setUserList() in sloodlecourseobject.php

setUserList set's the private userList array

set_avatar_last_active

SloodleUser::set_avatar_last_active() in user.php

Sets the timestamp of when the user was last active

set_avatar_name

SloodleUser::set_avatar_name() in user.php

Sets the name of the avatar

set_avatar_uuid

SloodleUser::set_avatar_uuid() in user.php

Sets the UUID of the avatar

set_avatar_uuid

SloodleResponse::set_avatar_uuid() in io.php

Accessor function to set member value $avatar_uuid

set_channel

SloodleModuleDistributor::set_channel() in module_distributor.php

Sets the UUID of the XMLRPC channel used for requests.

set_config

SloodleLayoutEntry::set_config() in layout_profile.php

set_data

SloodleResponse::set_data() in io.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.

set_field_separator

SloodleResponse::set_field_separator() in io.php

Sets the field separator.

set_initial_coordinates

SloodleModuleMap::set_initial_coordinates() in module_map.php

Sets the initial coordinates of the map.

set_intro

SloodleController::set_intro() in controller.php

Sets the intro description of this controller.

set_line_separator

SloodleResponse::set_line_separator() in io.php

Sets the line separator.

set_loginzone_position

SloodleCourse::set_loginzone_position() in course.php

Sets the position of the loginzone as a string vector <x,y,z>

set_loginzone_position_xyz

SloodleCourse::set_loginzone_position_xyz() in course.php

Sets the position of the loginzone as a set of components

set_loginzone_region

SloodleCourse::set_loginzone_region() in course.php

Sets the region of the loginzone

set_loginzone_size

SloodleCourse::set_loginzone_size() in course.php

Sets the size of the loginzone as a string vector <x,y,z>

set_loginzone_size_xyz

SloodleCourse::set_loginzone_size_xyz() in course.php

Sets the size of the loginzone as a set of components

set_loginzone_time_updated

SloodleCourse::set_loginzone_time_updated() in course.php

Sets the timestamp of the last time the loginzone was updated

set_name

SloodleController::set_name() in controller.php

Sets the name of this controller.

set_objects

SloodleModuleDistributor::set_objects() in module_distributor.php

Sets the list of objects in this Distributor

set_page_number

SloodleResponse::set_page_number() in io.php

Accessor function to set member value $page_number

set_page_total

SloodleResponse::set_page_total() in io.php

Accessor function to set member value $page_total

set_password

SloodleController::set_password() in controller.php

Sets the prim password of this controller.

set_position_xyz

SloodleLayoutEntry::set_position_xyz() in layout_profile.php

Sets the position as separate X,Y,Z components

set_request_descriptor

SloodleResponse::set_request_descriptor() in io.php

Accessor function to set member value $request_descriptor

set_request_timestamp

SloodleResponse::set_request_timestamp() in io.php

Accessor function to set member value $request_timestamp

set_response_timestamp

SloodleResponse::set_response_timestamp() in io.php

Accessor function to set member value $response_timestamp

set_rotation_xyz

SloodleLayoutEntry::set_rotation_xyz() in layout_profile.php

Sets the rotation as separate X,Y,Z components

set_side_effects

SloodleResponse::set_side_effects() in io.php

Accessor function to set member value $side_effects. Note: it is recommended that you use add_side_effect() or add_side_effects() instead.

set_status_code

SloodleResponse::set_status_code() in io.php

Accessor function to set member value $status_code

set_status_descriptor

SloodleResponse::set_status_descriptor() in io.php

Accessor function to set member value $status_descriptor

set_tracking_code

SloodleResponse::set_tracking_code() in io.php

Accessor function to set member value $tracking_code

SloodleActiveObject

SloodleActiveObject in active_object.php

An active object, relating to the Sloodle active objects DB table.

SloodleAviListName

SloodleAviListName in module_avilister.php

Represents a single avatar list name association

SloodleBlogPost

SloodleBlogPost in module_blog.php

Represents a single blog post

SloodleChatMessage

SloodleChatMessage::SloodleChatMessage() in module_chat.php

Constructor - initialises members.

SloodleChatMessage

SloodleAviListName::SloodleChatMessage() in module_avilister.php

Constructor - initialises members.

SloodleChatMessage

SloodleChatMessage in module_chat.php

Represents a single chat message

SloodleChatMessage

SloodleBlogPost::SloodleChatMessage() in module_blog.php

Constructor - initialises members.

SloodleChoiceOption

SloodleChoiceOption in module_choice.php

Class to represent a single available option for a choice.

SloodleController

SloodleController in controller.php

Represents a Sloodle Controller, including data such as prim password.

SloodleController

SloodleController::SloodleController() in controller.php

Constructor

SloodleCourse

SloodleCourse::SloodleCourse() in course.php

Constructor

SloodleCourse

SloodleCourse in course.php

The Sloodle course data class

sloodleCourseObj

sloodleCourseObj::sloodleCourseObj() in sloodlecourseobject.php

sloodleCourseObj

sloodleCourseObj in sloodlecourseobject.php

SloodleGlossaryEntry

SloodleGlossaryEntry::SloodleGlossaryEntry() in module_glossary.php

Constructor - initialises members.

SloodleGlossaryEntry

SloodleGlossaryEntry in module_glossary.php

Represents a single glossary entry

SloodleLayout

SloodleLayout in layout_profile.php

This file defines structures for managing Sloodle layout profiles.

SloodleLayout

SloodleLayout::SloodleLayout() in layout_profile.php

SloodleLayoutEntry

SloodleLayoutEntry::SloodleLayoutEntry() in layout_profile.php

SloodleLayoutEntry

SloodleLayoutEntry in layout_profile.php

Stores data for a single entry in a layout profile.

SloodleLayoutEntryConfig

SloodleLayoutEntryConfig::SloodleLayoutEntryConfig() in layout_profile.php

SloodleLayoutEntryConfig

SloodleLayoutEntryConfig in layout_profile.php

SloodleModule

SloodleModule in module_base.php

Sloodle module base class.

SloodleModule

SloodleModule::SloodleModule() in module_base.php

Constructor - initialises the session variable

SloodleModuleAviLister

SloodleModuleAviLister::SloodleModuleAviLister() in module_avilister.php

Constructor

SloodleModuleAviLister

SloodleModuleAviLister in module_avilister.php

The Sloodle AviLister module class.

SloodleModuleBlog

SloodleModuleBlog in module_blog.php

The Sloodle blog module class.

SloodleModuleBlog

SloodleModuleBlog::SloodleModuleBlog() in module_blog.php

Constructor

SloodleModuleChat

SloodleModuleChat::SloodleModuleChat() in module_chat.php

Constructor

SloodleModuleChat

SloodleModuleChat in module_chat.php

The Sloodle chat module class.

SloodleModuleChoice

SloodleModuleChoice in module_choice.php

The Sloodle choice module class.

SloodleModuleChoice

SloodleModuleChoice::SloodleModuleChoice() in module_choice.php

Constructor

SloodleModuleDistributor

SloodleModuleDistributor in module_distributor.php

The Sloodle Distributor module class.

SloodleModuleDistributor

SloodleModuleDistributor::SloodleModuleDistributor() in module_distributor.php

Constructor

SloodleModuleGlossary

SloodleModuleGlossary::SloodleModuleGlossary() in module_glossary.php

Constructor

SloodleModuleGlossary

SloodleModuleGlossary in module_glossary.php

The Sloodle glossary module class.

SloodleModuleiBank

SloodleModuleiBank in module_ibank.php

The Sloodle StipendGiver module class.

SloodleModuleiBank

SloodleModuleiBank::SloodleModuleiBank() in module_ibank.php

Constructor

SloodleModuleMap

SloodleModuleMap in module_map.php

The Sloodle map resource module class.

SloodleModuleMap

SloodleModuleMap::SloodleModuleMap() in module_map.php

Constructor

SloodleModulePresenter

SloodleModulePresenter::SloodleModulePresenter() in module_presenter.php

Constructor

SloodleModulePresenter

SloodleModulePresenter in module_presenter.php

The Sloodle presenter module class.

SloodleModuleSloodleObject

SloodleModuleSloodleObject::SloodleModuleSloodleObject() in module_sloodleobject.php

Constructor

SloodleModuleSloodleObject

SloodleModuleSloodleObject in module_sloodleobject.php

The Sloodle Object assignment module class.

SloodlePluginBase

SloodlePluginBase in _base.php

Base class for all SLOODLE plugins.

SloodlePluginBasePresenterImporter

SloodlePluginBasePresenterImporter in _base.php

Base class for plugins which provide slide importers for the SLOODLE Presenter.

SloodlePluginBasePresenterSlide

SloodlePluginBasePresenterSlide in _base.php

Base class for plugins which provide slide types for the SLOODLE Presenter.

SloodlePluginManager

SloodlePluginManager::SloodlePluginManager() in plugins.php

Class constructor.

SloodlePluginManager

SloodlePluginManager in plugins.php

A class to load SLOODLE plugins, and provide a means to access them.

SloodlePluginPresenterPDFImporter

SloodlePluginPresenterPDFImporter in pdfimporter.php

Presenter plugin for importing a PDF file as a series of image slides.

SloodlePluginPresenterSlideImage

SloodlePluginPresenterSlideImage in image.php

Presenter plugin for showing image slides.

SloodlePluginPresenterSlideVideo

SloodlePluginPresenterSlideVideo in video.php

Presenter plugin for showing video slides.

SloodlePluginPresenterSlideWeb

SloodlePluginPresenterSlideWeb in web.php

Presenter plugin for showing web slides.

SloodlePresenterSlide

SloodlePresenterSlide::SloodlePresenterSlide() in module_presenter.php

SloodlePresenterSlide

SloodlePresenterSlide in module_presenter.php

Defines a single slide from a presentation, containing raw data.

SloodleRequest

SloodleRequest in io.php

Handles incoming HTTP requests, typically from LSL if dealing with Second Life.

SloodleRequest

SloodleRequest::SloodleRequest() in io.php

Constructor

initialises the SloodleSession object.

SloodleResponse

SloodleResponse::SloodleResponse() in io.php

Constructor

can intialise some variables

SloodleResponse

SloodleResponse in io.php

A helper class to validate and structure data for output according to the Sloodle communications specification.

SloodleSession

SloodleSession in sloodle_session.php

The primary API class, which manages all other parts.

SloodleSession

SloodleSession::SloodleSession() in sloodle_session.php

Constructor - initialises members

SloodleUser

SloodleUser in user.php

A class to represent a single user, including Moodle and Sloodle data.

SloodleUser

SloodleUser::SloodleUser() in user.php

Class constructor.

SloodleUserObject

SloodleUserObject in user_object.php

A user-centric object, relating to the Sloodle user objects DB table.

sloodle_access_level_option_choice

sloodle_access_level_option_choice() in general.php

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.

sloodle_add_to_log

sloodle_add_to_log() in general.php

Old logging function

sloodle_array_to_vector

sloodle_array_to_vector() in general.php

Converts an array vector to a string vector.

sloodle_autoenrol_enabled_site

sloodle_autoenrol_enabled_site() in general.php

Determines whether or not auto-enrolment is allowed for the site.

sloodle_autoreg_enabled_site

sloodle_autoreg_enabled_site() in general.php

Determines whether or not auto-registration is allowed for the site.

sloodle_base_view

sloodle_base_view::sloodle_base_view() in base_view.php

Constructor.

sloodle_base_view

sloodle_base_view in base_view.php

The base class for viewing a SLOODLE module or feature.

sloodle_base_view_module

sloodle_base_view_module::sloodle_base_view_module() in base_view_module.php

Constructor.

sloodle_base_view_module

sloodle_view_distributor::sloodle_base_view_module() in distributor.php

Constructor.

sloodle_base_view_module

sloodle_base_view_module in base_view_module.php

The base class for viewing a SLOODLE module.

SLOODLE_BLOG_VISIBILITY_PRIVATE

SLOODLE_BLOG_VISIBILITY_PRIVATE in module_blog.php

Blog visibility identifier for private posts. (These can only be viewed by the person who posted them)

SLOODLE_BLOG_VISIBILITY_PUBLIC

SLOODLE_BLOG_VISIBILITY_PUBLIC in module_blog.php

Blog visibility identifier for public posts. (These can be viewed by anybody)

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)

sloodle_check_course_module_instance_type

sloodle_check_course_module_instance_type() in general.php

Determines if the specified course module instance is of the named type.

sloodle_clean_for_db

sloodle_clean_for_db() in general.php

Returns the given string, 'cleaned' and ready for storage in the database.

sloodle_clean_for_output

sloodle_clean_for_output() in general.php

Returns the given string, 'cleaned' and ready for output to SL as UTF-8.

sloodle_convert_file_size_shorthand

sloodle_convert_file_size_shorthand() in general.php

Converts a shorthand file size to a number of bytes, if necessary.

sloodle_cron

sloodle_cron() in lib.php

Function to be run periodically according to the Moodle cron.

SLOODLE_DEBUG

SLOODLE_DEBUG in sl_config.php

sloodle_debug

sloodle_debug() in sl_config.php

Outputs messages if in debug mode.

SLOODLE_DEBUG_MODE_PARAM_NAME

SLOODLE_DEBUG_MODE_PARAM_NAME in sl_config.php

The name of the HTTP parameter which can be used to activate Sloodle debug mode.

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.

sloodle_describe_approx_time

sloodle_describe_approx_time() in general.php

Returns a very approximate natural language description of a period of time (in minutes, hours, days, or weeks).

SLOODLE_DIRROOT

SLOODLE_DIRROOT in sl_config.php

The data path for the root of the Sloodle folder.

sloodle_display_config_form

sloodle_display_config_form() in object_config.php

sloodle_finished_login_coordinates

sloodle_finished_login_coordinates() in general.php

Generates teleport coordinates for a user who has already finished the LoginZone process.

sloodle_get_config

sloodle_get_config() in general.php

Gets a Sloodle configuration value from Moodle's "config" table.

sloodle_get_course_module_instance

sloodle_get_course_module_instance() in general.php

Obtains the identified course module instance database record.

sloodle_get_files

sloodle_get_files() in general.php

Gets an array of files within the given directory.

sloodle_get_installed_object_types

sloodle_get_installed_object_types() in general.php

Gets all object types and versions available in this installation.

sloodle_get_max_post_upload

sloodle_get_max_post_upload() in general.php

Gets the maximum size of a file (in bytes) that can be uploaded using POST.

sloodle_get_module_id

sloodle_get_module_id() in general.php

Obtains the ID number of the specified module (type not instance).

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.

sloodle_get_size_description

sloodle_get_size_description() in general.php

Converts a file size to plain text.

sloodle_get_subdirectories

sloodle_get_subdirectories() in general.php

Gets an array of subdirectories within the given directory.

sloodle_get_types

sloodle_get_types() in lib.php

Gets the different sub-types of Sloodle module available as a list for the "Add Activity..." menu.

sloodle_get_value

sloodle_get_value() in general.php

Extracts a value from a name-value associative array if it is set.

sloodle_get_web_path

sloodle_get_web_path() in general.php

Gets the basic URL of the current web-page being accessed.

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.

sloodle_is_course_module_instance_visible

sloodle_is_course_module_instance_visible() in general.php

Determines whether or not the specified course module instance is visible.

sloodle_is_installed

sloodle_is_installed() in general.php

Determines whether or not Sloodle is installed.

SLOODLE_LIBROOT

SLOODLE_LIBROOT in sl_config.php

The data path for the root of the Sloodle library folder.

SLOODLE_LINKER_SCRIPT

SLOODLE_LINKER_SCRIPT in check_user_auth_linker.php

Lets Sloodle know we are in a linker script.

sloodle_load_module

sloodle_load_module() in modules.php

Constructs a appropriate Sloodle module object based on the named type.

sloodle_login_notification

sloodle_login_notification() in general.php

Stores a pending login notification for an auto-registered user.

sloodle_login_zone_bounds

sloodle_login_zone_bounds() in general.php

Calculates the maximum and minimum bounds of the specified LoginZone Returns the bounds as a numeric array of two associate array vectors: ($max, $min).

SLOODLE_OBJECT_ACCESS_LEVEL_GROUP

SLOODLE_OBJECT_ACCESS_LEVEL_GROUP in sl_config.php

Indicates that only in-world group-members may access an object in-world.

SLOODLE_OBJECT_ACCESS_LEVEL_OWNER

SLOODLE_OBJECT_ACCESS_LEVEL_OWNER in sl_config.php

Indicates that only the owner may access an object in-world.

SLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC

SLOODLE_OBJECT_ACCESS_LEVEL_PUBLIC in sl_config.php

Indicates that anybody may access an object in-world.

SLOODLE_PARAM_AVATAR_NAME

SLOODLE_PARAM_AVATAR_NAME in io.php

Defines the HTTP parameter name for an avatar name.

SLOODLE_PARAM_AVATAR_UUID

SLOODLE_PARAM_AVATAR_UUID in io.php

Defines the HTTP parameter name for an avatar UUID.

SLOODLE_PARAM_CONTROLLER_ID

SLOODLE_PARAM_CONTROLLER_ID in io.php

Defines the HTTP parameter name for a Sloodle controller ID.

SLOODLE_PARAM_COURSE_ID

SLOODLE_PARAM_COURSE_ID in io.php

Defines the HTTP parameter name for a course ID.

SLOODLE_PARAM_IS_OBJECT

SLOODLE_PARAM_IS_OBJECT in io.php

Defines the HTTP parameter name for indicating a request which relates to an object instead of a user.

SLOODLE_PARAM_MODULE_ID

SLOODLE_PARAM_MODULE_ID in io.php

Defines the HTTP parameter name for a module ID.

SLOODLE_PARAM_PASSWORD

SLOODLE_PARAM_PASSWORD in io.php

Defines the HTTP parameter name for a Sloodle password.

SLOODLE_PARAM_REQUEST_DESC

SLOODLE_PARAM_REQUEST_DESC in io.php

Defines the HTTP parameter name for a request descriptor.

SLOODLE_PARAM_SERVER_ACCESS_LEVEL

SLOODLE_PARAM_SERVER_ACCESS_LEVEL in io.php

Defines the HTTP parameter name for specifying server access level.

sloodle_parse_object_identifier

sloodle_parse_object_identifier() in general.php

Extracts the object name and version number from an object identifier.

sloodle_position_is_in_login_zone

sloodle_position_is_in_login_zone() in general.php

Checks if the specified position is in the current (site-wide) loginzone.

SLOODLE_PRESENTER_TAB_ADD_FILES

SLOODLE_PRESENTER_TAB_ADD_FILES in presenter.php

ID of the 'bulk upload' tab for the Presenter

SLOODLE_PRESENTER_TAB_ADD_SLIDE

SLOODLE_PRESENTER_TAB_ADD_SLIDE in presenter.php

ID of the 'add slide' tab for the Presenter

SLOODLE_PRESENTER_TAB_EDIT

SLOODLE_PRESENTER_TAB_EDIT in presenter.php

ID of the 'edit' tab for the Presenter

SLOODLE_PRESENTER_TAB_EDIT_SLIDE

SLOODLE_PRESENTER_TAB_EDIT_SLIDE in presenter.php

ID of the 'edit slide' tab for the Presenter

SLOODLE_PRESENTER_TAB_IMPORT_SLIDES

SLOODLE_PRESENTER_TAB_IMPORT_SLIDES in presenter.php

ID of the 'import slides' tab for the Presenter

SLOODLE_PRESENTER_TAB_VIEW

SLOODLE_PRESENTER_TAB_VIEW in presenter.php

ID of the 'view' tab for the Presenter.

sloodle_print_access_level_options

sloodle_print_access_level_options() in general.php

Outputs the standard form elements for access levels in object configuration.

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.

sloodle_process_login_notifications

sloodle_process_login_notifications() in general.php

Processes pending login notifications, up to a certain limit.

sloodle_process_options

sloodle_process_options() in lib.php

Processes the module configuration options prior to saving them.

sloodle_random_position_in_zone

sloodle_random_position_in_zone() in general.php

Generates a random position within a cuboid zone of the specified size.

sloodle_random_prim_password

sloodle_random_prim_password() in general.php

Generates a random prim password (7 to 9 digit number).

sloodle_random_security_token

sloodle_random_security_token() in general.php

Generates a random login security token.

sloodle_random_web_password

sloodle_random_web_password() in general.php

Generates a random web password Uses mixed-case letters and numbers to generate a random 8-character string.

sloodle_required_param

sloodle_required_param() in io.php

Obtains a named HTTP request parameter, and terminates script with an error message if it was not provided.

sloodle_require_login_no_guest

sloodle_require_login_no_guest() in general.php

Force the user to login, but reject guest logins.

sloodle_round_vector

sloodle_round_vector() in general.php

Rounds the specified 3d vector integer values.

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.

sloodle_send_login_notification

sloodle_send_login_notification() in general.php

Send a login notification.

sloodle_send_xmlrpc_message

sloodle_send_xmlrpc_message() in general.php

Sends an XMLRPC message into Second Life.

SLOODLE_SERVER_ACCESS_LEVEL_COURSE

SLOODLE_SERVER_ACCESS_LEVEL_COURSE in sl_config.php

Indicates that only those registered and enrolled in a specific course may access a server resource.

SLOODLE_SERVER_ACCESS_LEVEL_PUBLIC

SLOODLE_SERVER_ACCESS_LEVEL_PUBLIC in sl_config.php

Indicates that anybody may access a server resource (still requires an authenticated request).

SLOODLE_SERVER_ACCESS_LEVEL_SITE

SLOODLE_SERVER_ACCESS_LEVEL_SITE in sl_config.php

Indicates that only those registered on the site may access a server resource.

SLOODLE_SERVER_ACCESS_LEVEL_STAFF

SLOODLE_SERVER_ACCESS_LEVEL_STAFF in sl_config.php

Indicates that only those with Sloodle staff status on a course may access a server resource.

sloodle_set_config

sloodle_set_config() in general.php

Sets a Sloodle configuration value.

sloodle_text_email

sloodle_text_email() in mail.php

Send an email to a specific address, using the Moodle system.

sloodle_text_email_sl

sloodle_text_email_sl() in mail.php

Send an email to an object in SL.

SLOODLE_TYPE_CTRL

SLOODLE_TYPE_CTRL in sl_config.php

SLOODLE_TYPE_DISTRIB

SLOODLE_TYPE_DISTRIB in sl_config.php

SLOODLE_TYPE_IBANK

SLOODLE_TYPE_IBANK in sl_config.php

SLOODLE_TYPE_MAP

SLOODLE_TYPE_MAP in sl_config.php

SLOODLE_TYPE_PRESENTER

SLOODLE_TYPE_PRESENTER in sl_config.php

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.

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.

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.

sloodle_validate_prim_password

sloodle_validate_prim_password() in general.php

Checks if the given prim password is valid.

sloodle_validate_prim_password_verbose

sloodle_validate_prim_password_verbose() in general.php

Checks if the given prim password is valid, and provides feedback.

sloodle_vector_to_array

sloodle_vector_to_array() in general.php

Converts a string vector to an array vector.

SLOODLE_VERSION

SLOODLE_VERSION in sl_config.php

The Sloodle version number.

sloodle_view

sloodle_view() in general.php

Render a page viewing a particular feature, or a SLOODLE module.

sloodle_view_controller

sloodle_view_controller in controller.php

The base class for viewing a SLOODLE Controller module.

sloodle_view_controller

sloodle_view_controller::sloodle_view_controller() in controller.php

Constructor.

sloodle_view_course

sloodle_view_course in course.php

Class for rendering a view of SLOODLE course information.

sloodle_view_course

sloodle_view_course::sloodle_view_course() in course.php

Constructor.

sloodle_view_distributor

sloodle_view_distributor in distributor.php

Class for rendering a view of a Distributor module in Moodle.

sloodle_view_ibank

sloodle_view_ibank in ibank.php

Class for rendering a view of a Distributor module in Moodle.

sloodle_view_ibank

sloodle_view_ibank::sloodle_view_ibank() in ibank.php

Constructor.

sloodle_view_map

sloodle_view_map in map.php

Class for rendering a view of a Map module in Moodle.

sloodle_view_map

sloodle_view_map::sloodle_view_map() in map.php

Constructor.

sloodle_view_presenter

sloodle_view_presenter::sloodle_view_presenter() in presenter.php

Constructor.

sloodle_view_presenter

sloodle_view_presenter in presenter.php

Class for rendering a view of a Presenter module in Moodle.

sloodle_view_user

sloodle_view_user::sloodle_view_user() in user.php

Constructor.

sloodle_view_user

sloodle_view_user in user.php

Class for rendering a view of SLOODLE user information.

sloodle_view_users

sloodle_view_users in users.php

Class for rendering a view of SLOODLE users.

sloodle_view_users

sloodle_view_users::sloodle_view_users() in users.php

Constructor.

SLOODLE_WWWROOT

SLOODLE_WWWROOT in sl_config.php

The path for browsing to the root of the Sloodle folder.

sl_config.php

sl_config.php in sl_config.php

stipendGiverObject

stipendGiverObject in stipendgiver_object.php

StipendGiverObject

stipendGiverObject::StipendGiverObject() in stipendgiver_object.php

submit

SloodleModuleSloodleObject::submit() in module_sloodleobject.php

Add a new submission (or replace an existing one).

top

$text: SloodleChoiceOption::$text in module_choice.php

The text of this option.
$timemodified: SloodleChoiceOption::$timemodified in module_choice.php

Timestamp of when this option was last modified.
$timestamp: SloodleChatMessage::$timestamp in module_chat.php

Timestamp of the message.
$timestamp_created: SloodleBlogPost::$timestamp_created in module_blog.php

Timestamp of when this message was created.
$timestamp_modified: SloodleBlogPost::$timestamp_modified in module_blog.php

Timestamp of when this message was last modified.
$timeupdated: SloodleUserObject::$timeupdated in user_object.php

Timestamp for when this object was last used.
$tracking_code: SloodleResponse::$tracking_code in io.php

Tracking code of the request.
$transactionRecords: iPointBank::$transactionRecords in ipointbank_object.php
$transactionRecords: sloodle_view_ibank::$transactionRecords in ibank.php

A List of records of the transactions for this stipend
$type: SloodleActiveObject::$type in active_object.php

The type of this object.
$type: SloodlePresenterSlide::$type in module_presenter.php

The type of this slide. This will be the ID of a plugin, or it may be a legacy type, 'web', 'image', or 'video'.

top

$user: SloodleActiveObject::$user in active_object.php

The user who authorised this object.
$user: SloodleSession::$user in sloodle_session.php

Current user information.
$user: SloodleBlogPost::$user in module_blog.php

The user who wrote this message.
$user: SloodleChatMessage::$user in module_chat.php

The user who wrote this message.
$userconfirmed: sloodle_view_user::$userconfirmed in user.php

Indicates a confirmation for certain actions, such as deletion, supplied by request parameter.
$userList: sloodle_view_ibank::$userList in ibank.php

A List of all the students in this course
$userList: sloodleCourseObj::$userList in sloodlecourseobject.php
$user_data: SloodleUser::$user_data in user.php

Internal only - user data. (i.e. VLE user) In Moodle, corresponds to a record from the 'user' table.
$uuid: SloodleActiveObject::$uuid in active_object.php

The UUID of this object.
upload.php: upload.php in upload.php
upload.php: upload.php in upload.php
user.php: user.php in user.php
user_object.php: user_object.php in user_object.php
user_object_auth.php: user_object_auth.php in user_object_auth.php
user_object_linker.php: user_object_linker.php in user_object_linker.php
update: SloodleLayout::update() in layout_profile.php
update: SloodleLayoutEntry::update() in layout_profile.php
update: SloodleLayoutEntryConfig::update() in layout_profile.php
update: iPointBank::update() in ipointbank_object.php
updateTransaction: iPointBank::updateTransaction() in ipointbank_object.php
updateUserList: stipendGiverObject::updateUserList() in stipendgiver_object.php
update_object_type: SloodleController::update_object_type() in controller.php

Updates the type of a given active object to the specified type.
user_can_submit: SloodleModuleSloodleObject::user_can_submit() in module_sloodleobject.php

Checks if the specified user is permitted to submit to this assignment.
user_can_view: SloodleModuleSloodleObject::user_can_view() in module_sloodleobject.php

Checks if the specified user is permitted to view submissions to this assignment.
user_can_write: SloodleModuleBlog::user_can_write() in module_blog.php

Checks if the currently logged-in user has permission to create blog entries.
user_has_submitted: SloodleModuleSloodleObject::user_has_submitted() in module_sloodleobject.php

Checks if the specified user has submitted to this assignment already.
user.php: user.php in user.php
users.php: users.php in users.php

top

$value: SloodleLayoutEntryConfig::$value in layout_profile.php
$viewingself: sloodle_view_user::$viewingself in user.php

Is the user viewing their own profile?
$visibility: SloodleBlogPost::$visibility in module_blog.php

The visibility of this post.
video.php: video.php in video.php
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.
validate_ordering: SloodleModulePresenter::validate_ordering() in module_presenter.php

Validates the ordering value of all entries in the presenter.
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).
validation: mod_sloodle_mod_form::validation() in mod_form.php

Validates the form data.
version.php: version.php in version.php
version_linker.php: version_linker.php in version_linker.php
view: sloodle_base_view::view() in base_view.php

The main viewing function.
view.php: view.php in view.php
view_course.php: view_course.php in view_course.php
view_layout.php: view_layout.php in view_layout.php

top

web.php: web.php in web.php
write: SloodleCourse::write() in course.php

Writes current Sloodle course data back to the database.
write: SloodleController::write() in controller.php

Updates the currently loaded entry in the database.
write_avatar: SloodleUser::write_avatar() in user.php

Uses the current avatar data to update the database.

top

xForIndex: xForIndex() in view_layout.php

top

yForIndex: yForIndex() in view_layout.php