WebSVN – Moodle – Diff – /mod/data/lib.php

  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-use mod_data\manager;
-use mod_data\preset;
+use mod_data\manager;
 defined('MOODLE_INTERNAL') || die();
      * @param int $recordid
      * @param object $template
      * @return bool|string
      */
     function display_browse_field($recordid, $template) {
-        global $DB;
         $content = $this->get_data_content($recordid);
         if (!$content || !isset($content->content)) {
             return '';
+        }
         $options = new stdClass();
         if ($this->field->param1 == '1') {
             // We are autolinking this field, so disable linking within us.
             $options->filter = false;
+        }
         $options->para = false;
+        $format = !empty($content->content1) && !empty(trim($content->content1)) ? $content->content1 : null;
-        $str = format_text($content->content, $content->content1, $options);
+        $str = format_text($content->content, $format, $options);
         return $str;
+    }
     /**
      * @return string
      */
     function image() {
         global $OUTPUT;
-        return $OUTPUT->pix_icon('field/' . $this->type, $this->type, 'data');
+        return $OUTPUT->image_icon('icon', $this->type, 'datafield_' . $this->type);
+    }
     /**
         $selectedtags += $DB->get_records_sql_menu($sql, $params);
+    }
     $tags += $selectedtags;
-    $str .= '<select class="custom-select" name="tags[]" id="tags" multiple>';
+    $str .= '<select class="form-select" name="tags[]" id="tags" multiple>';
     foreach ($tags as $tagid => $tag) {
         $selected = key_exists($tagid, $selectedtags) ? 'selected' : '';
         $str .= "<option value='$tag' $selected>$tag</option>";
     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, NULL, array('deleted'=>1));
+}
-// junk functions
-/**
- * takes a list of records, the current data, a search string,
- * and mode to display prints the translated template
- *
- * @deprecated since Moodle 4.1 MDL-75146 - please do not use this function any more.
- * @todo MDL-75189 Final deprecation in Moodle 4.5.
- * @param string $templatename the template name
- * @param array $records the entries records
- * @param stdClass $data the database instance object
- * @param string $search the current search term
- * @param int $page page number for pagination
- * @param bool $return if the result should be returned (true) or printed (false)
- * @param moodle_url|null $jumpurl a moodle_url by which to jump back to the record list (can be null)
- * @return mixed string with all parsed entries or nothing if $return is false
- */
-function data_print_template($templatename, $records, $data, $search='', $page=0, $return=false, moodle_url $jumpurl=null) {
-    debugging(
-        'data_print_template is deprecated. Use mod_data\\manager::get_template and mod_data\\template::parse_entries instead',
-        DEBUG_DEVELOPER
-    );
-    $options = [
-        'search' => $search,
-        'page' => $page,
-    ];
-    if ($jumpurl) {
-        $options['baseurl'] = $jumpurl;
-    }
-    $manager = manager::create_from_instance($data);
-    $parser = $manager->get_template($templatename, $options);
-    $content = $parser->parse_entries($records);
-    if ($return) {
-        return $content;
-    }
     echo $content;
 // junk functions
 /**
     $cm = get_coursemodule_from_instance('data', $data->id);
     $context = context_module::instance($cm->id);
     echo '<div class="datapreferences my-5">';
     echo '<form id="options" action="view.php" method="get">';
-    echo '<div class="d-flex">';
-    echo '<div>';
+    echo '<div class="d-flex flex-wrap align-items-center gap-1">';
     echo '<input type="hidden" name="d" value="'.$data->id.'" />';
     if ($mode =='asearch') {
         $advanced = 1;
         echo '<input type="hidden" name="mode" value="list" />';
+    }
     echo '<label for="pref_perpage">'.get_string('pagesize','data').'</label> ';
     $pagesizes = array(2=>2,3=>3,4=>4,5=>5,6=>6,7=>7,8=>8,9=>9,10=>10,15=>15,
 =>20,30=>30,40=>40,50=>50,100=>100,200=>200,300=>300,400=>400,500=>500,1000=>1000);
     echo html_writer::select($pagesizes, 'perpage', $perpage, false, array('id' => 'pref_perpage',
-        'class' => 'custom-select mr-1'));
+        'class' => 'form-select me-1'));
     if ($advanced) {
         $regsearchclass = 'search_none';
         $advancedsearchclass = 'search_inline';
     } else {
         $regsearchclass = 'search_inline';
         $advancedsearchclass = 'search_none';
     }
-    echo '<div id="reg_search" class="' . $regsearchclass . ' mr-1" >';
+    echo '<div id="reg_search" class="' . $regsearchclass . ' me-1" >';
-    echo '<label for="pref_search" class="mr-1">' . get_string('search') . '</label><input type="text" ' .
+    echo '<label for="pref_search" class="me-1">' . get_string('search') . '</label><input type="text" ' .
-         'class="form-control d-inline-block align-middle w-auto mr-1" size="16" name="search" id= "pref_search" value="' . s($search) . '" /></div>';
+         'class="form-control d-inline-block align-middle w-auto me-1" size="16" name="search" id= "pref_search" value="' . s($search) . '" /></div>';
     echo '<label for="pref_sortby">'.get_string('sortby').'</label> ';
     // foreach field, print the option
-    echo '<select name="sort" id="pref_sortby" class="custom-select mr-1">';
+    echo '<select name="sort" id="pref_sortby" class="form-select me-1">';
     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'name')) {
         echo '<optgroup label="'.get_string('fields', 'data').'">';
         foreach ($fields as $field) {
+        }
+    }
     echo '</optgroup>';
     echo '</select>';
     echo '<label for="pref_order" class="accesshide">'.get_string('order').'</label>';
-    echo '<select id="pref_order" name="order" class="custom-select mr-1">';
+    echo '<select id="pref_order" name="order" class="form-select me-1">';
     if ($order == 'ASC') {
         echo '<option value="ASC" selected="selected">'.get_string('ascending','data').'</option>';
     } else {
         echo '<option value="ASC">'.get_string('ascending','data').'</option>';
+    }
     echo '<input type="hidden" name="advanced" value="0" />';
     echo '<input type="hidden" name="filter" value="1" />';
     echo '<input type="checkbox" id="advancedcheckbox" name="advanced" value="1" ' . $checked . ' ' .
          'onchange="showHideAdvSearch(this.checked);" class="mx-1" />' .
          '<label for="advancedcheckbox">' . get_string('advancedsearch', 'data') . '</label>';
-    echo '</div>';
-    echo '<div id="advsearch-save-sec" class="ml-auto '. $regsearchclass . '">';
+    echo '<div id="advsearch-save-sec" class="ms-3 '. $regsearchclass . '">';
     echo '<input type="submit" class="btn btn-secondary" value="' . get_string('savesettings', 'data') . '" />';
     echo '</div>';
     echo '</div>';
-    echo '<div>';
     echo '<br />';
     echo '<div class="' . $advancedsearchclass . '" id="data_adv_form">';
     echo '<tr><td>';
     echo preg_replace($patterns, $replacement, format_text($asearchtemplate, FORMAT_HTML, $options));
     echo '</td></tr>';
     echo '<tr><td colspan="4"><br/>' .
-         '<input type="submit" class="btn btn-primary mr-1" value="' . get_string('savesettings', 'data') . '" />' .
+         '<input type="submit" class="btn btn-primary me-1" value="' . get_string('savesettings', 'data') . '" />' .
          '<input type="submit" class="btn btn-secondary" name="resetadv" value="' . get_string('resetsettings', 'data') . '" />' .
          '</td></tr>';
     echo '</table>';
     echo '</div>';
+    }
     return true;
+}
-/**
- * Returns the best name to show for a preset
- *
- * @param string $shortname
- * @param  string $path
- * @return string
- * @deprecated since Moodle 4.1 MDL-75148 - please, use the preset::get_name_from_plugin() function instead.
- * @todo MDL-75189 This will be deleted in Moodle 4.5.
- * @see preset::get_name_from_plugin()
- */
-function data_preset_name($shortname, $path) {
-    debugging('data_preset_name() is deprecated. Please use preset::get_name_from_plugin() instead.', DEBUG_DEVELOPER);
-    return preset::get_name_from_plugin($shortname);
-}
-/**
- * Returns an array of all the available presets.
- *
- * @return array
- * @deprecated since Moodle 4.1 MDL-75148 - please, use the manager::get_available_presets() function instead.
- * @todo MDL-75189 This will be deleted in Moodle 4.5.
- * @see manager::get_available_presets()
- */
-function data_get_available_presets($context) {
-    debugging('data_get_available_presets() is deprecated. Please use manager::get_available_presets() instead.', DEBUG_DEVELOPER);
-    $cm = get_coursemodule_from_id('', $context->instanceid, 0, false, MUST_EXIST);
-    $manager = manager::create_from_coursemodule($cm);
-    return $manager->get_available_presets();
-}
-/**
- * Gets an array of all of the presets that users have saved to the site.
- *
- * @param stdClass $context The context that we are looking from.
- * @param array $presets
- * @return array An array of presets
- * @deprecated since Moodle 4.1 MDL-75148 - please, use the manager::get_available_saved_presets() function instead.
- * @todo MDL-75189 This will be deleted in Moodle 4.5.
- * @see manager::get_available_saved_presets()
- */
-function data_get_available_site_presets($context, array $presets=array()) {
-    debugging(
-        'data_get_available_site_presets() is deprecated. Please use manager::get_available_saved_presets() instead.',
-        DEBUG_DEVELOPER
-    );
-    $cm = get_coursemodule_from_id('', $context->instanceid, 0, false, MUST_EXIST);
-    $manager = manager::create_from_coursemodule($cm);
-    $savedpresets = $manager->get_available_saved_presets();
-    return array_merge($presets, $savedpresets);
-}
-/**
- * Deletes a saved preset.
- *
- * @param string $name
- * @return bool
- * @deprecated since Moodle 4.1 MDL-75187 - please, use the preset::delete() function instead.
- * @todo MDL-75189 This will be deleted in Moodle 4.5.
- * @see preset::delete()
- */
-function data_delete_site_preset($name) {
-    debugging('data_delete_site_preset() is deprecated. Please use preset::delete() instead.', DEBUG_DEVELOPER);
-    $fs = get_file_storage();
-    $files = $fs->get_directory_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/');
-    if (!empty($files)) {
-        foreach ($files as $file) {
-            $file->delete();
-        }
-    }
-    $dir = $fs->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/', '.');
-    if (!empty($dir)) {
-        $dir->delete();
-    }
-    return true;
-}
 /**
  * Prints the heads for a page
+ *
  * @param stdClass $course
  * @param stdClass $cm
+    }
     return true;
+}
-/**
- * Check if the files in a directory are the expected for a preset.
- *
- * @return bool Wheter the defined $directory has or not all the expected preset files.
- *
- * @deprecated since Moodle 4.1 MDL-75148 - please, use the preset::is_directory_a_preset() function instead.
- * @todo MDL-75189 This will be deleted in Moodle 4.5.
- * @see manager::is_directory_a_preset()
- */
-function is_directory_a_preset($directory) {
-    debugging('is_directory_a_preset() is deprecated. Please use preset::is_directory_a_preset() instead.', DEBUG_DEVELOPER);
-    return preset::is_directory_a_preset($directory);
-}
-/**
- * Abstract class used for data preset importers
- *
- * @deprecated since Moodle 4.1 MDL-75140 - please do not use this class any more.
- * @todo MDL-75189 Final deprecation in Moodle 4.5.
- */
-abstract class data_preset_importer {
-    protected $course;
-    protected $cm;
-    protected $module;
-    protected $directory;
-    /**
-     * Constructor
-     *
-     * @param stdClass $course
-     * @param stdClass $cm
-     * @param stdClass $module
-     * @param string $directory
-     */
-    public function __construct($course, $cm, $module, $directory) {
-        debugging(
-            'data_preset_importer is deprecated. Please use mod\\data\\local\\importer\\preset_importer instead',
-            DEBUG_DEVELOPER
-        );
-        $this->course = $course;
-        $this->cm = $cm;
-        $this->module = $module;
-        $this->directory = $directory;
-    }
-    /**
-     * Returns the name of the directory the preset is located in
-     * @return string
-     */
-    public function get_directory() {
-        return basename($this->directory);
-    }
-    /**
-     * Retreive the contents of a file. That file may either be in a conventional directory of the Moodle file storage
-     * @param file_storage $filestorage. should be null if using a conventional directory
-     * @param stored_file $fileobj the directory to look in. null if using a conventional directory
-     * @param string $dir the directory to look in. null if using the Moodle file storage
-     * @param string $filename the name of the file we want
-     * @return string the contents of the file or null if the file doesn't exist.
-     */
-    public function data_preset_get_file_contents(&$filestorage, &$fileobj, $dir, $filename) {
-        if(empty($filestorage) || empty($fileobj)) {
-            if (substr($dir, -1)!='/') {
-                $dir .= '/';
-            }
-            if (file_exists($dir.$filename)) {
-                return file_get_contents($dir.$filename);
-            } else {
-                return null;
-            }
-        } else {
-            if ($filestorage->file_exists(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename)) {
-                $file = $filestorage->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename);
-                return $file->get_content();
-            } else {
-                return null;
-            }
-        }
-    }
-    /**
-     * Gets the preset settings
-     * @global moodle_database $DB
-     * @return stdClass
-     */
-    public function get_preset_settings() {
-        global $DB, $CFG;
-        require_once($CFG->libdir.'/xmlize.php');
-        $fs = $fileobj = null;
-        if (!preset::is_directory_a_preset($this->directory)) {
-            //maybe the user requested a preset stored in the Moodle file storage
-            $fs = get_file_storage();
-            $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
-            //preset name to find will be the final element of the directory
-            $explodeddirectory = explode('/', $this->directory);
-            $presettofind = end($explodeddirectory);
-            //now go through the available files available and see if we can find it
-            foreach ($files as $file) {
-                if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory()) {
-                    continue;
-                }
-                $presetname = trim($file->get_filepath(), '/');
-                if ($presetname==$presettofind) {
-                    $this->directory = $presetname;
-                    $fileobj = $file;
-                }
-            }
-            if (empty($fileobj)) {
-                throw new \moodle_exception('invalidpreset', 'data', '', $this->directory);
-            }
-        }
-        $allowed_settings = array(
-            'intro',
-            'comments',
-            'requiredentries',
-            'requiredentriestoview',
-            'maxentries',
-            'rssarticles',
-            'approval',
-            'defaultsortdir',
-            'defaultsort');
-        $result = new stdClass;
-        $result->settings = new stdClass;
-        $result->importfields = array();
-        $result->currentfields = $DB->get_records('data_fields', array('dataid'=>$this->module->id));
-        if (!$result->currentfields) {
-            $result->currentfields = array();
-        }
-        /* Grab XML */
-        $presetxml = $this->data_preset_get_file_contents($fs, $fileobj, $this->directory,'preset.xml');
-        $parsedxml = xmlize($presetxml, 0);
-        /* First, do settings. Put in user friendly array. */
-        $settingsarray = $parsedxml['preset']['#']['settings'][0]['#'];
-        $result->settings = new StdClass();
-        foreach ($settingsarray as $setting => $value) {
-            if (!is_array($value) || !in_array($setting, $allowed_settings)) {
-                // unsupported setting
-                continue;
-            }
-            $result->settings->$setting = $value[0]['#'];
-        }
-        /* Now work out fields to user friendly array */
-        $fieldsarray = $parsedxml['preset']['#']['field'];
-        foreach ($fieldsarray as $field) {
-            if (!is_array($field)) {
-                continue;
-            }
-            $f = new StdClass();
-            foreach ($field['#'] as $param => $value) {
-                if (!is_array($value)) {
-                    continue;
-                }
-                $f->$param = $value[0]['#'];
-            }
-            $f->dataid = $this->module->id;
-            $f->type = clean_param($f->type, PARAM_ALPHA);
-            $result->importfields[] = $f;
-        }
-        /* Now add the HTML templates to the settings array so we can update d */
-        $result->settings->singletemplate     = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"singletemplate.html");
-        $result->settings->listtemplate       = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplate.html");
-        $result->settings->listtemplateheader = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplateheader.html");
-        $result->settings->listtemplatefooter = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplatefooter.html");
-        $result->settings->addtemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"addtemplate.html");
-        $result->settings->rsstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstemplate.html");
-        $result->settings->rsstitletemplate   = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstitletemplate.html");
-        $result->settings->csstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"csstemplate.css");
-        $result->settings->jstemplate         = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"jstemplate.js");
-        $result->settings->asearchtemplate    = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"asearchtemplate.html");
-        $result->settings->instance = $this->module->id;
-        return $result;
-    }
-    /**
-     * Import the preset into the given database module
-     * @return bool
-     */
-    function import($overwritesettings) {
-        global $DB, $CFG, $OUTPUT;
-        $params = $this->get_preset_settings();
-        $settings = $params->settings;
-        $newfields = $params->importfields;
-        $currentfields = $params->currentfields;
-        $preservedfields = array();
-        /* Maps fields and makes new ones */
-        if (!empty($newfields)) {
-            /* We require an injective mapping, and need to know what to protect */
-            foreach ($newfields as $nid => $newfield) {
-                $cid = optional_param("field_$nid", -1, PARAM_INT);
-                if ($cid == -1) {
-                    continue;
-                }
-                if (array_key_exists($cid, $preservedfields)){
-                    throw new \moodle_exception('notinjectivemap', 'data');
-                }
-                else $preservedfields[$cid] = true;
-            }
-            $missingfieldtypes = [];
-            foreach ($newfields as $nid => $newfield) {
-                $cid = optional_param("field_$nid", -1, PARAM_INT);
-                /* A mapping. Just need to change field params. Data kept. */
-                if ($cid != -1 and isset($currentfields[$cid])) {
-                    $fieldobject = data_get_field_from_id($currentfields[$cid]->id, $this->module);
-                    foreach ($newfield as $param => $value) {
-                        if ($param != "id") {
-                            $fieldobject->field->$param = $value;
-                        }
-                    }
-                    unset($fieldobject->field->similarfield);
-                    $fieldobject->update_field();
-                    unset($fieldobject);
-                } else {
-                    /* Make a new field */
-                    $filepath = "field/$newfield->type/field.class.php";
-                    if (!file_exists($filepath)) {
-                        $missingfieldtypes[] = $newfield->name;
-                        continue;
-                    }
-                    include_once($filepath);
-                    if (!isset($newfield->description)) {
-                        $newfield->description = '';
-                    }
-                    $classname = 'data_field_'.$newfield->type;
-                    $fieldclass = new $classname($newfield, $this->module);
-                    $fieldclass->insert_field();
-                    unset($fieldclass);
-                }
-            }
-            if (!empty($missingfieldtypes)) {
-                echo $OUTPUT->notification(get_string('missingfieldtypeimport', 'data') . html_writer::alist($missingfieldtypes));
-            }
-        }
-        /* Get rid of all old unused data */
-        foreach ($currentfields as $cid => $currentfield) {
-            if (!array_key_exists($cid, $preservedfields)) {
-                /* Data not used anymore so wipe! */
-                echo "Deleting field $currentfield->name<br />";
-                // Delete all information related to fields.
-                $todelete = data_get_field_from_id($currentfield->id, $this->module);
-                $todelete->delete_field();
-            }
-        }
-        // handle special settings here
-        if (!empty($settings->defaultsort)) {
-            if (is_numeric($settings->defaultsort)) {
-                // old broken value
-                $settings->defaultsort = 0;
-            } else {
-                $settings->defaultsort = (int)$DB->get_field('data_fields', 'id', array('dataid'=>$this->module->id, 'name'=>$settings->defaultsort));
-            }
-        } else {
-            $settings->defaultsort = 0;
-        }
-        // do we want to overwrite all current database settings?
-        if ($overwritesettings) {
-            // all supported settings
-            $overwrite = array_keys((array)$settings);
-        } else {
-            // only templates and sorting
-            $overwrite = array('singletemplate', 'listtemplate', 'listtemplateheader', 'listtemplatefooter',
-                               'addtemplate', 'rsstemplate', 'rsstitletemplate', 'csstemplate', 'jstemplate',
-                               'asearchtemplate', 'defaultsortdir', 'defaultsort');
-        }
-        // now overwrite current data settings
-        foreach ($this->module as $prop=>$unused) {
-            if (in_array($prop, $overwrite)) {
-                $this->module->$prop = $settings->$prop;
-            }
-        }
-        data_update_instance($this->module);
-        return $this->cleanup();
-    }
-    /**
-     * Any clean up routines should go here
-     * @return bool
-     */
-    public function cleanup() {
-        return true;
-    }
-}
-/**
- * Data preset importer for uploaded presets
- *
- * @deprecated since Moodle 4.1 MDL-75140 - please do not use this class any more.
- * @todo MDL-75189 Final deprecation in Moodle 4.5.
- */
-class data_preset_upload_importer extends data_preset_importer {
-    public function __construct($course, $cm, $module, $filepath) {
-        global $USER;
-        debugging(
-            'data_preset_upload_importer is deprecated. Please use mod\\data\\local\\importer\\preset_upload_importer instead',
-            DEBUG_DEVELOPER
-        );
-        if (is_file($filepath)) {
-            $fp = get_file_packer();
-            if ($fp->extract_to_pathname($filepath, $filepath.'_extracted')) {
-                fulldelete($filepath);
-            }
-            $filepath .= '_extracted';
-        }
-        parent::__construct($course, $cm, $module, $filepath);
-    }
-    public function cleanup() {
-        return fulldelete($this->directory);
-    }
-}
-/**
- * Data preset importer for existing presets
- *
- * @deprecated since Moodle 4.1 MDL-75140 - please do not use this class any more.
- * @todo MDL-75189 Final deprecation in Moodle 4.5.
- */
-class data_preset_existing_importer extends data_preset_importer {
-    protected $userid;
-    public function __construct($course, $cm, $module, $fullname) {
-        global $USER;
-        debugging(
-            'data_preset_existing_importer is deprecated. Please use mod\\data\\local\\importer\\preset_existing_importer instead',
-            DEBUG_DEVELOPER
-        );
-        list($userid, $shortname) = explode('/', $fullname, 2);
-        $context = context_module::instance($cm->id);
-        if ($userid && ($userid != $USER->id) && !has_capability('mod/data:manageuserpresets', $context) && !has_capability('mod/data:viewalluserpresets', $context)) {
-           throw new coding_exception('Invalid preset provided');
-        }
-        $this->userid = $userid;
-        $filepath = data_preset_path($course, $userid, $shortname);
-        parent::__construct($course, $cm, $module, $filepath);
-    }
-    public function get_userid() {
-        return $this->userid;
-    }
-}
 /**
  * @global object
  * @global object
  * @param object $course
  * @param int $userid
+ *
  * @param MoodleQuickForm $mform form passed by reference
  */
 function data_reset_course_form_definition(&$mform) {
     $mform->addElement('header', 'dataheader', get_string('modulenameplural', 'data'));
+    $mform->addElement('static', 'datadelete', get_string('delete'));
     $mform->addElement('checkbox', 'reset_data', get_string('deleteallentries','data'));
     $mform->addElement('checkbox', 'reset_data_notenrolled', get_string('deletenotenrolled', 'data'));
     global $CFG, $DB;
     require_once($CFG->libdir.'/filelib.php');
     require_once($CFG->dirroot.'/rating/lib.php');
     $componentstr = get_string('modulenameplural', 'data');
-    $status = array();
+    $status = [];
     $allrecordssql = "SELECT r.id
                         FROM {data_records} r
     $ratingdeloptions->ratingarea = 'entry';
     // Set the file storage - may need it to remove files later.
     $fs = get_file_storage();
-    // delete entries if requested
+    // Delete entries if requested.
     if (!empty($data->reset_data)) {
-        $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
+        $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", [$data->courseid]);
-        $DB->delete_records_select('data_content', "recordid IN ($allrecordssql)", array($data->courseid));
+        $DB->delete_records_select('data_content', "recordid IN ($allrecordssql)", [$data->courseid]);
-        $DB->delete_records_select('data_records', "dataid IN ($alldatassql)", array($data->courseid));
+        $DB->delete_records_select('data_records', "dataid IN ($alldatassql)", [$data->courseid]);
-        if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
+        if ($datas = $DB->get_records_sql($alldatassql, [$data->courseid])) {
             foreach ($datas as $dataid=>$unused) {
                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
                 core_tag_tag::delete_instances('mod_data', null, $datacontext->id);
+            }
+        }
         if (empty($data->reset_gradebook_grades)) {
-            // remove all grades from gradebook
+            // Remove all grades from gradebook.
             data_reset_gradebook($data->courseid);
+        }
+        $status[] = [
-        }
+            'component' => $componentstr,
+            'item' => get_string('deleteallentries', 'data'),
+            'error' => false,
-        $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallentries', 'data'), 'error'=>false);
+        ];
     }
-    // remove entries by users not enrolled into course
+    // Remove entries by users not enrolled into course.
     if (!empty($data->reset_data_notenrolled)) {
         $recordssql = "SELECT r.id, r.userid, r.dataid, u.id AS userexists, u.deleted AS userdeleted
                          FROM {data_records} r
                               JOIN {data} d ON r.dataid = d.id
                               LEFT JOIN {user} u ON r.userid = u.id
                         WHERE d.course = ? AND r.userid > 0";
         $course_context = context_course::instance($data->courseid);
-        $notenrolled = array();
+        $notenrolled = [];
-        $fields = array();
+        $fields = [];
-        $rs = $DB->get_recordset_sql($recordssql, array($data->courseid));
+        $rs = $DB->get_recordset_sql($recordssql, [$data->courseid]);
         foreach ($rs as $record) {
             if (array_key_exists($record->userid, $notenrolled) or !$record->userexists or $record->userdeleted
               or !is_enrolled($course_context, $record->userid)) {
-                //delete ratings
+                // Delete ratings.
                 if (!$cm = get_coursemodule_from_instance('data', $record->dataid)) {
                     continue;
+                }
                 $datacontext = context_module::instance($cm->id);
                 $ratingdeloptions->contextid = $datacontext->id;
                 $ratingdeloptions->itemid = $record->id;
                 $rm->delete_ratings($ratingdeloptions);
                 // Delete any files that may exist.
-                if ($contents = $DB->get_records('data_content', array('recordid' => $record->id), '', 'id')) {
+                if ($contents = $DB->get_records('data_content', ['recordid' => $record->id], '', 'id')) {
                     foreach ($contents as $content) {
                         $fs->delete_area_files($datacontext->id, 'mod_data', 'content', $content->id);
                     }
                 }
                 $notenrolled[$record->userid] = true;
                 core_tag_tag::remove_all_item_tags('mod_data', 'data_records', $record->id);
+                $DB->delete_records('comments', ['itemid' => $record->id, 'commentarea' => 'database_entry']);
+                $DB->delete_records('data_content', ['recordid' => $record->id]);
-                $DB->delete_records('comments', array('itemid' => $record->id, 'commentarea' => 'database_entry'));
+                $DB->delete_records('data_records', ['id' => $record->id]);
+            }
+        }
-                $DB->delete_records('data_content', array('recordid' => $record->id));
+        $rs->close();
-                $DB->delete_records('data_records', array('id' => $record->id));
+        $status[] = [
             'component' => $componentstr,
-        }
+            'item' => get_string('deletenotenrolled', 'data'),
-        $rs->close();
+            'error' => false,
-        $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'data'), 'error'=>false);
+        ];
+    }
-    // remove all ratings
+    // Remove all ratings.
                 $rm->delete_ratings($ratingdeloptions);
+            }
+        }
         if (empty($data->reset_gradebook_grades)) {
-            // remove all grades from gradebook
+            // Remove all grades from gradebook.
             data_reset_gradebook($data->courseid);
+        }
-        }
+        $status[] = [
+            'component' => $componentstr,
+            'item' => get_string('deleteallratings'),
             'error' => false,
-        $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
+        ];
+    }
+    // Remove all comments.
+    if (!empty($data->reset_data_comments)) {
-    // remove all comments
+        $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", [$data->courseid]);
+        $status[] = [
+            'component' => $componentstr,
-    if (!empty($data->reset_data_comments)) {
+            'item' => get_string('deleteallcomments'),
-        $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
+            'error' => false,
-        $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
+        ];
     }
     // Remove all the tags.
     if (!empty($data->reset_data_tags)) {
-        if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
+        if ($datas = $DB->get_records_sql($alldatassql, [$data->courseid])) {
             foreach ($datas as $dataid => $unused) {
                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
                     continue;
+                }
+                $context = context_module::instance($cm->id);
+                core_tag_tag::delete_instances('mod_data', null, $context->id);
+            }
                 $context = context_module::instance($cm->id);
-                core_tag_tag::delete_instances('mod_data', null, $context->id);
+        $status[] = [
             'component' => $componentstr,
             'item' => get_string('removealldatatags', 'data'),
             'error' => false,
+        ];
+    }
-        $status[] = array('component' => $componentstr, 'item' => get_string('tagsdeleted', 'data'), 'error' => false);
+    // Updating dates - shift may be negative too.
+    if ($data->timeshift) {
+        // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
+        // See MDL-9367.
+        shift_course_mod_dates(
-    }
+            'data',
+            [
+                'timeavailablefrom',
+                'timeavailableto',
+                'timeviewfrom',
+                'timeviewto',
+                'assesstimestart',
+                'assesstimefinish',
+            ],
+            $data->timeshift,
-    // updating dates - shift may be negative too
+            $data->courseid,
-    if ($data->timeshift) {
+        );
-        // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
+        $status[] = [
         $datanode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
+    }
+}
-/**
- * Save the database configuration as a preset.
- *
- * @param stdClass $course The course the database module belongs to.
- * @param stdClass $cm The course module record
- * @param stdClass $data The database record
- * @param string $path
- * @return bool
- * @deprecated since Moodle 4.1 MDL-75142 - please, use the preset::save() function instead.
- * @todo MDL-75189 This will be deleted in Moodle 4.5.
- * @see preset::save()
- */
-function data_presets_save($course, $cm, $data, $path) {
-    debugging('data_presets_save() is deprecated. Please use preset::save() instead.', DEBUG_DEVELOPER);
-    $manager = manager::create_from_instance($data);
-    $preset = preset::create_from_instance($manager, $path);
-    return $preset->save();
-}
-/**
- * Generates the XML for the database module provided
- *
- * @global moodle_database $DB
- * @param stdClass $course The course the database module belongs to.
- * @param stdClass $cm The course module record
- * @param stdClass $data The database record
- * @return string The XML for the preset
- * @deprecated since Moodle 4.1 MDL-75142 - please, use the protected preset::generate_preset_xml() function instead.
- * @todo MDL-75189 This will be deleted in Moodle 4.5.
- * @see preset::generate_preset_xml()
- */
-function data_presets_generate_xml($course, $cm, $data) {
-    debugging(
-        'data_presets_generate_xml() is deprecated. Please use the protected preset::generate_preset_xml() instead.',
-        DEBUG_DEVELOPER
-    );
-    $manager = manager::create_from_instance($data);
-    $preset = preset::create_from_instance($manager, $data->name);
-    $reflection = new \ReflectionClass(preset::class);
-    $method = $reflection->getMethod('generate_preset_xml');
-    return $method->invokeArgs($preset, []);
-}
-/**
- * Export current fields and presets.
- *
- * @param stdClass $course The course the database module belongs to.
- * @param stdClass $cm The course module record
- * @param stdClass $data The database record
- * @param bool $tostorage
- * @return string the full path to the exported preset file.
- * @deprecated since Moodle 4.1 MDL-75142 - please, use the preset::export() function instead.
- * @todo MDL-75189 This will be deleted in Moodle 4.5.
- * @see preset::export()
- */
-function data_presets_export($course, $cm, $data, $tostorage=false) {
-    debugging('data_presets_export() is deprecated. Please use preset::export() instead.', DEBUG_DEVELOPER);
-    $manager = manager::create_from_instance($data);
-    $preset = preset::create_from_instance($manager, $data->name);
-    return $preset->export();
-}
 /**
  * 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.
     $sqlselect['params'] = $inparam;
     return $sqlselect;
+}
-/**
- * Checks to see if the user has permission to delete the preset.
- * @param stdClass $context  Context object.
- * @param stdClass $preset  The preset object that we are checking for deletion.
- * @return bool  Returns true if the user can delete, otherwise false.
- * @deprecated since Moodle 4.1 MDL-75187 - please, use the preset::can_manage() function instead.
- * @todo MDL-75189 This will be deleted in Moodle 4.5.
- * @see preset::can_manage()
- */
-function data_user_can_delete_preset($context, $preset) {
-    global $USER;
-    debugging('data_user_can_delete_preset() is deprecated. Please use manager::can_manage() instead.', DEBUG_DEVELOPER);
-    if ($context->contextlevel == CONTEXT_MODULE && isset($preset->name)) {
-        $cm = get_coursemodule_from_id('', $context->instanceid, 0, false, MUST_EXIST);
-        $manager = manager::create_from_coursemodule($cm);
-        $todelete = preset::create_from_instance($manager, $preset->name);
-        return $todelete->can_manage();
-    }
-    if (has_capability('mod/data:manageuserpresets', $context)) {
-        return true;
-    } else {
-        $candelete = false;
-        $userid = $preset instanceof preset ? $preset->get_userid() : $preset->userid;
-        if ($userid == $USER->id) {
-            $candelete = true;
-        }
-        return $candelete;
-    }
-}
 /**
  * Delete a record entry.
+ *
  * @param int $recordid The ID for the record to be deleted.
  * @param object $data The data object for this activity.
             $completion->update_state($cm, COMPLETION_INCOMPLETE);
+        }
+    }
+}
-/**
- * Mark the activity completed (if required) and trigger the course_module_viewed event.
- *
- * @deprecated since Moodle 4.1 MDL-75146 - please do not use this function any more.
- * @todo MDL-75189 Final deprecation in Moodle 4.5.
- * @param  stdClass $data       data object
- * @param  stdClass $course     course object
- * @param  stdClass $cm         course module object
- * @param  stdClass $context    context object
- * @since Moodle 3.3
- */
-function data_view($data, $course, $cm, $context) {
-    global $CFG;
-    debugging('data_view is deprecated. Use mod_data\\manager::set_module_viewed instead', DEBUG_DEVELOPER);
-    require_once($CFG->libdir . '/completionlib.php');
-    // Trigger course_module_viewed event.
-    $params = array(
-        'context' => $context,
-        'objectid' => $data->id
-    );
-    $event = \mod_data\event\course_module_viewed::create($params);
-    $event->add_record_snapshot('course_modules', $cm);
-    $event->add_record_snapshot('course', $course);
-    $event->add_record_snapshot('data', $data);
-    $event->trigger();
-    // Completion.
-    $completion = new completion_info($course);
-    $completion->set_module_viewed($cm);
+/**
+ * Get the list of deprecated icons.
+ *
-/**
+ * @return array with the deprecated key icons.
- * Get icon mapping for font-awesome.
+ * @todo Final deprecation on Moodle 6.0 MDL-83465.
  */
+function mod_data_get_deprecated_icons() {
+    return [
-function mod_data_get_fontawesome_icon_map() {
+        // Deprecated since Moodle 4.6.
-    return [
+        // See MDL-82313 for refactoring.
-        'mod_data:field/checkbox' => 'fa-check-square-o',
+        'mod_data:field/checkbox' => 'fa-regular fa-square-check',
-        'mod_data:field/date' => 'fa-calendar-o',
+        'mod_data:field/date' => 'fa-regular fa-calendar',
-        'mod_data:field/file' => 'fa-file',
+        'mod_data:field/file' => 'fa-regular fa-file',
-        'mod_data:field/latlong' => 'fa-globe',
+        'mod_data:field/latlong' => 'fa-earth-americas',
         'mod_data:field/menu' => 'fa-bars',
         'mod_data:field/multimenu' => 'fa-bars',
         'mod_data:field/number' => 'fa-hashtag',
-        'mod_data:field/picture' => 'fa-picture-o',
-        'mod_data:field/radiobutton' => 'fa-circle-o',
+        'mod_data:field/picture' => 'fa-regular fa-image',
+        'mod_data:field/radiobutton' => 'fa-regular fa-circle-dot',
-        'mod_data:field/textarea' => 'fa-font',
+        'mod_data:field/text' => 'fa-i-cursor',
-        'mod_data:field/text' => 'fa-i-cursor',
+        'mod_data:field/textarea' => 'fa-font',
         'mod_data:field/url' => 'fa-link',
     ];

Proyectos de Subversion Moodle

(root)/mod/data/lib.php – Rev 1 → 1441