MDL-61899 tool_dataprivacy: Create name-description exporter

Create exporter for lawful bases that contain name and description pairs

diff --git a/admin/tool/dataprivacy/classes/external/name_description_exporter.php b/admin/tool/dataprivacy/classes/external/name_description_exporter.php
new file mode 100644 (file)
index 0000000..eeb39a2
--- /dev/null
+++ b/admin/tool/dataprivacy/classes/external/name_description_exporter.php
@@ -0,0 +1,63 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Class for exporting an object containing a name and a description.
+ *
+ * @package    tool_dataprivacy
+ * @copyright  2018 Jun Pataleta
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace tool_dataprivacy\external;
+defined('MOODLE_INTERNAL') || die();
+
+use core\external\exporter;
+
+/**
+ * Class that exports an object containing a name and a description.
+ *
+ * @copyright  2018 Jun Pataleta
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class name_description_exporter extends exporter {
+
+    /**
+     * Returns a list of objects that are related.
+     *
+     * @return array
+     */
+    protected static function define_related() {
+        return array(
+            'context' => 'context',
+        );
+    }
+
+    /**
+     * Return the list of properties.
+     *
+     * @return array
+     */
+    protected static function define_properties() {
+        return [
+            'name' => [
+                'type' => PARAM_TEXT,
+            ],
+            'description' => [
+                'type' => PARAM_TEXT,
+            ],
+        ];
+    }
+}

diff --git a/admin/tool/dataprivacy/classes/external/purpose_exporter.php b/admin/tool/dataprivacy/classes/external/purpose_exporter.php
index e2f73c3..f91e2f2 100644 (file)
--- a/admin/tool/dataprivacy/classes/external/purpose_exporter.php
+++ b/admin/tool/dataprivacy/classes/external/purpose_exporter.php
@@ -28,8 +28,6 @@ use coding_exception;
 use core\external\persistent_exporter;
 use DateInterval;
 use Exception;
-use external_single_structure;
-use external_value;
 use renderer_base;
 use tool_dataprivacy\purpose;
 
@@ -67,24 +65,16 @@ class purpose_exporter extends persistent_exporter {
      * @return array
      */
     protected static function define_other_properties() {
-        $namedescriptiontype = [
-            'name' => [
-                'type' => PARAM_TEXT,
-            ],
-            'description' => [
-                'type' => PARAM_TEXT,
-            ],
-        ];
         return [
             'formattedretentionperiod' => [
                 'type' => PARAM_TEXT
             ],
             'formattedlawfulbases' => [
-                'type' => $namedescriptiontype,
+                'type' => name_description_exporter::read_properties_definition(),
                 'multiple' => true
             ],
             'formattedsensitivedatareasons' => [
-                'type' => $namedescriptiontype,
+                'type' => name_description_exporter::read_properties_definition(),
                 'multiple' => true,
                 'optional' => true
             ],