Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/mod/data/classes/privacy/ -> datafield_provider.php (source)

[Source view]

Contains interface datafield_provider

Copyright: 2018 Marina Glancy
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 78 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

datafield_provider:: (2 methods):
  export_data_content()
  delete_data_content()


Interface: datafield_provider  - X-Ref

Interface datafield_provider, all datafield plugins need to implement it

export_data_content($context, $recordobj, $fieldobj, $contentobj, $defaultvalue)   X-Ref
Exports data about one record in {data_content} table.

Datafield plugins providers should implement this method to:
- preprocess references to files in the response (examples - textarea, picture, file)
- make content more human-readable (example - replace values separators in multimenu, format date in date)
- add more information about the field itself (example - list all options for menu, multimenu, radio)

Sample implementation (from datafield_textarea):

$defaultvalue->content = writer::with_context($context)
->rewrite_pluginfile_urls([$recordobj->id, $contentobj->id], 'mod_data', 'content', $contentobj->id,
$defaultvalue->content);
writer::with_context($context)->export_data([$recordobj->id, $contentobj->id], $defaultvalue);

param: \context_module $context
param: \stdClass $recordobj record from DB table {data_records}
param: \stdClass $fieldobj record from DB table {data_fields}
param: \stdClass $contentobj record from DB table {data_content}
param: \stdClass $defaultvalue pre-populated default value that most of plugins will use

delete_data_content($context, $recordobj, $fieldobj, $contentobj)   X-Ref
Allows plugins to delete locally stored data.

Usually datafield plugins do not store anything and this method will be empty.

param: \context_module $context
param: \stdClass $recordobj record from DB table {data_records}
param: \stdClass $fieldobj record from DB table {data_fields}
param: \stdClass $contentobj record from DB table {data_content}