[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

   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\external\schedules;
  20  
  21  use external_api;
  22  use external_function_parameters;
  23  use external_value;
  24  use core_reportbuilder\manager;
  25  use core_reportbuilder\permission;
  26  use core_reportbuilder\local\helpers\schedule;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  global $CFG;
  31  require_once("{$CFG->libdir}/externallib.php");
  32  
  33  /**
  34   * External method for toggling report schedules
  35   *
  36   * @package     core_reportbuilder
  37   * @copyright   2021 Paul Holden <paulh@moodle.com>
  38   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39   */
  40  class toggle extends external_api {
  41  
  42      /**
  43       * External method parameters
  44       *
  45       * @return external_function_parameters
  46       */
  47      public static function execute_parameters(): external_function_parameters {
  48          return new external_function_parameters([
  49              'reportid' => new external_value(PARAM_INT, 'Report ID'),
  50              'scheduleid' => new external_value(PARAM_INT, 'Schedule ID'),
  51              'enabled' => new external_value(PARAM_BOOL, 'Schedule enabled'),
  52          ]);
  53      }
  54  
  55      /**
  56       * External method execution
  57       *
  58       * @param int $reportid
  59       * @param int $scheduleid
  60       * @param bool $enabled
  61       * @return bool
  62       */
  63      public static function execute(int $reportid, int $scheduleid, bool $enabled): bool {
  64          [
  65              'reportid' => $reportid,
  66              'scheduleid' => $scheduleid,
  67              'enabled' => $enabled,
  68          ] = self::validate_parameters(self::execute_parameters(), [
  69              'reportid' => $reportid,
  70              'scheduleid' => $scheduleid,
  71              'enabled' => $enabled,
  72          ]);
  73  
  74          $report = manager::get_report_from_id($reportid);
  75  
  76          self::validate_context($report->get_context());
  77          permission::require_can_edit_report($report->get_report_persistent());
  78  
  79          return schedule::toggle_schedule($reportid, $scheduleid, $enabled);
  80      }
  81  
  82      /**
  83       * External method return value
  84       *
  85       * @return external_value
  86       */
  87      public static function execute_returns(): external_value {
  88          return new external_value(PARAM_BOOL);
  89      }
  90  }