[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   * Scheduled task for processing flatfile enrolments.
  19   *
  20   * @package    enrol_flatfile
  21   * @copyright  2014 Troy Williams
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace enrol_flatfile\task;
  26  
  27  defined('MOODLE_INTERNAL') || die;
  28  
  29  /**
  30   * Simple task to run sync enrolments.
  31   *
  32   * @copyright  2014 Troy Williams
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class flatfile_sync_task extends \core\task\scheduled_task {
  36  
  37      /**
  38       * Get a descriptive name for this task (shown to admins).
  39       *
  40       * @return string
  41       */
  42      public function get_name() {
  43          return get_string('flatfilesync', 'enrol_flatfile');
  44      }
  45  
  46      /**
  47       * Do the job.
  48       * Throw exceptions on errors (the job will be retried).
  49       */
  50      public function execute() {
  51          global $CFG;
  52  
  53          require_once($CFG->dirroot . '/enrol/flatfile/lib.php');
  54  
  55          if (!enrol_is_enabled('flatfile')) {
  56              return;
  57          }
  58  
  59          // Instance of enrol_flatfile_plugin.
  60          $plugin = enrol_get_plugin('flatfile');
  61          $result = $plugin->sync(new \null_progress_trace());
  62          return $result;
  63  
  64      }
  65  
  66  }