[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 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  /**
  18   * This class contains a list of webservice functions related to session.
  19   *
  20   * @package    core
  21   * @copyright  2019 Damyon Wiese
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\session;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * This class contains a list of webservice functions related to session.
  31   *
  32   * @copyright  2019 Damyon Wiese
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   * @since      2.9
  35   */
  36  class external extends \external_api {
  37  
  38      /**
  39       * Returns description of touch_session() parameters.
  40       *
  41       * @return external_function_parameters
  42       */
  43      public static function touch_session_parameters() {
  44          return new \external_function_parameters([]);
  45      }
  46  
  47      /**
  48       * Extend the current session.
  49       *
  50       * @return array the mapping
  51       */
  52      public static function touch_session() {
  53          \core\session\manager::touch_session(session_id());
  54          return true;
  55      }
  56  
  57      /**
  58       * Returns description of touch_session() result value.
  59       *
  60       * @return external_description
  61       */
  62      public static function touch_session_returns() {
  63          return new \external_value(PARAM_BOOL, 'result');
  64      }
  65  
  66      /**
  67       * Returns description of time_remaining() parameters.
  68       *
  69       * @return external_function_parameters
  70       */
  71      public static function time_remaining_parameters() {
  72          return new \external_function_parameters([]);
  73      }
  74  
  75      /**
  76       * Extend the current session.
  77       *
  78       * @return array the mapping
  79       */
  80      public static function time_remaining() {
  81          return \core\session\manager::time_remaining(session_id());
  82      }
  83  
  84      /**
  85       * Returns description of touch_session() result value.
  86       *
  87       * @return external_description
  88       */
  89      public static function time_remaining_returns() {
  90          return new \external_single_structure(array (
  91                  'userid' => new \external_value(PARAM_INTEGER, 'The current user id.'),
  92                  'timeremaining' => new \external_value(PARAM_INTEGER, 'The number of seconds remaining in this session.')
  93          ));
  94      }
  95  }