[Summary view]

Differences Between: [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  namespace tiny_autosave\external;
  18  
  19  use core_external\external_api;
  20  use core_external\external_function_parameters;
  21  use core_external\external_single_structure;
  22  use core_external\external_value;
  23  
  24  /**
  25   * Web Service to reset the autosave session.
  26   *
  27   * @package   tiny_autosave
  28   * @category  external
  29   * @copyright 2022 Andrew Lyons <andrew@nicols.co.uk>
  30   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  31   */
  32  class reset_autosave_session extends external_api {
  33      /**
  34       * Returns description of method parameters
  35       *
  36       * @return external_function_parameters
  37       */
  38      public static function execute_parameters(): external_function_parameters {
  39          return new external_function_parameters([
  40              'contextid' => new external_value(PARAM_INT, 'The context id that owns the editor', VALUE_REQUIRED),
  41              'pagehash' => new external_value(PARAM_ALPHANUMEXT, 'The page hash', VALUE_REQUIRED),
  42              'pageinstance' => new external_value(PARAM_ALPHANUMEXT, 'The page instance', VALUE_REQUIRED),
  43              'elementid' => new external_value(PARAM_RAW, 'The ID of the element', VALUE_REQUIRED),
  44          ]);
  45      }
  46  
  47      /**
  48       * Reset the autosave entry for this autosave instance.
  49       *
  50       * If not matching autosave area could be found, the function will
  51       * silently return and this is not treated as an error condition.
  52       *
  53       * @param int $contextid The context id of the owner
  54       * @param string $pagehash The hash of the page
  55       * @param string $pageinstance The instance id of the page
  56       * @param string $elementid The id of the element
  57       * @return null
  58       */
  59      public static function execute(
  60          int $contextid,
  61          string $pagehash,
  62          string $pageinstance,
  63          string $elementid
  64      ): array {
  65          global $DB, $USER;
  66  
  67          [
  68              'contextid' => $contextid,
  69              'pagehash' => $pagehash,
  70              'elementid' => $elementid,
  71              'pageinstance' => $pageinstance,
  72          ] = self::validate_parameters(self::execute_parameters(), [
  73              'contextid' => $contextid,
  74              'pagehash' => $pagehash,
  75              'elementid' => $elementid,
  76              'pageinstance' => $pageinstance,
  77  
  78          ]);
  79  
  80          $manager = new \tiny_autosave\autosave_manager($contextid, $pagehash, $pageinstance, $elementid);
  81          $manager->remove_autosave_record();
  82  
  83          return [];
  84      }
  85  
  86      /**
  87       * Describe the return structure of the external service.
  88       *
  89       * @return external_single_structure
  90       */
  91      public static function execute_returns(): external_single_structure {
  92          return new external_single_structure([]);
  93      }
  94  }