[Summary view]

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

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