[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   * Sync enrolments task
  19   * @package   enrol_database
  20   * @copyright 2018 Daniel Neis Araujo <danielneis@gmail.com>
  21   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22   */
  23  
  24  namespace enrol_database\task;
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * Class sync_enrolments
  30   * @package   enrol_database
  31   * @copyright 2018 Daniel Neis Araujo <danielneis@gmail.com>
  32   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   */
  34  class sync_enrolments extends \core\task\scheduled_task {
  35  
  36      /**
  37       * Name for this task.
  38       *
  39       * @return string
  40       */
  41      public function get_name() {
  42          return get_string('syncenrolmentstask', 'enrol_database');
  43      }
  44  
  45      /**
  46       * Run task for synchronising users.
  47       */
  48      public function execute() {
  49  
  50          $trace = new \text_progress_trace();
  51  
  52          if (!enrol_is_enabled('database')) {
  53              $trace->output('Plugin not enabled');
  54              return;
  55          }
  56  
  57          $enrol = enrol_get_plugin('database');
  58  
  59          // Update enrolments -- these handlers should autocreate courses if required.
  60          $enrol->sync_courses($trace);
  61          $enrol->sync_enrolments($trace);
  62      }
  63  }