[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   * A scheduled task for LDAP roles sync.
  19   *
  20   * @package    auth_ldap
  21   * @author     David Balch <david.balch@conted.ox.ac.uk>
  22   * @copyright  2017 The Chancellor Masters and Scholars of the University of Oxford {@link http://www.tall.ox.ac.uk}
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  namespace auth_ldap\task;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * A scheduled task class for LDAP roles sync.
  31   *
  32   * @author     David Balch <david.balch@conted.ox.ac.uk>
  33   * @copyright  2017 The Chancellor Masters and Scholars of the University of Oxford {@link http://www.tall.ox.ac.uk}
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class sync_roles extends \core\task\scheduled_task {
  37  
  38      /**
  39       * Get a descriptive name for this task (shown to admins).
  40       *
  41       * @return string
  42       */
  43      public function get_name() {
  44          return get_string('syncroles', 'auth_ldap');
  45      }
  46  
  47      /**
  48       * Synchronise role assignments from LDAP.
  49       */
  50      public function execute() {
  51          global $DB;
  52          if (is_enabled_auth('ldap')) {
  53              $auth = get_auth_plugin('ldap');
  54              $users = $DB->get_records('user', array('auth' => 'ldap'));
  55              foreach ($users as $user) {
  56                  $auth->sync_roles($user);
  57              }
  58          }
  59      }
  60  
  61  }