[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_single_structure;
  24  use external_value;
  25  use external_warnings;
  26  use core_reportbuilder\manager;
  27  use core_reportbuilder\permission;
  28  use core_reportbuilder\event\report_viewed;
  29  
  30  defined('MOODLE_INTERNAL') || die();
  31  
  32  require_once("{$CFG->libdir}/externallib.php");
  33  
  34  /**
  35   * External method to record the viewing of a report
  36   *
  37   * @package     core_reportbuilder
  38   * @copyright   2022 Paul Holden <paulh@moodle.com>
  39   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   */
  41  class view extends external_api {
  42  
  43      /**
  44       * External method parameters
  45       *
  46       * @return external_function_parameters
  47       */
  48      public static function execute_parameters(): external_function_parameters {
  49          return new external_function_parameters([
  50              'reportid' => new external_value(PARAM_INT, 'Report ID'),
  51          ]);
  52      }
  53  
  54      /**
  55       * External method execution
  56       *
  57       * @param int $reportid
  58       * @return array
  59       */
  60      public static function execute(int $reportid): array {
  61          [
  62              'reportid' => $reportid,
  63          ] = self::validate_parameters(self::execute_parameters(), [
  64              'reportid' => $reportid,
  65          ]);
  66  
  67          $report = manager::get_report_from_id($reportid);
  68          self::validate_context($report->get_context());
  69  
  70          $persistent = $report->get_report_persistent();
  71          permission::require_can_view_report($persistent);
  72  
  73          // Trigger the report viewed event.
  74          report_viewed::create_from_object($persistent)->trigger();
  75  
  76          return [
  77             'status' => true,
  78             'warnings' => [],
  79          ];
  80      }
  81  
  82      /**
  83       * External method return value
  84       *
  85       * @return external_single_structure
  86       */
  87      public static function execute_returns(): external_single_structure {
  88          return new external_single_structure([
  89              'status' => new external_value(PARAM_BOOL, 'Success'),
  90              'warnings' => new external_warnings(),
  91          ]);
  92      }
  93  }