admin/tool/dataprivacy/tests/data_privacy_testcase.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  * Parent class for tests which need data privacy functionality.
  19  *
  20  * @package    tool_dataprivacy
  21  * @copyright  2018 Michael Hawkins
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 defined('MOODLE_INTERNAL') || die();
  26
  27 /**
  28  * Parent class for tests which need data privacy functionality.
  29  *
  30  * @package    tool_dataprivacy
  31  * @copyright  2018 Michael Hawkins
  32  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33  */
  34 abstract class data_privacy_testcase extends advanced_testcase {
  35
  36     /**
  37      * Assign one or more user IDs as site DPO
  38      *
  39      * @param stdClass|array $users User ID or array of user IDs to be assigned as site DPO
  40      * @return void
  41      */
  42     protected function assign_site_dpo($users) {
  43         global $DB;
  44         $this->resetAfterTest();
  45
  46         if (!is_array($users)) {
  47             $users = array($users);
  48         }
  49
  50         $context = context_system::instance();
  51
  52         // Give the manager role with the capability to manage data requests.
  53         $managerroleid = $DB->get_field('role', 'id', array('shortname' => 'manager'));
  54         assign_capability('tool/dataprivacy:managedatarequests', CAP_ALLOW, $managerroleid, $context->id, true);
  55
  56         // Assign user(s) as manager.
  57         foreach ($users as $user) {
  58             role_assign($managerroleid, $user->id, $context->id);
  59         }
  60
  61         // Only map the manager role to the DPO role.
  62         set_config('dporoles', $managerroleid, 'tool_dataprivacy');
  63     }
  64 }