admin/tool/dataprivacy/classes/external/purpose_exporter.php

   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 /**
  18  * Class for exporting data purpose.
  19  *
  20  * @package    tool_dataprivacy
  21  * @copyright  2018 David Monllao
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24 namespace tool_dataprivacy\external;
  25 defined('MOODLE_INTERNAL') || die();
  26
  27 use coding_exception;
  28 use core\external\persistent_exporter;
  29 use DateInterval;
  30 use Exception;
  31 use renderer_base;
  32 use tool_dataprivacy\purpose;
  33
  34 /**
  35  * Class for exporting field data.
  36  *
  37  * @copyright  2018 David Monllao
  38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39  */
  40 class purpose_exporter extends persistent_exporter {
  41
  42     /**
  43      * Defines the persistent class.
  44      *
  45      * @return string
  46      */
  47     protected static function define_class() {
  48         return purpose::class;
  49     }
  50
  51     /**
  52      * Returns a list of objects that are related.
  53      *
  54      * @return array
  55      */
  56     protected static function define_related() {
  57         return array(
  58             'context' => 'context',
  59         );
  60     }
  61
  62     /**
  63      * Return the list of additional properties.
  64      *
  65      * @return array
  66      */
  67     protected static function define_other_properties() {
  68         return [
  69             'formattedretentionperiod' => [
  70                 'type' => PARAM_TEXT
  71             ],
  72             'formattedlawfulbases' => [
  73                 'type' => name_description_exporter::read_properties_definition(),
  74                 'multiple' => true
  75             ],
  76             'formattedsensitivedatareasons' => [
  77                 'type' => name_description_exporter::read_properties_definition(),
  78                 'multiple' => true,
  79                 'optional' => true
  80             ],
  81         ];
  82     }
  83
  84     /**
  85      * Return other properties.
  86      *
  87      * @param renderer_base $output
  88      * @return array
  89      * @throws coding_exception
  90      * @throws Exception
  91      */
  92     protected function get_other_values(renderer_base $output) {
  93         $values = [];
  94
  95         $formattedbases = [];
  96         $lawfulbases = explode(',', $this->persistent->get('lawfulbases'));
  97         if (!empty($lawfulbases)) {
  98             foreach ($lawfulbases as $basis) {
  99                 if (empty(trim($basis))) {
 100                     continue;
 101                 }
 102                 $formattedbases[] = (object)[
 103                     'name' => get_string($basis . '_name', 'tool_dataprivacy'),
 104                     'description' => get_string($basis . '_description', 'tool_dataprivacy')
 105                 ];
 106             }
 107         }
 108         $values['formattedlawfulbases'] = $formattedbases;
 109
 110         $formattedsensitivereasons = [];
 111         $sensitivereasons = explode(',', $this->persistent->get('sensitivedatareasons'));
 112         if (!empty($sensitivereasons)) {
 113             foreach ($sensitivereasons as $reason) {
 114                 if (empty(trim($reason))) {
 115                     continue;
 116                 }
 117                 $formattedsensitivereasons[] = (object)[
 118                     'name' => get_string($reason . '_name', 'tool_dataprivacy'),
 119                     'description' => get_string($reason . '_description', 'tool_dataprivacy')
 120                 ];
 121             }
 122         }
 123         $values['formattedsensitivedatareasons'] = $formattedsensitivereasons;
 124
 125         $retentionperiod = $this->persistent->get('retentionperiod');
 126         if ($retentionperiod) {
 127             $interval = new DateInterval($retentionperiod);
 128
 129             // It is one or another.
 130             if ($interval->y) {
 131                 $formattedtime = get_string('numyears', 'moodle', $interval->format('%y'));
 132             } else if ($interval->m) {
 133                 $formattedtime = get_string('nummonths', 'moodle', $interval->format('%m'));
 134             } else if ($interval->d) {
 135                 $formattedtime = get_string('numdays', 'moodle', $interval->format('%d'));
 136             } else {
 137                 $formattedtime = get_string('retentionperiodzero', 'tool_dataprivacy');
 138             }
 139         } else {
 140             $formattedtime = get_string('retentionperiodnotdefined', 'tool_dataprivacy');
 141         }
 142         $values['formattedretentionperiod'] = $formattedtime;
 143
 144         return $values;
 145     }
 146 }