Constructor: set defaults
mr_preferences
__construct
(int $courseid, string $plugin)
-
int
$courseid: Course ID
-
string
$plugin: Plugin name, EG: blocks/blockname, block_blockname, etc
Delete a preference
mr_preferences
delete
(
string $name, [
string $plugin =
NULL], [
int $courseid =
NULL])
-
string
$name: Preference name
-
string
$plugin: Override plugin name
-
int
$courseid: Override course ID
Get a preference
mixed
get
(string $name, [mixed $default = NULL], [string $plugin = NULL], [int $courseid = NULL])
-
string
$name: Preference name
-
mixed
$default: Return this value if preference is not found
-
string
$plugin: Override plugin name
-
int
$courseid: Override course ID
Get current courseid
int
get_courseid
()
Get current plugin value
string
get_plugin
()
Load the preferences for a user
Helper method - handle passed courseid and plugin values
void
process_args
( &$courseid, &$plugin, int $courseid, string $plugin)
-
int
$courseid: Course ID
-
string
$plugin: Plugin name
-
&$courseid
-
&$plugin
Set a preference
mr_preferences
set
(
string $name,
mixed $value, [
string $plugin =
NULL], [
int $courseid =
NULL])
-
string
$name: Preference name
-
mixed
$value: Value to save
-
string
$plugin: Override plugin name
-
int
$courseid: Override course ID