|
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
Topics | |
| backup | |
| external | |
| files | |
| grade | |
| log | |
| rss | |
| test | |
Directories | |
| directory | analytics |
| | |
| directory | backup |
| | |
| directory | field |
| | |
| directory | local |
| | |
| directory | preset |
| | |
Namespaces | |
| namespace | mod_data |
| | |
| namespace | mod_data\analytics\indicator |
| Activity base class. | |
| namespace | mod_data\completion |
| | |
| namespace | mod_data\event |
| The mod_data comment created event. | |
| namespace | mod_data\external |
| Class for exporting content associated to a record. | |
| namespace | mod_data\form |
| | |
| namespace | mod_data\local\exporter |
| | |
| namespace | mod_data\local\importer |
| | |
| namespace | mod_data\output |
| | |
| namespace | mod_data\plugininfo |
| Subplugin info class. | |
| namespace | mod_data\privacy |
| Contains interface datafield_provider. | |
| namespace | mod_data\search |
| Search area for mod_data activities. | |
Classes | |
| class | backup_data_activity_structure_step |
| Define all the backup steps that will be used by the backup_data_activity_task. More... | |
| class | data_existing_preset_form |
| class | data_export_form |
| class | data_import_preset_zip_form |
| Import preset class. More... | |
| class | data_save_preset_form |
| class | mod_data\analytics\indicator\activity_base |
| Activity base class. More... | |
| class | mod_data\analytics\indicator\cognitive_depth |
| Cognitive depth indicator - data. More... | |
| class | mod_data\analytics\indicator\social_breadth |
| Social breadth indicator - data. More... | |
| class | mod_data\completion\custom_completion |
| Activity custom completion subclass for the data activity. More... | |
| class | mod_data\dates |
| Class for fetching the important dates in mod_data for a given module instance and a user. More... | |
| class | mod_data\event\comment_created |
| The mod_data comment created event class. More... | |
| class | mod_data\event\comment_deleted |
| The mod_data comment deleted event class. More... | |
| class | mod_data\event\course_module_instance_list_viewed |
| The mod_data instance list viewed event class. More... | |
| class | mod_data\event\course_module_viewed |
| The mod_data course module viewed event class. More... | |
| class | mod_data\event\field_created |
| The mod_data field created event class. More... | |
| class | mod_data\event\field_deleted |
| The mod_data field deleted event class. More... | |
| class | mod_data\event\field_updated |
| The mod_data field updated event class. More... | |
| class | mod_data\external\content_exporter |
| Class for exporting content associated to a record. More... | |
| class | mod_data\external\database_summary_exporter |
| Class for exporting partial database data (some fields are only viewable by admins). More... | |
| class | mod_data\external\delete_saved_preset |
| This is the external method for deleting a saved preset. More... | |
| class | mod_data\external\field_exporter |
| Class for exporting field data. More... | |
| class | mod_data\external\get_mapping_information |
| This is the external method for deleting a saved preset. More... | |
| class | mod_data\external\record_exporter |
| Class for exporting record data. More... | |
| class | mod_data\form\import_presets |
| Import presets form. More... | |
| class | mod_data\form\save_as_preset |
| Save database as preset form. More... | |
| class | mod_data\local\exporter\csv_entries_exporter |
| CSV entries exporter for mod_data. More... | |
| class | mod_data\local\exporter\entries_exporter |
| Exporter class for exporting data and - if needed - files as well in a zip archive. More... | |
| class | mod_data\local\exporter\ods_entries_exporter |
| ODS entries exporter for mod_data. More... | |
| class | mod_data\local\exporter\utils |
| Utility class for exporting data from a mod_data instance. More... | |
| class | mod_data\local\importer\csv_entries_importer |
| CSV entries_importer class for importing data and - if needed - files as well from a zip archive. More... | |
| class | mod_data\local\importer\entries_importer |
| Importer class for importing data and - if needed - files as well from a zip archive. More... | |
| class | mod_data\local\importer\preset_existing_importer |
| Data preset importer for existing presets. More... | |
| class | mod_data\local\importer\preset_importer |
| Abstract class used for data preset importers. More... | |
| class | mod_data\local\importer\preset_upload_importer |
| Data preset importer for uploaded presets. More... | |
| class | mod_data\manager |
| Class manager for database activity. More... | |
| class | mod_data\output\action_bar |
| Class responsible for generating the action bar elements in the database module pages. More... | |
| class | mod_data\output\add_entries_action |
| Renderable class for the Add entries button in the database activity. More... | |
| class | mod_data\output\defaulttemplate |
| Renderable class for the default templates in the database activity. More... | |
| class | mod_data\output\empty_database_action_bar |
| Renderable class for the action bar elements for an empty database activity. More... | |
| class | mod_data\output\fields_action_bar |
| Renderable class for the action bar elements in the field pages in the database activity. More... | |
| class | mod_data\output\fields_mappings_action_bar |
| Renderable class for the action bar elements in the fields mapping page in the database activity. More... | |
| class | mod_data\output\preset_preview |
| Preset preview output class. More... | |
| class | mod_data\output\presets |
| Renderable class for the presets table in the database activity. More... | |
| class | mod_data\output\presets_action_bar |
| Renderable class for the action bar elements in the presets page in the database activity. More... | |
| class | mod_data\output\template_editor |
| Renderable class for template editor. More... | |
| class | mod_data\output\template_editor_tools |
| Renderable class for template editor tools. More... | |
| class | mod_data\output\templates_action_bar |
| Renderable class for the action bar elements in the template pages in the database activity. More... | |
| class | mod_data\output\view_action_bar |
| Renderable class for the action bar elements in the view pages in the database activity. More... | |
| class | mod_data\output\view_footer |
| Renderable class for sticky footer in the view pages of the database activity. More... | |
| class | mod_data\output\zero_state_action_bar |
| Renderable class for the action bar elements in the zero state (no fields created) pages in the database activity. More... | |
| class | mod_data\plugininfo\datafield |
| class | mod_data\plugininfo\datapreset |
| class | mod_data\preset |
| Class preset for database activity. More... | |
| interface | mod_data\privacy\datafield_provider |
| Interface datafield_provider, all datafield plugins need to implement it. More... | |
| class | mod_data\privacy\provider |
| Implementation of the privacy subsystem plugin provider for the database activity module. More... | |
| class | mod_data\search\activity |
| Search area for mod_data activities. More... | |
| class | mod_data\search\entry |
| Search area for mod_data activity entries. More... | |
| class | mod_data\search\sortedcontentqueue |
| Priority Queue class to sort out db entry contents. More... | |
| class | mod_data\template |
| Class template for database activity. More... | |
| class | mod_data_renderer |
| class | moodle1_mod_data_handler |
| Database conversion handler. More... | |
| class | restore_data_activity_structure_step |
| Define all the restore steps that will be used by the restore_data_activity_task. More... | |
| class | restore_data_activity_task |
| data restore task that provides all the settings and steps to perform one complete restore of the activity More... | |
Functions | |
| object | data_export_csv ($export, $delimiter_name, $database, $count, $return=false) |
| object | data_export_ods ($export, $dataname, $count) |
| object | data_export_xls ($export, $dataname, $count) |
| data_get_completion_state () | |
| List of deprecated mod_data functions. | |
| object | data_get_exportdata ($dataid, $fields, $selectedfields, $currentgroup=0, $context=null, $userdetails=false, $time=false, $approval=false, $tags=false) |
| data_import_csv ($cm, $data, &$csvdata, $encoding, $fielddelimiter) | |
Variables | |
| $capabilities | |
| $plugin = 2023100400 | |
| $tagareas | |
| $plugin | component = 'mod_data' |
| $plugin | cron = 0 |
| if (!defined( 'MOODLE_INTERNAL')) | |
| Database module preset forms. | |
| $plugin | version = 2023100900 |
| object data_export_csv | ( | $export, | |
| $delimiter_name, | |||
| $database, | |||
| $count, | |||
| $return = false ) |
| array | $export | |
| string | $delimiter_name | |
| object | $database | |
| int | $count | |
| bool | $return |
| string|void |
| object data_export_ods | ( | $export, | |
| $dataname, | |||
| $count ) |
| array | $export | |
| string | $dataname | |
| int | $count | |
| string |
| object data_export_xls | ( | $export, | |
| $dataname, | |||
| $count ) |
| data_get_completion_state | ( | ) |
List of deprecated mod_data functions.
| object data_get_exportdata | ( | $dataid, | |
| $fields, | |||
| $selectedfields, | |||
| $currentgroup = 0, | |||
| $context = null, | |||
| $userdetails = false, | |||
| $time = false, | |||
| $approval = false, | |||
| $tags = false ) |
| int | $dataid | |
| array | $fields | |
| array | $selectedfields | |
| int | $currentgroup | group ID of the current group. This is used for exporting data while maintaining group divisions. |
| object | $context | the context in which the operation is performed (for capability checks) |
| bool | $userdetails | whether to include the details of the record author |
| bool | $time | whether to include time created/modified |
| bool | $approval | whether to include approval status |
| bool | $tags | whether to include tags |
| array |
| data_import_csv | ( | $cm, | |
| $data, | |||
| & | $csvdata, | ||
| $encoding, | |||
| $fielddelimiter ) |
| object | $cm | Course module of the data instance. |
| object | $data | The data instance. |
| string | $csvdata | The csv data to be imported. |
| string | $encoding | The encoding of csv data. |
| string | $fielddelimiter | The delimiter of the csv data. |
| int | Number of records added. |
| $tagareas |
| if(!defined('MOODLE_INTERNAL')) | ( | ! | defined 'MOODLE_INTERNAL' | ) |
Database module preset forms.