object $moodle_user_cache = NULL (line 86)

Moodle user data cache.

Used by various functions fetching database data about a Moodle user. Contents can also be used in subsequent function calls to prevent the need for an additional database query (typically by specifying a $use_cache parameter). Update is *not* automatic. It can be updated manually by calling {@link: update_moodle_user_cache_from_db()}. Unlike the Sloodle equivalent, this cannot be used to update the database After construction, it will always be an object.

• see: SloodleUser::$enrolled_courses_cache
• see: SloodleUser::$sloodle_user_cache
• see: SloodleUser::$moodle_user_id
• access: public

object $sloodle_user_cache = NULL (line 70)

Sloodle user data cache.

Used by various functions fetching database data about a Sloodle user. Contents can also be used in subsequent function calls to prevent the need for an additional database query (typically by specifying a $use_cache parameter). Update is *not* automatic. It can be updated manually by calling {@link: update_sloodle_user_cache_from_db()}. Data placed here can also be used to edit the database using {@link: insert_sloodle_user_cache_to_db()} or {@link: update_sloodle_user_cache_to_db()}. After construction, it will always be an object.

• see: SloodleUser::$moodle_user_cache
• see: SloodleUser::$sloodle_user_id
• access: public

Constructor SloodleUser (line 109)

Class constructor.

• access: public

create_sloodle_user (line 347)

Create a new Sloodle user.

All parameters are optional. To enable loginzone authentication, you *must* specify position and expiry time. Note that, if no login security token is specified, it is generated automatically. If successful, the new ID is stored and the user data is cached.

• return: True if successful, or false if not.
• access: public

• string $uuid: avatar UUID
• string $avname: avatar name
• int $userid: ID of Moodle user to be linked with this Sloodle user
• string $loginposition: a position vector of format <x,y,z>, representing the allocated loginzone position
• string $loginpositionexpires: an indication of when the allocated loginposition expires (format unknown)
• string $loginpositionregion: the name of the region in which the loginzone is (NOT IN USE YET!)
• string $loginsecuritytoken: a security token (random letters/numbers) used to allow secure authentication

delete_sloodle_user (line 243)

Deletes the Sloodle user identified by {@link:$sloodle_user_id}.

• return: True if successful, false on failure, or a string error message if something goes wrong
• access: public

find_linked_sloodle_user (line 579)

Find the Sloodle user linked to the current Moodle user.

Stores the Sloodle user ID in {@link:$sloodle_user_id}.

• return: True if successful, false if no link was found, or a string if an error occurs
• access: public

• bool $cache_data: If true (default) then the Sloodle user data is automatically cached by this function.

find_sloodle_user_by_login_position (line 660)

Attempt to find a Sloodle user by their loginzone position If successful, the user ID is stored in {@link:$sloodle_user_id} and the function returns true.

If no user was found for the given position, false is returned (this may occur if the LoginZone position has expired). If an error occurs, then a string containing an error message is returned.

• access: public

• mixed $position: A vector, either as a string ("<x,y,z>") or an associative array.
• bool $cache_data: If true (default) then the user data is cached. Otherwise it is discarded.

get_moodle_user_id (line 146)

Accessor: gets the Moodle user ID member, {@link: $moodle_user_id}.

• access: public

has_login_security_token (line 770)

Checks if the current Sloodle user has a login security token

• return: True if the user has a login security token, or false otherwise.
• access: public

• bool $use_cache: If true then the cached user data will be used instead of querying the database.

is_user_in_course (line 831)

Checks if the current Moodle user is already enrolled in the specified course.

• access: public

• int $course_id: ID number of a course to check.
• bool $use_cache: If true (not default) then the function uses the enrolled courses cache, instead of querying the database for new data.
• bool 2: True if the user is enrolled, or false if not.

login_moodle_user (line 728)

Performs an internal login of the current Moodle user.

Stores all the user data in the global $USER variable. Note: if login fails, $USER is unchanged. Additionally, note that this function will not perform automatic registration.

• return: True if successful, or false otherwise.
• access: public

set_moodle_user_id (line 157)

Accessor: sets the Moodle user ID member, {@link: $moodle_user_id}.

• access: public

• int $id: The integer ID of a Moodle user entry (or 0 for no entry).

unlink_sloodle_user (line 221)

Completely unlinks the Sloodle user from any Moodle account.

• return: True if successful, false on failure, or a string error message if something goes wrong
• access: public

update_moodle_user_cache_from_db (line 273)

Update the Moodle user cache ({@link:$moodle_user_cache}) from the database

• return: True if successful, false on failure, or a string error message if something goes wrong
• access: public

update_sloodle_user_cache_to_db (line 291)

Use the Sloodle user cache to update an entry in the Sloodle users database table.

Uses the object-entirely as-is, so the 'id' field must be accurate. Ignores anu unset fields.

• return: True if successful, false if the query fails, or a string error message if something goes wrong
• access: public