Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/admin/tool/behat/classes/external/ -> get_entity_generator.php (source)

[Source view]

Differences Between: [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403]

Return data about an entity generator.

Author: Mark Johnson <mark.johnson@catalyst-eu.net>
Copyright: 2022 onwards Catalyst IT EU {@link https://catalyst-eu.net}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 94 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

get_entity_generator:: (3 methods):
  execute_parameters()
  execute()
  execute_returns()


Class: get_entity_generator  - X-Ref

External function for getting properties of entity generators.

execute_parameters()   X-Ref
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: external_function_parameters

execute(string $entitytype)   X-Ref
Return a list of the required fields for a given entity type.

param: string $entitytype
return: array

execute_returns()   X-Ref
Define return values.

Return required fields

return: external_single_structure