 |
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
|
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
Classes | |
| class | data_field_base |
| class | data_preset_existing_importer |
| Data preset importer for existing presets. More... | |
| class | data_preset_importer |
| Abstract class used for data preset importers. More... | |
| class | data_preset_upload_importer |
| Data preset importer for uploaded presets. More... | |
Functions | |
| data_add_instance ($data, $mform=null) | |
| Adds an instance of a data. | |
| object | data_add_record ($data, $groupid=0, $userid=null, bool $approved=true) |
| function that takes in a dataid and adds a record this is used everytime an add template is submitted | |
| object | data_append_new_field_to_templates ($data, $newfieldname) |
| Appends a new field at the end of the form template. | |
| data_atmaxentries ($data) | |
| has a user reached the max number of entries? | |
| data_check_updates_since (cm_info $cm, $from, $filter=array()) | |
| data_comment_permissions ($comment_param) | |
| Running addtional permission check on plugin, for example, plugins may have switch to turn on/off comments option, this callback will affect UI display, not like pluginname_comment_validate only throw exceptions. | |
| data_comment_validate ($comment_param) | |
| Validate comment parameter before perform other comments actions. | |
| data_convert_arrays_to_strings (&$fieldinput) | |
| object | data_convert_to_roles ($data, $teacherroles=array(), $studentroles=array(), $cmid=NULL) |
| Converts a database (module instance) to use the Roles System. | |
| object | data_delete_instance ($id) |
| deletes an instance of a data | |
| data_delete_record ($recordid, $data, $courseid, $cmid) | |
| Delete a record entry. | |
| data_delete_site_preset ($name) | |
| Deletes a saved preset. | |
| data_extend_navigation ($navigation, $course, $module, $cm) | |
| data_extend_settings_navigation (settings_navigation $settings, navigation_node $datanode) | |
| Adds module specific settings to the settings block. | |
| data_fieldname_exists ($name, $dataid, $fieldid=0) | |
| data_generate_default_template (&$data, $template, $recordid=0, $form=false, $update=true) | |
| Given a template and a dataid, generate a default case template. | |
| data_generate_tag_form ($recordid=false, $selected=[]) | |
| Build the form elements to manage tags for a record. | |
| data_get_advance_search_ids ($recordids, $searcharray, $dataid) | |
| Get the ids of all the records that match that advanced search criteria This goes and loops through each criterion one at a time until it either runs out of records or returns a subset of records. | |
| data_get_advanced_search_sql ($sort, $data, $recordids, $selectdata, $sortorder) | |
| Returns an array with an sql string for advanced searches and the parameters that go with them. | |
| data_get_all_recordids ($dataid, $selectdata='', $params=null) | |
| Get all of the record ids from a database activity. | |
| data_get_available_presets ($context) | |
| Returns an array of all the available presets. | |
| data_get_available_site_presets ($context, array $presets=array()) | |
| Gets an array of all of the presets that users have saved to the site. | |
| data_get_config ($database, $key=null, $default=null) | |
| Fetch the configuration for this database activity. | |
| data_get_coursemodule_info ($coursemodule) | |
| Add a get_coursemodule_info function in case any database type wants to add 'extra' information for the course (see resource). | |
| data_get_extra_capabilities () | |
| Returns all other caps used in module. | |
| object | data_get_field (stdClass $field, stdClass $data, ?stdClass $cm=null) |
| returns a subclass field object given a record of the field, used to invoke plugin methods input: $param $field - record from db | |
| object | data_get_field_from_id ($fieldid, $data) |
| given a field id this function creates an instance of the particular subfield class | |
| object | data_get_field_from_name ($name, $data) |
| given a field name this function creates an instance of the particular subfield class | |
| object | data_get_field_new ($type, $data) |
| given a field id this function creates an instance of the particular subfield class | |
| data_get_file_areas ($course, $cm, $context) | |
| Lists all browsable file areas. | |
| data_get_file_info ($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) | |
| File browsing support for data module. | |
| data_get_post_actions () | |
| List the actions that correspond to a post of this module. | |
| data_get_recordids ($alias, $searcharray, $dataid, $recordids) | |
| Gets the record IDs given the search criteria. | |
| object | data_get_user_grades ($data, $userid=0) |
| Return grade for given user or all users. | |
| data_get_view_actions () | |
| List the actions that correspond to a view of this module. | |
| data_grade_item_delete ($data) | |
| Delete grade item for given data. | |
| data_grade_item_update ($data, $grades=NULL) | |
| Update/create grade item for given data. | |
| data_in_readonly_period ($data) | |
| Check whether the specified database activity is currently in a read-only period. | |
| object | data_isowner ($record) |
| Given record object (or id), returns true if the record belongs to the current user. | |
| object | data_numentries ($data, $userid=null) |
| returns the number of entries already made by this user | |
| data_page_type_list ($pagetype, $parentcontext, $currentcontext) | |
| Return a list of page types. | |
| data_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) | |
| Serves the data attachments. | |
| data_preset_name ($shortname, $path) | |
| Returns the best name to show for a preset. | |
| object | data_preset_path ($course, $userid, $shortname) |
| @global object | |
| data_presets_export ($course, $cm, $data, $tostorage=false) | |
| Export current fields and presets. | |
| moodle_database | data_presets_generate_xml ($course, $cm, $data) |
| Generates the XML for the database module provided. | |
| data_presets_save ($course, $cm, $data, $path) | |
| Save the database configuration as a preset. | |
| data_print_header ($course, $cm, $data, $currenttab='', string $actionbar='') | |
| Prints the heads for a page. | |
| object | data_print_preference_form ($data, $perpage, $search, $sort='', $order='ASC', $search_array='', $advanced=0, $mode='') |
| function that takes in the current data, number of items per page, a search string and prints a preference box in view.php | |
| object | data_print_ratings ($data, $record, bool $print=true) |
| @global object | |
| data_print_template ($templatename, $records, $data, $search='', $page=0, $return=false, moodle_url $jumpurl=null) | |
| takes a list of records, the current data, a search string, and mode to display prints the translated template | |
| data_process_submission (stdClass $mod, $fields, stdClass $datarecord) | |
| Check for required fields, and build a list of fields to be updated in a submission. | |
| data_rating_permissions ($contextid, $component, $ratingarea) | |
| Return rating related permissions. | |
| data_rating_validate ($params) | |
| Validates a submitted rating. | |
| data_refresh_events ($courseid=0, $instance=null, $cm=null) | |
| This standard function will check all instances of this module and make sure there are up-to-date events created for each of them. | |
| object | data_replace_field_in_templates ($data, $searchfieldname, $newfieldname) |
| Search for a field name and replaces it with another one in all the form templates. | |
| data_reset_course_form_defaults ($course) | |
| Course reset form defaults. | |
| data_reset_course_form_definition (&$mform) | |
| Implementation of the function for printing the form elements that control whether the course reset functionality affects the data. | |
| object | data_reset_gradebook ($courseid, $type='') |
| Removes all grades from gradebook. | |
| object | data_reset_userdata ($data) |
| Actual implementation of the reset course functionality, delete all the data responses for course $data->courseid. | |
| data_set_config (&$database, $key, $value) | |
| Update the configuration for this database activity. | |
| data_supports ($feature) | |
| object | data_tags_check ($dataid, $template) |
| check the multple existence any tag in a template | |
| data_update_completion_state ($data, $course, $cm) | |
| Sets the automatic completion state for this database item based on the count of on its entries. | |
| data_update_grades ($data, $userid=0, $nullifnone=true) | |
| Update activity grades. | |
| object | data_update_instance ($data) |
| updates an instance of a data | |
| data_user_can_add_entry ($data, $currentgroup, $groupmode, $context=null) | |
| Can user add more entries? | |
| data_user_can_delete_preset ($context, $preset) | |
| Checks to see if the user has permission to delete the preset. | |
| data_user_can_manage_entry ($record, $data, $context) | |
| Check whether the current user is allowed to manage the given record considering manageentries capability, data_in_readonly_period() result, ownership (determined by data_isowner()) and manageapproved setting. | |
| object | data_user_complete ($course, $user, $mod, $data) |
| Prints all the records uploaded by this user. | |
| object | data_user_outline ($course, $user, $mod, $data) |
| returns a summary of data activity of this user | |
| data_view ($data, $course, $cm, $context) | |
| Mark the activity completed (if required) and trigger the course_module_viewed event. | |
| is_directory_a_preset ($directory) | |
| Check if the files in a directory are the expected for a preset. | |
| mod_data_core_calendar_event_timestart_updated (\calendar_event $event, stdClass $data) | |
| This function will update the data module according to the event that has been modified. | |
| mod_data_core_calendar_get_event_action_string (string $eventtype) | |
| Callback to fetch the activity event type lang string. | |
| mod_data_core_calendar_get_valid_event_timestart_range (\calendar_event $event, stdClass $instance) | |
| This function calculates the minimum and maximum cutoff values for the timestart of the given event. | |
| mod_data_core_calendar_provide_event_action (calendar_event $event, core_calendar\action_factory $factory, int $userid=0) | |
| This function receives a calendar event and returns the action associated with it, or null if there is none. | |
| mod_data_get_completion_active_rule_descriptions ($cm) | |
| Callback which returns human-readable strings describing the active completion custom rules for the module instance. | |
| mod_data_get_fontawesome_icon_map () | |
| Get icon mapping for font-awesome. | |
| mod_data_rating_can_see_item_ratings ($params) | |
| Can the current user see ratings for a given itemid? | |
1.11.0