enrol/category/cli/sync.php

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