MDL-61899 tool_dataprivacy: Subject access requests tool

This commit is composed of different issues, most of them under MDL-61306: - MDL-61888, MDL-61785, MDL-61830, MDL-61874, MDL-59720, MDL-61486, MDL-61697, MDL-61798, MDL-61685, MDL-61682, MDL-61684, MDL-61618, MDL-61681, MDL-61680, MDL-61487, MDL-61499, MDL-61500, MDL-61362 and MDL-59718 Contributions to this patch by: - Jun Pataleta - David Monllao - Andrew Nicols - Adrian B. Greeve - Jake Dallimore - Sara Arjona
2018-04-18 18:14:23 +02:00
parent b5cca5ae5a
commit 5efc1f9e64
101 changed files with 12569 additions and 0 deletions
@@ -0,0 +1,116 @@
+<?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 loading/storing context instances data from the DB.
+ *
+ * @package    tool_dataprivacy
+ * @copyright  2018 David Monllao
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace tool_dataprivacy;
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Class for loading/storing context instances data from the DB.
+ *
+ * @copyright  2018 David Monllao
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class context_instance extends \core\persistent {
+
+    /**
+     * Database table.
+     */
+    const TABLE = 'tool_dataprivacy_ctxinstance';
+
+    /**
+     * Not set value.
+     */
+    const NOTSET = 0;
+
+    /**
+     * Inherit value.
+     */
+    const INHERIT = -1;
+
+    /**
+     * Return the definition of the properties of this model.
+     *
+     * @return array
+     */
+    protected static function define_properties() {
+        return array(
+            'contextid' => array(
+                'type' => PARAM_INT,
+                'description' => 'The context id.',
+            ),
+            'purposeid' => array(
+                'type' => PARAM_INT,
+                'description' => 'The purpose id.',
+                'null' => NULL_ALLOWED,
+            ),
+            'categoryid' => array(
+                'type' => PARAM_INT,
+                'description' => 'The category id.',
+                'null' => NULL_ALLOWED,
+            ),
+        );
+    }
+
+    /**
+     * Returns an instance by contextid.
+     *
+     * @param mixed $contextid
+     * @param mixed $exception
+     * @return null
+     */
+    public static function get_record_by_contextid($contextid, $exception = true) {
+        global $DB;
+
+        if (!$record = $DB->get_record(self::TABLE, array('contextid' => $contextid))) {
+            if (!$exception) {
+                return false;
+            } else {
+                throw new \dml_missing_record_exception(self::TABLE);
+            }
+        }
+
+        return new static(0, $record);
+    }
+
+    /**
+     * Is the provided purpose used by any context instance?
+     *
+     * @param int $purposeid
+     * @return bool
+     */
+    public static function is_purpose_used($purposeid) {
+        global $DB;
+        return $DB->record_exists(self::TABLE, array('purposeid' => $purposeid));
+    }
+
+    /**
+     * Is the provided category used by any context instance?
+     *
+     * @param int $categoryid
+     * @return bool
+     */
+    public static function is_category_used($categoryid) {
+        global $DB;
+        return $DB->record_exists(self::TABLE, array('categoryid' => $categoryid));
+    }
+}