Cameron Ball
9c98546da6
Previously we did not require the lib.php files for each module in this ad-hoc task, which meant that the *_refresh_events functions would only be called if some lucky sequence of events led to the lib.php file for the module being required. Instead we should use the component_callback function which can handle that stuff automagically.
69 lines
2.6 KiB
PHP
69 lines
2.6 KiB
PHP
<?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.
|
|
if (component_callback_exists('mod_' . $plugin->name, 'refresh_events')) {
|
|
mtrace('Refreshing events for ' . $plugin->name);
|
|
component_callback('mod_' . $plugin->name, 'refresh_events');
|
|
}
|
|
}
|
|
}
|
|
}
|