Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  /**
  17   * Privacy Subsystem implementation for datafield_file.
  18   *
  19   * @package    datafield_file
  20   * @copyright  2018 Carlos Escobedo <carlos@moodle.com>
  21   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22   */
  23  namespace datafield_file\privacy;
  24  use mod_data\privacy\datafield_provider;
  25  use core_privacy\local\request\writer;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  /**
  29   * Privacy Subsystem for datafield_file implementing null_provider.
  30   *
  31   * @copyright  2018 Carlos Escobedo <carlos@moodle.com>
  32   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   */
  34  class provider implements \core_privacy\local\metadata\null_provider,
  35          datafield_provider {
  36      /**
  37       * Get the language string identifier with the component's language
  38       * file to explain why this plugin stores no data.
  39       *
  40       * @return  string
  41       */
  42      public static function get_reason() : string {
  43          return 'privacy:metadata';
  44      }
  45  
  46      /**
  47       * Exports data about one record in {data_content} table.
  48       *
  49       * @param \context_module $context
  50       * @param \stdClass $recordobj record from DB table {data_records}
  51       * @param \stdClass $fieldobj record from DB table {data_fields}
  52       * @param \stdClass $contentobj record from DB table {data_content}
  53       * @param \stdClass $defaultvalue pre-populated default value that most of plugins will use
  54       */
  55      public static function export_data_content($context, $recordobj, $fieldobj, $contentobj, $defaultvalue) {
  56          if ($fieldobj->param3) {
  57              $defaultvalue->field['maxbytes'] = $fieldobj->param3;
  58          }
  59          // Change file name to file path.
  60          $defaultvalue->file = writer::with_context($context)
  61              ->rewrite_pluginfile_urls([$recordobj->id, $contentobj->id], 'mod_data', 'content', $contentobj->id,
  62                  '@@PLUGINFILE@@/' . $defaultvalue->content);
  63          unset($defaultvalue->content);
  64          writer::with_context($context)->export_data([$recordobj->id, $contentobj->id], $defaultvalue);
  65      }
  66  
  67      /**
  68       * Allows plugins to delete locally stored data.
  69       *
  70       * @param \context_module $context
  71       * @param \stdClass $recordobj record from DB table {data_records}
  72       * @param \stdClass $fieldobj record from DB table {data_fields}
  73       * @param \stdClass $contentobj record from DB table {data_content}
  74       */
  75      public static function delete_data_content($context, $recordobj, $fieldobj, $contentobj) {
  76  
  77      }
  78  }