[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   * CLI update for manual enrolments expiration.
  19   *
  20   * Notes:
  21   *   - it is required to use the web server account when executing PHP CLI scripts
  22   *   - you need to change the "www-data" to match the apache user account
  23   *   - use "su" if "sudo" not available
  24   *
  25   * @package    enrol_manual
  26   * @copyright  2012 Petr Skoda {@link http://skodak.org}
  27   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  28   */
  29  
  30  define('CLI_SCRIPT', true);
  31  
  32  require(__DIR__.'/../../../config.php');
  33  require_once("$CFG->libdir/clilib.php");
  34  
  35  // Now get cli options.
  36  list($options, $unrecognized) = cli_get_params(array('verbose'=>false, 'help'=>false), array('v'=>'verbose', 'h'=>'help'));
  37  
  38  if ($unrecognized) {
  39      $unrecognized = implode("\n  ", $unrecognized);
  40      cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
  41  }
  42  
  43  if ($options['help']) {
  44      $help =
  45          "Execute manual enrolments expiration sync and send notifications.
  46  
  47  Options:
  48  -v, --verbose         Print verbose progress information
  49  -h, --help            Print out this help
  50  
  51  Example:
  52  \$ sudo -u www-data /usr/bin/php enrol/self/manual/sync.php
  53  ";
  54  
  55      echo $help;
  56      die;
  57  }
  58  
  59  if (!enrol_is_enabled('manual')) {
  60      cli_error('enrol_manual plugin is disabled, synchronisation stopped', 2);
  61  }
  62  
  63  if (empty($options['verbose'])) {
  64      $trace = new null_progress_trace();
  65  } else {
  66      $trace = new text_progress_trace();
  67  }
  68  
  69  /** @var $plugin enrol_manual_plugin */
  70  $plugin = enrol_get_plugin('manual');
  71  
  72  $result = $plugin->sync($trace, null);
  73  $plugin->send_expiry_notifications($trace);
  74  
  75  exit($result);