[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  /**
  18   * An external function that throws an exception, for tests.
  19   *
  20   * @package    core
  21   * @category   phpunit
  22   * @copyright  2020 Dani Palou
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  require_once("$CFG->libdir/externallib.php");
  29  
  30  /**
  31   * Create an external function that throws an exception, for tests.
  32   *
  33   * @copyright  2020 Dani Palou
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class test_external_function_throwable extends external_api {
  37  
  38      /**
  39       * Returns description of throw_exception() parameters.
  40       *
  41       * @return external_function_parameters
  42       */
  43      public static function throw_exception_parameters() {
  44          return new external_function_parameters(array());
  45      }
  46  
  47      /**
  48       * Throws a PHP error.
  49       *
  50       * @return array empty array.
  51       */
  52      public static function throw_exception() {
  53          $a = 1 % 0;
  54  
  55          return array();
  56      }
  57  
  58      /**
  59       * Returns description of throw_exception() result value.
  60       *
  61       * @return external_description
  62       */
  63      public static function throw_exception_returns() {
  64          return new external_single_structure(array());
  65      }
  66  
  67      /**
  68       * Override external_function_info to accept our fake WebService.
  69       */
  70      public static function external_function_info($function, $strictness=MUST_EXIST) {
  71          if ($function == 'core_throw_exception') {
  72              // Convert it to an object.
  73              $function = new stdClass();
  74              $function->name = $function;
  75              $function->classname = 'test_external_function_throwable';
  76              $function->methodname = 'throw_exception';
  77              $function->classpath = ''; // No need to define class path because current file is already loaded.
  78              $function->component = 'fake';
  79              $function->capabilities = '';
  80              $function->services = 'moodle_mobile_app';
  81              $function->loginrequired = false;
  82          }
  83  
  84          return parent::external_function_info($function, $strictness);
  85      }
  86  }