[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   * An implementation of a contextlist which has been filtered and approved.
  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\local\request;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * An implementation of a contextlist which has been filtered and approved.
  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 contextlist_base {
  36  
  37      /**
  38       * @var \stdClass The user this contextlist belongs to.
  39       */
  40      protected $user;
  41  
  42      /**
  43       * Create a new approved contextlist.
  44       *
  45       * @param   \stdClass       $user The user record.
  46       * @param   string          $component the frankenstyle component name.
  47       * @param   \int[]          $contextids The list of contextids present in this list.
  48       */
  49      public function __construct(\stdClass $user, string $component, array $contextids) {
  50          $this->set_user($user);
  51          $this->set_component($component);
  52          $this->set_contextids($contextids);
  53      }
  54  
  55      /**
  56       * Specify the user which owns this request.
  57       *
  58       * @param   \stdClass       $user The user record.
  59       * @return  $this
  60       */
  61      protected function set_user(\stdClass $user) : approved_contextlist {
  62          $this->user = $user;
  63  
  64          return $this;
  65      }
  66  
  67      /**
  68       * Get the user which requested their data.
  69       *
  70       * @return  \stdClass
  71       */
  72      public function get_user() : \stdClass {
  73          return $this->user;
  74      }
  75  }