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