Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | List of all members
external_function_parameters Class Reference

Description of top level - PHP function parameters. More...

Inheritance diagram for external_function_parameters:
external_single_structure external_description

Public Member Functions

 __construct (array $keys, $desc='', $required=VALUE_REQUIRED, $default=null)
 Constructor - does extra checking to prevent top level optional parameters. More...
 

Public Attributes

mixed $default
 Default value.
 
string $desc
 Description of element.
 
array $keys
 Description of array keys key=>external_description.
 
bool $required
 Element value required, null not allowed.
 

Detailed Description

Description of top level - PHP function parameters.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Since
Moodle 2.0

Constructor & Destructor Documentation

◆ __construct()

external_function_parameters::__construct ( array  $keys,
  $desc = '',
  $required = VALUE_REQUIRED,
  $default = null 
)

Constructor - does extra checking to prevent top level optional parameters.

Parameters
array$keys
string$desc
bool$required
array$default

Reimplemented from external_single_structure.


The documentation for this class was generated from the following file: