Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
Abstract class containing all the common stuff for course backup settings. More...
Public Member Functions | ||||||||||||||||
__construct ($name, $vtype, $value=null, $visibility=self::VISIBLE, $status=self::NOT_LOCKED) | ||||||||||||||||
{{Instantiates a setting object.
| ||||||||||||||||
add_dependency (base_setting $dependentsetting, $type=setting_dependency::DISABLED_VALUE, $options=array()) | ||||||||||||||||
Quick method to add a dependency to this setting. | ||||||||||||||||
calculate_checksum () | ||||||||||||||||
This function will return one unique and stable checksum for one instance of the class implementing it. | ||||||||||||||||
destroy () | ||||||||||||||||
Destroy all circular references. | ||||||||||||||||
get_dependencies () | ||||||||||||||||
get_help () | ||||||||||||||||
Gets the help string params for this setting if it has been set. | ||||||||||||||||
get_level () | ||||||||||||||||
get_my_dependency_properties ($settingname=null) | ||||||||||||||||
Gets an array of properties for all of the dependencies that will affect this setting. | ||||||||||||||||
get_name () | ||||||||||||||||
get_param_validation () | ||||||||||||||||
Get the PARAM_XXXX validation to be applied to the setting. | ||||||||||||||||
get_settings_depended_on () | ||||||||||||||||
Returns all of the dependencies that affect this setting. | ||||||||||||||||
get_status () | ||||||||||||||||
get_ui () | ||||||||||||||||
Gets the user interface for this setting. | ||||||||||||||||
get_ui_name () | ||||||||||||||||
get_ui_type () | ||||||||||||||||
get_value () | ||||||||||||||||
get_visibility () | ||||||||||||||||
has_dependencies_on_settings () | ||||||||||||||||
Checks if this setting is dependent on any other settings. | ||||||||||||||||
has_dependent_settings () | ||||||||||||||||
Checks if there are other settings that are dependent on this setting. | ||||||||||||||||
has_help () | ||||||||||||||||
Returns true if help has been set for this setting. | ||||||||||||||||
is_checksum_correct ($checksum) | ||||||||||||||||
Given one checksum, returns if matches object's checksum (true) or no (false) | ||||||||||||||||
make_ui ($type, $label, array $attributes=null, array $options=null) | ||||||||||||||||
Creates and sets a user interface for this setting given appropriate arguments. | ||||||||||||||||
register_dependency (setting_dependency $dependency) | ||||||||||||||||
Adds a dependency where another setting depends on this setting. | ||||||||||||||||
set_help ($identifier, $component='moodle') | ||||||||||||||||
Sets a help string for this setting. | ||||||||||||||||
set_status ($status) | ||||||||||||||||
set_ui (backup_setting_ui $ui) | ||||||||||||||||
Sets the user interface for this setting. | ||||||||||||||||
set_value ($value) | ||||||||||||||||
set_visibility ($visibility) | ||||||||||||||||
Protected Member Functions | |
inform_dependencies ($ctype, $oldv) | |
is_circular_reference ($obj) | |
register_dependent_dependency (setting_dependency $dependency) | |
Adds a dependency where this setting is dependent on another. | |
validate_status ($status) | |
validate_value ($vtype, $value) | |
validate_visibility ($visibility) | |
Protected Attributes | |
setting_dependency[] | $dependencies = array() |
$dependenton = array() | |
array | $help = array() |
An array that contains the identifier and component of a help string if one has been set. | |
int | $level |
Level of the setting, eg self::ROOT_LEVEL. | |
$name | |
$status | |
backup_setting_ui backup_setting_ui_checkbox backup_setting_ui_radio backup_setting_ui_select backup_setting_ui_text | $uisetting |
The user interface for this setting. | |
$unlockedvalue | |
$value | |
$visibility | |
$vtype | |
Abstract class containing all the common stuff for course backup settings.
TODO: Finish phpdocs
course_backup_setting::__construct | ( | $name, | |
$vtype, | |||
$value = null, | |||
$visibility = self::VISIBLE, | |||
$status = self::NOT_LOCKED ) |
{{Instantiates a setting object.
string | $name | Name of the setting |
string | $vtype | Type of the setting, eg self::IS_TEXT |
mixed | $value | Value of the setting |
bool | $visibility | Is the setting visible in the UI, eg self::VISIBLE |
int | $status | Status of the setting with regards to the locking, eg self::NOT_LOCKED |
Reimplemented from backup_setting.
Reimplemented in restore_course_generic_text_setting.
|
inherited |
Quick method to add a dependency to this setting.
The dependency created is done so by inspecting this setting and the setting that is passed in as the dependent setting.
base_setting | $dependentsetting | |
int | $type | One of setting_dependency::* |
array | $options |
Reimplemented from base_setting.
|
inherited |
This function will return one unique and stable checksum for one instance of the class implementing it.
It's each implementation responsibility to do it recursively if needed and use optional store (caching) of the checksum if necessary/possible
Implements checksumable.
|
inherited |
Destroy all circular references.
It helps PHP 5.2 a lot!
|
inherited |
Gets the help string params for this setting if it has been set.
array|false | An array (identifier, component) or false if not set |
|
inherited |
int | Level of the setting, eg self::ROOT_LEVEL |
|
inherited |
Gets an array of properties for all of the dependencies that will affect this setting.
This method returns an array rather than the dependencies in order to minimise the memory footprint of for the potentially huge recursive dependency structure that we may be dealing with.
This method also ensures that all dependencies are transmuted to affect the setting in question and that we don't provide any duplicates.
string | null | $settingname |
array |
|
inherited |
Get the PARAM_XXXX validation to be applied to the setting.
string | The PARAM_XXXX constant of null if the setting type is not defined |
|
inherited |
Returns all of the dependencies that affect this setting.
e.g. settings this setting depends on.
array | Array of setting_dependency's |
|
inherited |
Gets the user interface for this setting.
base_setting_ui |
|
inherited |
Checks if this setting is dependent on any other settings.
bool | True if this setting is dependent on any other settings |
|
inherited |
Checks if there are other settings that are dependent on this setting.
bool | True if there are other settings that are dependent on this setting |
|
inherited |
Returns true if help has been set for this setting.
cool |
|
inherited |
Given one checksum, returns if matches object's checksum (true) or no (false)
Implements checksumable.
|
inherited |
Creates and sets a user interface for this setting given appropriate arguments.
int | $type | |
string | $label | |
array | $attributes | |
array | $options |
|
inherited |
Adds a dependency where another setting depends on this setting.
setting_dependency | $dependency |
|
protectedinherited |
Adds a dependency where this setting is dependent on another.
This should only be called internally once we are sure it is not cicrular.
setting_dependency | $dependency |
|
inherited |
Sets a help string for this setting.
string | $identifier | |
string | $component |
|
inherited |
Sets the user interface for this setting.
base_setting_ui | $ui |
|
protectedinherited |
Reimplemented in restore_course_defaultcustom_setting.