[Summary view]

   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 customfield_text.
  18   *
  19   * @package    customfield_text
  20   * @copyright  2018 Daniel Neis Araujo <danielneis@gmail.com>
  21   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22   */
  23  namespace customfield_text\privacy;
  24  
  25  use core_customfield\data_controller;
  26  use core_customfield\privacy\customfield_provider;
  27  use core_privacy\local\request\writer;
  28  
  29  defined('MOODLE_INTERNAL') || die();
  30  
  31  /**
  32   * Privacy Subsystem for customfield_text implementing null_provider.
  33   *
  34   * @copyright  2018 Daniel Neis Araujo <danielneis@gmail.com>
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class provider implements \core_privacy\local\metadata\null_provider, customfield_provider {
  38  
  39      /**
  40       * Get the language string identifier with the component's language
  41       * file to explain why this plugin stores no data.
  42       *
  43       * @return  string
  44       */
  45      public static function get_reason() : string {
  46          return 'privacy:metadata';
  47      }
  48  
  49      /**
  50       * Preprocesses data object that is going to be exported
  51       *
  52       * @param data_controller $data
  53       * @param \stdClass $exportdata
  54       * @param array $subcontext
  55       */
  56      public static function export_customfield_data(data_controller $data, \stdClass $exportdata, array $subcontext) {
  57          $context = $data->get_context();
  58          // For text fields we want to apply format_string even to raw value to avoid CSS.
  59          $exportdata->{$data->datafield()} = $data->export_value();
  60          writer::with_context($context)
  61              ->export_data($subcontext, $exportdata);
  62      }
  63  
  64      /**
  65       * Allows plugins to delete everything they store related to the data (usually files)
  66       *
  67       * @param string $dataidstest
  68       * @param array $params
  69       * @param array $contextids
  70       * @return mixed|void
  71       */
  72      public static function before_delete_data(string $dataidstest, array $params, array $contextids) {
  73      }
  74  
  75      /**
  76       * Allows plugins to delete everything they store related to the field configuration (usually files)
  77       *
  78       * @param string $fieldidstest
  79       * @param array $params
  80       * @param array $contextids
  81       */
  82      public static function before_delete_fields(string $fieldidstest, array $params, array $contextids) {
  83      }
  84  }