[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 userlist which has been filtered and approved.
  19   *
  20   * @package    tool_dataprivacy
  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 tool_dataprivacy;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * An implementation of a userlist which can be filtered by role.
  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 filtered_userlist extends \core_privacy\local\request\approved_userlist {
  36  
  37      /**
  38       * Apply filters to only remove users in the expireduserids list, and to remove any who are in the unexpired list.
  39       * The unexpired list wins where a user is in both lists.
  40       *
  41       * @param   int[]   $expireduserids The list of userids for users who should be expired.
  42       * @param   int[]   $unexpireduserids The list of userids for those users who should not be expired.
  43       * @return  $this
  44       */
  45      public function apply_expired_context_filters(array $expireduserids, array $unexpireduserids) : filtered_userlist {
  46          // The current userlist content.
  47          $userids = $this->get_userids();
  48  
  49          if (!empty($expireduserids)) {
  50              // Now remove any not on the list of expired users.
  51              $userids = array_intersect($userids, $expireduserids);
  52          }
  53  
  54          if (!empty($unexpireduserids)) {
  55              // Remove any on the list of unexpiredusers users.
  56              $userids = array_diff($userids, $unexpireduserids);
  57          }
  58  
  59          $this->set_userids($userids);
  60  
  61          return $this;
  62      }
  63  }