Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Public Attributes | List of all members
external_single_structure Class Reference

Associative array description class. More...

Inheritance diagram for external_single_structure:
external_description external_function_parameters

Public Member Functions

 __construct (array $keys, $desc='', $required=VALUE_REQUIRED, $default=null)
 Constructor. 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

Associative array description class.

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters
array$keys
string$desc
bool$required
array$default
Since
Moodle 2.0

Reimplemented in external_function_parameters.


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