[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 and 403]

   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   * Sync enrolments task
  19   * @package enrol_ldap
  20   * @author    Guy Thomas <gthomas@moodlerooms.com>
  21   * @copyright Copyright (c) 2017 Blackboard Inc.
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace enrol_ldap\task;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Class sync_enrolments
  31   * @package enrol_ldap
  32   * @author    Guy Thomas <gthomas@moodlerooms.com>
  33   * @copyright Copyright (c) 2017 Blackboard Inc.
  34   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class sync_enrolments extends \core\task\scheduled_task {
  37  
  38      /**
  39       * Name for this task.
  40       *
  41       * @return string
  42       */
  43      public function get_name() {
  44          return get_string('syncenrolmentstask', 'enrol_ldap');
  45      }
  46  
  47      /**
  48       * Run task for synchronising users.
  49       */
  50      public function execute() {
  51  
  52          if (!enrol_is_enabled('ldap')) {
  53              mtrace(get_string('pluginnotenabled', 'enrol_ldap'));
  54              exit(0); // Note, exit with success code, this is not an error - it's just disabled.
  55          }
  56  
  57          /** @var enrol_ldap_plugin $enrol */
  58          $enrol = enrol_get_plugin('ldap');
  59  
  60          $trace = new \text_progress_trace();
  61  
  62          // Update enrolments -- these handlers should autocreate courses if required.
  63          $enrol->sync_enrolments($trace);
  64      }
  65  
  66  }