[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 user sync.
  19   *
  20   * @package    auth_ldap
  21   * @copyright  2015 Vadim Dvorovenko <Vadimon@mail.ru>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace auth_ldap\task;
  25  
  26  /**
  27   * A scheduled task class for LDAP user sync.
  28   *
  29   * @copyright  2015 Vadim Dvorovenko <Vadimon@mail.ru>
  30   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  31   */
  32  class sync_task extends \core\task\scheduled_task {
  33  
  34      /**
  35       * Get a descriptive name for this task (shown to admins).
  36       *
  37       * @return string
  38       */
  39      public function get_name() {
  40          return get_string('synctask', 'auth_ldap');
  41      }
  42  
  43      /**
  44       * Run users sync.
  45       */
  46      public function execute() {
  47          global $CFG;
  48          if (is_enabled_auth('ldap')) {
  49              $auth = get_auth_plugin('ldap');
  50              $auth->sync_users(true);
  51          }
  52      }
  53  
  54  }