MDL-55956 core: New adhoc task refresh_mod_calendar_events_task

* New adhoc task that loops over mod plugins and calls the
<modname>_refresh_events() hook, if available.

lib/classes/task/refresh_mod_calendar_events_task.php

@@ -0,0 +1,69 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Adhoc task that updates all of the existing calendar events for modules that implement the *_refresh_events() hook.
+ *
+ * @package    core
+ * @copyright  2017 Jun Pataleta
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\task;
+
+use core_plugin_manager;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Class that updates all of the existing calendar events for modules that implement the *_refresh_events() hook.
+ *
+ * Custom data accepted:
+ * - plugins -> Array of plugin names that need to be refreshed. Optional.
+ *
+ * @package     core
+ * @copyright   2017 Jun Pataleta
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class refresh_mod_calendar_events_task extends adhoc_task {
+
+    /**
+     * Run the task to refresh calendar events.
+     */
+    public function execute() {
+        // Specific list of plugins that need to be refreshed. If not set, then all mod plugins will be refreshed.
+        $pluginstorefresh = null;
+        if (isset($this->get_custom_data()->plugins)) {
+            $pluginstorefresh = $this->get_custom_data()->plugins;
+        }
+
+        $pluginmanager = core_plugin_manager::instance();
+        $modplugins = $pluginmanager->get_plugins_of_type('mod');
+        foreach ($modplugins as $plugin) {
+            // Check if a specific list of plugins is defined and check if it contains the plugin that is currently being evaluated.
+            if (!empty($pluginstorefresh) && !in_array($plugin->name, $pluginstorefresh)) {
+                // This plugin is not in the list, move on to the next one.
+                continue;
+            }
+            // Check if the plugin implements *_refresh_events() and call it when it does.
+            $refresheventsfunction = $plugin->name . '_refresh_events';
+            if (function_exists($refresheventsfunction)) {
+                mtrace('Calling ' . $refresheventsfunction);
+                call_user_func($refresheventsfunction);
+            }
+        }
+    }
+}

lib/upgrade.txt

@@ -53,6 +53,7 @@ information provided here is intended especially for developers.
 * get_user_capability_course() now has an additional parameter 'limit'. This can be used to return a set number of records with
   the submitted capability. The parameter 'fieldsexceptid' will now accept context fields which can be used for preloading.
 * The caching option 'immutable' has been added to send_stored_file() and send_file().
+* New adhoc task refresh_mod_calendar_events_task that updates existing calendar events of modules.
 
 === 3.2 ===