[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\reports;
  20  
  21  use external_api;
  22  use external_function_parameters;
  23  use external_value;
  24  use core_reportbuilder\permission;
  25  use core_reportbuilder\local\helpers\report;
  26  use core_reportbuilder\local\models\report as report_model;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  global $CFG;
  31  require_once("{$CFG->libdir}/externallib.php");
  32  
  33  /**
  34   * External method for deleting reports
  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 delete 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          ]);
  51      }
  52  
  53      /**
  54       * External method execution
  55       *
  56       * @param int $reportid
  57       * @return bool
  58       */
  59      public static function execute(int $reportid): bool {
  60          [
  61              'reportid' => $reportid,
  62          ] = self::validate_parameters(self::execute_parameters(), [
  63              'reportid' => $reportid,
  64          ]);
  65  
  66          // Load the report model for deletion. Note we don't use the manager class because it validates the report source,
  67          // and we want user to be able to delete report, even if it's no longer associated with a valid source.
  68          $report = new report_model($reportid);
  69  
  70          self::validate_context($report->get_context());
  71          permission::require_can_edit_report($report);
  72  
  73          return report::delete_report($reportid);
  74      }
  75  
  76      /**
  77       * External method return value
  78       *
  79       * @return external_value
  80       */
  81      public static function execute_returns(): external_value {
  82          return new external_value(PARAM_BOOL, 'Success');
  83      }
  84  }