Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
behat_form_field Class Reference

Representation of a form field. More...

Inheritance diagram for behat_form_field:
behat_session_interface behat_form_checkbox behat_form_filemanager behat_form_group behat_form_select behat_form_select_menu behat_form_text behat_form_radio behat_form_date behat_form_inplaceeditable_select behat_form_modvisible behat_form_selectyesno behat_form_autocomplete behat_form_inplaceeditable behat_form_passwordunmask behat_form_textarea

Public Member Functions

 __construct (Session $session, NodeElement $fieldnode)
 General constructor with the node and the session to interact with.
 
 get_attribute ($name)
 Get the value of an attribute set on this field.
 
 get_value ()
 Returns the current value of the select element.
 
 getSession ($name=null)
 Returns the Mink session.
 
 key_press ($char, $modifier=null)
 Presses specific keyboard key.
 
 matches ($expectedvalue)
 Generic match implementation.
 
 set_value ($value)
 Sets the value to a field.
 

Public Attributes

const PAGE_READY_JS
 The JS code to check that the page is ready.
 

Protected Member Functions

 get_field_instance_for_element (NodeElement $element)
 Returns the appropriate form field object for a given node element.
 
 get_field_locator ($locatortype=false)
 Gets the field locator.
 
 get_internal_field_id ()
 Gets the field internal id used by selenium wire protocol.
 
 running_javascript ()
 Returns whether the scenario is running in a browser that can run Javascript or not.
 
 text_matches ($expectedvalue, ?string $actualvalue=null)
 Checks if the provided text matches the field value.
 
 wait_for_pending_js ()
 Waits for all the JS activity to be completed.
 

Protected Attributes

NodeElement $field
 The field DOM node to interact with.
 
string $fieldlocator = false
 The field's locator.
 
Session $session
 Behat session.
 

Detailed Description

Representation of a form field.

Basically an interface with Mink session.

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

Constructor & Destructor Documentation

◆ __construct()

behat_form_field::__construct ( Session $session,
NodeElement $fieldnode )

General constructor with the node and the session to interact with.

Parameters
Session$sessionReference to Mink session to traverse/modify the page DOM.
NodeElement$fieldnodeThe field DOM node
Return values
void

Member Function Documentation

◆ get_attribute()

behat_form_field::get_attribute ( $name)

Get the value of an attribute set on this field.

Parameters
string$nameThe attribute name
Return values
stringThe attribute value

◆ get_field_instance_for_element()

behat_form_field::get_field_instance_for_element ( NodeElement $element)
protected

Returns the appropriate form field object for a given node element.

Parameters
NodeElement$elementThe node element
Return values
behat_form_field

◆ get_field_locator()

behat_form_field::get_field_locator ( $locatortype = false)
protected

Gets the field locator.

Defaults to the field label but you can specify other locators if you are interested.

Public visibility as in most cases will be hard to use this method in a generic way, as fields can be selected using multiple ways (label, id, name...).

Exceptions
coding_exception
Parameters
string$locatortype
Return values
string

◆ get_internal_field_id()

behat_form_field::get_internal_field_id ( )
protected

Gets the field internal id used by selenium wire protocol.

Only available when running_javascript().

Exceptions
coding_exception
Return values
int

◆ get_value()

behat_form_field::get_value ( )

Returns the current value of the select element.

Return values
string

Reimplemented in behat_form_checkbox, behat_form_editor, behat_form_filemanager, behat_form_radio, behat_form_select, behat_form_select_menu, and behat_form_text.

◆ getSession()

behat_form_field::getSession ( $name = null)

Returns the Mink session.

Parameters
string | null$namename of the session OR active session will be used
Return values
Behat\Mink\Session

Implements behat_session_interface.

◆ key_press()

behat_form_field::key_press ( $char,
$modifier = null )

Presses specific keyboard key.

Parameters
mixed$charcould be either char ('b') or char-code (98)
string$modifierkeyboard modifier (could be 'ctrl', 'alt', 'shift' or 'meta')

◆ matches()

behat_form_field::matches ( $expectedvalue)

Generic match implementation.

Will work well with text-based fields, extension required for most of the other cases.

Parameters
string$expectedvalue
Return values
boolThe provided value matches the field value?

Reimplemented in behat_form_checkbox, behat_form_editor, behat_form_filemanager, behat_form_select, and behat_form_text.

◆ running_javascript()

behat_form_field::running_javascript ( )
protected

Returns whether the scenario is running in a browser that can run Javascript or not.

Return values
bool

◆ set_value()

◆ text_matches()

behat_form_field::text_matches ( $expectedvalue,
?string $actualvalue = null )
protected

Checks if the provided text matches the field value.

Parameters
string$expectedvalue
string | null$actualvalueThe actual value. If not specified, this will be fetched from $this->get_value().
Return values
bool

◆ wait_for_pending_js()

behat_form_field::wait_for_pending_js ( )
protected

Waits for all the JS activity to be completed.

Return values
boolWhether any JS is still pending completion.

Member Data Documentation

◆ 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.


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