require_once (SLOODLE_LIBROOT.'/mail.php') (line 21)

Include our email functionality.

sloodle_array_to_vector (line 272)

Converts an array vector to a string vector.

Array vector should be associative, containing elements 'x', 'y', and 'z'. Converts to a string vector of format "<x,y,z>".

• see: sloodle_round_vector()
• see: sloodle_vector_to_array()

• $arr

sloodle_autoreg_enabled_site (line 75)

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

• return: True if auto-reg is allowed on the site, or false otherwise.

sloodle_describe_approx_time (line 741)

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

Can also be used to describe how long ago something happened, in which case anything less than 1 minute is treated as 'now'.

• int $secs: Number of seconds in period of time
• bool $ago: If true (not default), then the time will be described in past tense, e.g. "3 days ago", as opposed to simply "3 days".

sloodle_get_config (line 55)

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

This function does not necessarily need to be used. All configuration data is available as named members of Moodle's $CFG global variable. NOTE: in Sloodle debug mode, this function will terminate the script with an error if the name is not prefixed with "sloodle_".

• return: A string containing the configuration value, or false if the query failed (e.g. if the named value didn't exist)
• see: sloodle_set_config()

• string $name: The name of the value to be stored (should be prefixed with "sloodle_")

sloodle_get_files (line 844)

Gets an array of files within the given directory.

Ignores anything which starts with a .

• return: A numeric array of file names sorted alphabetically, or false if an error occurred (such as the input value not being a directory)

• string $dir: The directory to search WITHOUT a trailing slash. (Note: cannot search the current directory or higher in the file hierarchy)
• bool $relative: If TRUE (default) the array of results will be relative to the input directory. Otherwise, they will include the input directory path.

sloodle_get_module_id (line 341)

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

• return: Integer containing module ID, or false if it is not installed

• string $name: The name of the module type to check, e.g. 'sloodle' or 'forum'

sloodle_get_value (line 661)

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

(The array should associate name to value).

• return: The value from the input array, or the $default parameter

• array $settings: The array of names and values
• string $name: The name of the value to retrieve
• mixed $default: The default value to return if the specified value was not found

sloodle_is_course_module_instance_visible (line 294)

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

Checks that the instance itself and the course section are both valid.

• return: True if visible, or false if invisible or not found

• int $id: The integer ID of a course module instance.

sloodle_login_notification (line 572)

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

A cron job will process the pending notification queue.

• return: True if successful, or false otherwise

• string $destination: Identifies the destination of the notification (for SL, this will be the object UUID. The send function will construct the email address)
• string $avatar: Identifier for the avatar being notified
• string $username: The username to notify the user of
• string $password: The (plaintext) password to notify the user of

sloodle_parse_object_identifier (line 874)

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

• return: A numeric array of name then version number.

• string $objid: An object identifier, such as "chat-1.0"

sloodle_print_access_level_options (line 678)

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

Each part can be optionally hidden, and default values can be provided. (Note: the server access level must be communicated from the object back to Moodle... rubbish implementation, but it works!)

• array $current_config: An associative array of setting names to values, containing defaults. (Ignored if null).
• bool $show_use_object: Determines whether or not the "Use Object" setting is shown
• bool $show_control_object: Determines whether or not the "Control Object" setting is shown
• bool $show_server: Determines whether or not the server access setting is shown

sloodle_random_position_in_zone (line 413)

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

(Note: leaves a 2 metre margin round the outside)

• return: An associative vector array

• array $size: Associative array giving the size of the zone

sloodle_random_security_token (line 191)

Generates a random login security token.

Uses mixed-case letters and numbers to generate a random 16-character string.

• see: sloodle_random_web_password()

sloodle_round_vector (line 436)

Rounds the specified 3d vector integer values.

Can handle/return a string vector, or an array vector. (Output type matches input type).

• mixed $pos: Either a string vector or an array vector

sloodle_send_xmlrpc_message (line 96)

Sends an XMLRPC message into Second Life.

• return: True if successful, or false if an error occurs

• string $channel: A string containing a UUID identifying the XMLRPC channel in SL to be used
• int $intval: An integer value to be sent in the message
• string $strval: A string value to be sent in the message

sloodle_validate_prim_password (line 499)

Checks if the given prim password is valid.

• return: True if it is valid, or false otherwise.

• string $password: The password string to check

sloodle_vector_to_array (line 252)

Converts a string vector to an array vector.

String vector should be of format "<x,y,z>". Converts to associative array with members 'x', 'y', and 'z'. Returns false if input parameter was not of correct format.

• see: sloodle_round_vector()
• see: sloodle_array_to_vector()

• string $vector: A string vector of format "<x,y,z>".