[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 script to reset dashboards.
  19   *
  20   * @package    core
  21   * @subpackage cli
  22   * @copyright  2021 Brendan Heywood (brendan@catalyst-au.net)
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  define('CLI_SCRIPT', true);
  27  
  28  require(__DIR__.'/../../config.php');
  29  require_once($CFG->libdir.'/clilib.php');
  30  require_once($CFG->dirroot.'/my/lib.php');
  31  
  32  list($options, $unrecognized) = cli_get_params([
  33      'help'    => false,
  34      'execute' => false,
  35  ], [
  36      'h' => 'help',
  37      'e' => 'execute',
  38  ]);
  39  
  40  if ($unrecognized) {
  41      $unrecognized = implode("\n  ", $unrecognized);
  42      cli_error(get_string('cliunknowoption', 'admin', $unrecognized), 2);
  43  }
  44  
  45  if (!$options['execute']) {
  46      $help = <<<EOF
  47  Resets Moodle dashboards for all users
  48  
  49  Options:
  50  -h, --help          Print out this help
  51  -e, --execute       Actually run the reset
  52  
  53  Example:
  54  \$ sudo -u www-data /usr/bin/php admin/cli/dashboard_reset.php -e
  55  
  56  EOF;
  57  
  58      echo $help;
  59      exit(0);
  60  }
  61  
  62  $progressbar = new progress_bar();
  63  $progressbar->create();
  64  my_reset_page_for_all_users(MY_PAGE_PRIVATE, 'my-index', $progressbar);
  65