Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
Interface customfield_provider, all customfield plugins need to implement it. More...
Static Public Member Functions | |
static | before_delete_data (string $dataidstest, array $params, array $contextids) |
Allows plugins to delete everything they store related to the data (usually files) | |
static | before_delete_fields (string $fieldidstest, array $params, array $contextids) |
Allows plugins to delete everything they store related to the field configuration (usually files) | |
static | export_customfield_data (data_controller $data, stdClass $exportdata, array $subcontext) |
Preprocesses data object that is going to be exported. | |
Interface customfield_provider, all customfield plugins need to implement it.
|
static |
Allows plugins to delete everything they store related to the data (usually files)
If plugin does not store any related files or other information, implement as an empty function
string | $dataidstest | select query for data id (note that it may also return data for other field types) |
array | $params | named parameters for the select query |
array | $contextids | list of affected data contexts |
mixed |
Implemented in customfield_checkbox\privacy\provider, customfield_date\privacy\provider, customfield_select\privacy\provider, customfield_text\privacy\provider, and customfield_textarea\privacy\provider.
|
static |
Allows plugins to delete everything they store related to the field configuration (usually files)
The implementation should not delete data or anything related to the data, since "before_delete_data" is invoked separately.
If plugin does not store any related files or other information, implement as an empty function
string | $fieldidstest | select query for field id (note that it may also return fields of other types) |
array | $params | named parameters for the select query |
int[] | $contextids | list of affected configuration contexts |
Implemented in customfield_checkbox\privacy\provider, customfield_date\privacy\provider, customfield_select\privacy\provider, customfield_text\privacy\provider, and customfield_textarea\privacy\provider.
|
static |
Preprocesses data object that is going to be exported.
Minimum implementation: writer\with_context($data->get_context())->export_data($subcontext, $exportdata);
data_controller | $data | |
stdClass | $exportdata | generated object to be exported |
array | $subcontext | subcontext to use when exporting |
mixed |
Implemented in customfield_checkbox\privacy\provider, customfield_date\privacy\provider, customfield_select\privacy\provider, customfield_text\privacy\provider, and customfield_textarea\privacy\provider.