Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
   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  declare(strict_types=1);
  18  
  19  namespace core_reportbuilder\task;
  20  
  21  use core\task\scheduled_task;
  22  use core_reportbuilder\local\helpers\schedule;
  23  use core_reportbuilder\local\models\schedule as model;
  24  
  25  /**
  26   * Scheduled task for sending queued report schedules
  27   *
  28   * @package     core_reportbuilder
  29   * @copyright   2021 Paul Holden <paulh@moodle.com>
  30   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  31   */
  32  class send_schedules extends scheduled_task {
  33  
  34      /**
  35       * Return name of the task
  36       *
  37       * @return string
  38       */
  39      public function get_name(): string {
  40          return get_string('tasksendschedules', 'core_reportbuilder');
  41      }
  42  
  43      /**
  44       * Execute the task, request all pending schedules to be sent
  45       */
  46      public function execute(): void {
  47          global $DB;
  48  
  49          $schedules = model::get_records_select('enabled = 1 AND timenextsend <= :time', ['time' => time()]);
  50          $schedules = array_filter($schedules, [schedule::class, 'should_send_schedule']);
  51  
  52          // Loop over all schedules for sending, execute corresponding task to send each individually.
  53          foreach ($schedules as $schedule) {
  54              $sendschedule = new send_schedule();
  55              $sendschedule->set_custom_data([
  56                  'reportid' => $schedule->get('reportid'),
  57                  'scheduleid' => $schedule->get('id'),
  58              ]);
  59              $sendschedule->execute();
  60  
  61              // Calculate next send time (set persistent property manually to avoid updating it's user/time modified data).
  62              $DB->set_field($schedule::TABLE, 'timenextsend', schedule::calculate_next_send_time($schedule->read()),
  63                  ['id' => $schedule->get('id')]);
  64          }
  65      }
  66  }