[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   * Adhoc task that updates all of the existing calendar events for modules that implement the *_refresh_events() hook.
  19   *
  20   * @package    core
  21   * @copyright  2017 Jun Pataleta
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\task;
  26  
  27  use core_plugin_manager;
  28  
  29  defined('MOODLE_INTERNAL') || die();
  30  
  31  /**
  32   * Class that updates all of the existing calendar events for modules that implement the *_refresh_events() hook.
  33   *
  34   * Custom data accepted:
  35   * - plugins -> Array of plugin names that need to be refreshed. Optional.
  36   *
  37   * @package     core
  38   * @copyright   2017 Jun Pataleta
  39   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   */
  41  class refresh_mod_calendar_events_task extends adhoc_task {
  42  
  43      /**
  44       * Run the task to refresh calendar events.
  45       */
  46      public function execute() {
  47          global $CFG;
  48  
  49          require_once($CFG->dirroot . '/course/lib.php');
  50  
  51          // Specific list of plugins that need to be refreshed. If not set, then all mod plugins will be refreshed.
  52          $pluginstorefresh = null;
  53          if (isset($this->get_custom_data()->plugins)) {
  54              $pluginstorefresh = $this->get_custom_data()->plugins;
  55          }
  56  
  57          // Is course id set?
  58          if (isset($this->get_custom_data()->courseid)) {
  59              $courseid = $this->get_custom_data()->courseid;
  60          } else {
  61              $courseid = 0;
  62          }
  63  
  64          $pluginmanager = core_plugin_manager::instance();
  65          $modplugins = $pluginmanager->get_plugins_of_type('mod');
  66          foreach ($modplugins as $plugin) {
  67              // Check if a specific list of plugins is defined and check if it contains the plugin that is currently being evaluated.
  68              if (!empty($pluginstorefresh) && !in_array($plugin->name, $pluginstorefresh)) {
  69                  // This plugin is not in the list, move on to the next one.
  70                  continue;
  71              }
  72              // Refresh events.
  73              mtrace('Refreshing events for ' . $plugin->name);
  74              course_module_bulk_update_calendar_events($plugin->name, $courseid);
  75          }
  76      }
  77  }