[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 users task
  19   * @package   auth_db
  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 auth_db\task;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Sync users task class
  31   * @package   auth_db
  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_users 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('auth_dbsyncuserstask', 'auth_db');
  45      }
  46  
  47      /**
  48       * Run task for synchronising users.
  49       */
  50      public function execute() {
  51          if (!is_enabled_auth('db')) {
  52              mtrace('auth_db plugin is disabled, synchronisation stopped', 2);
  53              return;
  54          }
  55  
  56          $dbauth = get_auth_plugin('db');
  57          $config = get_config('auth_db');
  58          $trace = new \text_progress_trace();
  59          $update = !empty($config->updateusers);
  60          $dbauth->sync_users($trace, $update);
  61      }
  62  
  63  }