behat_data_generators Class Reference

Inheritance diagram for behat_data_generators:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session. More...
	the_following_entities_exist ($entitytype, TableNode $data)
	Creates the specified elements. More...
	the_following_entity_exists ($entitytype, TableNode $data)
	Creates the specified element. More...

Public Attributes
const	EXTENDED_TIMEOUT = 10
	And extended timeout for specific cases. More...
const	PAGE_READY_JS
	The JS code to check that the page is ready. More...
const	REDUCED_TIMEOUT = 2
	Small timeout. More...
const	TIMEOUT = 6
	The timeout for each Behat step (load page, wait for an element to load...). More...

Protected Member Functions
	get_instance_for_component (string $component)
	Get an instance of the appropriate subclass of this class for a given component. More...
	parse_entity_type (string $entitytype)
	Parse a full entity type like 'users' or 'mod_forum > subscription'. More...

Protected Attributes
array	$movedentitytypes
	Convert legacy entity names to the new component-specific form. More...

Member Function Documentation

get_instance_for_component()

behat_data_generators::get_instance_for_component ( string  $component )

protected

Get an instance of the appropriate subclass of this class for a given component.

Parameters

string

$component

The name of the component to generate entities for.

Return values

behat_generator_base

the subclass of this class for the requested component.

getSession()

behat_session_interface::getSession (   $name = null )

inherited

Returns the Mink session.

Parameters

string | null

$name

name of the session OR active session will be used

Return values

Behat::Mink::Session

Implemented in behat_form_field.

parse_entity_type()

behat_data_generators::parse_entity_type ( string  $entitytype )

protected

Parse a full entity type like 'users' or 'mod_forum > subscription'.

E.g. parsing 'course' gives ['core', 'course'] and parsing 'core_message > message' gives ['core_message', 'message'].

Parameters

string

$entitytype

the entity type

Return values

string[]

with two elements, component and entity type.

the_following_entities_exist()

behat_data_generators::the_following_entities_exist	(		$entitytype,
		TableNode	$data
	)

Creates the specified elements.

See the class comment for an overview.

@Given /^the following "(?P<element_string>(?:[^"]|::")*)" exist:$/

Parameters

string	$entitytype	The name of the type entity to add
TableNode	$data

the_following_entity_exists()

behat_data_generators::the_following_entity_exists	(		$entitytype,
		TableNode	$data
	)

Creates the specified element.

See the class comment for an overview.

@Given the following :entitytype exists:

Parameters

string	$entitytype	The name of the type entity to add
TableNode	$data

Member Data Documentation

$movedentitytypes

array behat_data_generators::$movedentitytypes

protected

Initial value:

= [
    ]

Convert legacy entity names to the new component-specific form.

In the past, there was no support for plugins, and everything that could be created was handled by the core generator. Now, we can support plugins, and so some thing should probably be moved.

For example, in the future we should probably add 'message contacts' => 'core_message > contact'] to this array, and move generation of message contact from core to core_message.

old entity type => new entity type.

EXTENDED_TIMEOUT

const behat_session_interface::EXTENDED_TIMEOUT = 10

inherited

And extended timeout for specific cases.

Deprecated:

since Moodle 3.7 MDL-64979 - please use get_extended_timeout() instead

Todo:

MDL-64982 This will be deleted in Moodle 3.11

See also

behat_base::get_extended_timeout()

PAGE_READY_JS

const behat_session_interface::PAGE_READY_JS

inherited

Initial value:

= "document.readyState === 'complete' && " .
        "(typeof M !== 'object' || typeof M.util !== 'object' || " .
        "typeof M.util.pending_js === 'undefined' || M.util.pending_js.length === 0)"

The JS code to check that the page is ready.

The document must be complete and either M.util.pending_js must be empty, or it must not be defined at all.

REDUCED_TIMEOUT

const behat_session_interface::REDUCED_TIMEOUT = 2

inherited

Small timeout.

A reduced timeout for cases where self::TIMEOUT is too much and a simple $this->getSession()->getPage()->find() could not be enough.

Deprecated:

since Moodle 3.7 MDL-64979 - please use get_reduced_timeout() instead

Todo:

MDL-64982 This will be deleted in Moodle 3.11

See also

behat_base::get_reduced_timeout()

TIMEOUT

const behat_session_interface::TIMEOUT = 6

inherited

The timeout for each Behat step (load page, wait for an element to load...).

Deprecated:

since Moodle 3.7 MDL-64979 - please use get_timeout() instead

Todo:

MDL-64982 This will be deleted in Moodle 3.11

See also

behat_base::get_timeout()

---

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

• lib/tests/behat/behat_data_generators.php