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

Include our email functionality.

sloodle_add_to_log (line 163)

Old logging function

• todo: May require update?

• $courseid
• $module
• $action
• $url
• $cmid
• $info

sloodle_autoenrol_enabled_site (line 109)

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

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

sloodle_check_course_module_instance_type (line 345)

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

For example, this can check if a particular instance is a "forum" or a "chat".

• return: True if the module is of the specified type, or false otherwise

• int $id: The integer ID of a course module instance
• string $module_name: Module type to check (must be the exact name of an installed module, e.g. 'sloodle' or 'quiz')

sloodle_clean_for_output (line 1048)

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

Removes tags and slash-characters.

• string $str: str The string to clean.

sloodle_describe_approx_time (line 796)

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 80)

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 899)

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_max_post_upload (line 1112)

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

sloodle_get_size_description (line 1091)

Converts a file size to plain text.

For example, will convert "1024" to "1 kilobyte".

• return: A text string describing the specified size.

• integer|string $size: size If an integer, then it is the number of bytes. If a string, then it can be PHP shorthand, such as "1M" for 1 megabyte.

sloodle_get_value (line 683)

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 319)

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 597)

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 929)

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 700)

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 438)

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 216)

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_require_login_no_guest (line 29)

Force the user to login, but reject guest logins.

This function exists to workaround some Moodle 1.8 bugs.

sloodle_send_login_notification (line 620)

Send a login notification.

• return: True if successful, or false otherwise

• string $destination: Identifies the destination of the notification (for SL, this will be the object UUID. The target email address will be constructed)
• 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_set_config (line 59)

Sets a Sloodle configuration value.

This data will be stored in Moodle's "config" table, so it will persist even after Sloodle is uninstalled. After being set, it will be available (read-only) as a named member of Moodle's $CFG variable. NOTE: in Sloodle debug mode, this function will terminate the script with an error if the name is not prefixed with "sloodle_".

• return: True on success, or false on failure (may fail if database query encountered an error)
• see: sloodle_get_config()

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

sloodle_validate_prim_password_verbose (line 550)

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

An array is written to by reference, each element containing error codes. Each error code is a word. The full text of the error message may be obtained from the string file by looking for "primpass:errorcode".

• return: True if the prim password is valid, or false otherwise

• string $password: The password to validate
• array &$errors: An array (passed by reference) which will contain any error messages

sloodle_view (line 994)

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

Outputs error text in SLOODLE debug mode.

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

• string $feature: The name of a feature to view ("course", "user", "users"), or "module" to indicate that we are viewing some kind of module. Note: features should contain only alphanumric characters.