Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]

Defines classes used to handle backup settings

Copyright: 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 219 lines (7 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 23 classes

backup_generic_setting:: (0 methods):

backup_filename_setting:: (2 methods):
  __construct()
  set_ui_filename()

backup_users_setting:: (0 methods):

backup_permissions_setting:: (0 methods):

backup_groups_setting:: (0 methods):

backup_customfield_setting:: (0 methods):

backup_activities_setting:: (0 methods):

backup_anonymize_setting:: (0 methods):

backup_role_assignments_setting:: (0 methods):

backup_logs_setting:: (0 methods):

backup_comments_setting:: (0 methods):

backup_badges_setting:: (0 methods):

backup_calendarevents_setting:: (0 methods):

backup_userscompletion_setting:: (0 methods):

backup_competencies_setting:: (1 method):
  __construct()

backup_section_generic_setting:: (0 methods):

backup_section_included_setting:: (0 methods):

backup_section_userinfo_setting:: (0 methods):

backup_activity_generic_setting:: (0 methods):

backup_activity_included_setting:: (0 methods):

backup_activity_userinfo_setting:: (0 methods):

backup_contentbankcontent_setting:: (0 methods):

backup_xapistate_setting:: (0 methods):


Class: backup_generic_setting  - X-Ref

root generic setting to store different things without dependencies

Class: backup_filename_setting  - X-Ref

root setting to handle backup file names (no dependencies nor anything else)

__construct($name, $vtype, $value = null, $visibility = self::VISIBLE, $status = self::NOT_LOCKED)   X-Ref
Instantiates a setting object

param: string $name Name of the setting
param: string $vtype Type of the setting, eg {@link base_setting::IS_TEXT}
param: mixed $value Value of the setting
param: bool $visibility Is the setting visible in the UI, eg {@link base_setting::VISIBLE}
param: int $status Status of the setting with regards to the locking, eg {@link base_setting::NOT_LOCKED}

set_ui_filename($label, $value, array $options = null)   X-Ref
No description

Class: backup_users_setting  - X-Ref

root setting to control if backup will include user information
A lot of other settings are dependent of this (module's user info,
grades user info, messages, blogs...

Class: backup_permissions_setting  - X-Ref

root setting to control if backup will include permission information by roles

Class: backup_groups_setting  - X-Ref

root setting to control if backup will include group information depends on @backup_users_setting

Class: backup_customfield_setting  - X-Ref

root setting to control if backup will include custom field information

Class: backup_activities_setting  - X-Ref

root setting to control if backup will include activities or no.
A lot of other settings (_included at activity levels)
are dependent of this setting

Class: backup_anonymize_setting  - X-Ref

root setting to control if backup will generate anonymized
user info or no, depends of @backup_users_setting so only is
available if the former is enabled (apart from security
that can change it

Class: backup_role_assignments_setting  - X-Ref

root setting to control if backup will include
role assignments or no (any level), depends of @backup_users_setting
exactly in the same way than @backup_anonymize_setting so we extend from it

Class: backup_logs_setting  - X-Ref

root setting to control if backup will include
logs or no (any level), depends of @backup_users_setting
exactly in the same way than @backup_anonymize_setting so we extend from it

Class: backup_comments_setting  - X-Ref

root setting to control if backup will include
comments or no (any level), depends of @backup_users_setting
exactly in the same way than @backup_anonymize_setting so we extend from it

Class: backup_badges_setting  - X-Ref

root setting to control if backup will include badges or not,
depends on @backup_activities_setting

Class: backup_calendarevents_setting  - X-Ref

root setting to control if backup will include
calender events or no (any level), depends of @backup_users_setting
exactly in the same way than @backup_anonymize_setting so we extend from it

Class: backup_userscompletion_setting  - X-Ref

root setting to control if backup will include
users completion data or no (any level), depends of @backup_users_setting
exactly in the same way than @backup_anonymize_setting so we extend from it

Class: backup_competencies_setting  - X-Ref

root setting to control if backup will include competencies or not.

__construct()   X-Ref
backup_competencies_setting constructor.


Class: backup_section_generic_setting  - X-Ref

generic section setting to pass various settings between tasks and steps

Class: backup_section_included_setting  - X-Ref

Setting to define if one section is included or no. Activities _included
settings depend of them if available

Class: backup_section_userinfo_setting  - X-Ref

section backup setting to control if section will include
user information or no, depends of @backup_users_setting

Class: backup_activity_generic_setting  - X-Ref

generic activity setting to pass various settings between tasks and steps

Class: backup_activity_included_setting  - X-Ref

activity backup setting to control if activity will
be included or no, depends of @backup_activities_setting and
optionally parent section included setting

Class: backup_activity_userinfo_setting  - X-Ref

activity backup setting to control if activity will include
user information or no, depends of @backup_users_setting

Class: backup_contentbankcontent_setting  - X-Ref

Root setting to control if backup will include content bank content or no

Class: backup_xapistate_setting  - X-Ref

Root setting to control if backup will include xAPI state or not.