tool_behat\external\get_entity_generator Class Reference

External function for getting properties of entity generators. More...

Inheritance diagram for tool_behat\external\get_entity_generator:

Static Public Member Functions
static	execute (string $entitytype)
	Return a list of the required fields for a given entity type.
static	execute_parameters ()
	Define parameters for external function.
static	execute_returns ()
	Define return values.

Detailed Description

External function for getting properties of entity generators.

Member Function Documentation

execute()

static tool_behat\external\get_entity_generator::execute ( string $entitytype )

static

Return a list of the required fields for a given entity type.

Parameters

string

$entitytype

Return values

array

execute_parameters()

static tool_behat\external\get_entity_generator::execute_parameters ( )

static

Define parameters for external function.

The parameter is either in the format 'entity' or 'component_name > entity'. There is no appropriate param type for a string like this containing angle brackets, so we will do PARAM_RAW. The value will be parsed by behat_data_generators\parse_entity_type, which validates the format of the parameter and throws an exception if it is not correct.

Return values

external_function_parameters

execute_returns()

static tool_behat\external\get_entity_generator::execute_returns ( )

static

Define return values.

Return required fields

Return values

external_single_structure

---

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

• admin/tool/behat/classes/external/get_entity_generator.php