[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  /**
  18   * Approved result set for unit testing.
  19   *
  20   * @package    core_privacy
  21   * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_privacy\tests\request;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Privacy Fetch Result Set.
  31   *
  32   * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class approved_contextlist extends \core_privacy\local\request\approved_contextlist {
  36      /**
  37       * Add a single context to this approved_contextlist.
  38       *
  39       * @param   \context    $context        The context to be added.
  40       * @return  $this
  41       */
  42      public function add_context(\context $context) {
  43          return $this->add_context_by_id($context->id);
  44      }
  45  
  46      /**
  47       * Add a single context to this approved_contextlist by it's ID.
  48       *
  49       * @param   int         $contextid      The context to be added.
  50       * @return  $this
  51       */
  52      public function add_context_by_id($contextid) {
  53          return $this->set_contextids(array_merge($this->get_contextids(), [$contextid]));
  54      }
  55  
  56      /**
  57       * Add a set of contexts to this approved_contextlist.
  58       *
  59       * @param   \context[]  $contexts       The contexts to be added.
  60       * @return  $this
  61       */
  62      public function add_contexts(array $contexts) {
  63          foreach ($contexts as $context) {
  64              $this->add_context($context);
  65          }
  66      }
  67  
  68      /**
  69       * Add a set of contexts to this approved_contextlist by ID.
  70       *
  71       * @param   int[]       $contexts       The contexts to be added.
  72       * @return  $this
  73       */
  74      public function add_contexts_by_id(array $contexts) {
  75          foreach ($contexts as $contextid) {
  76              $this->add_context_by_id($contextid);
  77          }
  78      }
  79  }