[Summary view]

Differences Between: [Versions 402 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  namespace core_external;
  18  
  19  /**
  20   * Description of top level - PHP function parameters.
  21   *
  22   * @package    core_external
  23   * @copyright  2009 Petr Skodak
  24   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  class external_function_parameters extends external_single_structure {
  27      /**
  28       * Constructor - does extra checking to prevent top level optional parameters.
  29       *
  30       * @param array $keys
  31       * @param string $desc
  32       * @param int $required
  33       * @param array $default
  34       */
  35      public function __construct(
  36          array $keys,
  37          $desc = '',
  38          $required = VALUE_REQUIRED,
  39          $default = null
  40      ) {
  41          global $CFG;
  42  
  43          if ($CFG->debugdeveloper) {
  44              foreach (array_values($keys) as $value) {
  45                  if ($value instanceof external_value) {
  46                      if ($value->required == VALUE_OPTIONAL) {
  47                          debugging('External function parameters: invalid OPTIONAL value specified.', DEBUG_DEVELOPER);
  48                          break;
  49                      }
  50                  }
  51              }
  52          }
  53          parent::__construct($keys, $desc, $required, $default);
  54      }
  55  }