behat_form_radio Class Reference

Radio input form field. More...

Inheritance diagram for behat_form_radio:

Public Member Functions
	get_attribute ($name)
	Get the value of an attribute set on this field.
	get_value ()
	Returns the radio input value attribute.
	getSession ($name=null)
	Returns the Mink session.
	key_press ($char, $modifier=null)
	Presses specific keyboard key.
	matches ($expectedvalue=false)
	Is it enabled?
	set_value ($value)
	Sets the value of a radio.

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

Radio input form field.

Copyright

2013 David Monllaó

License

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

Extends behat_form_checkbox as the set_value() behaviour is the same and it behaves closer to a checkbox than to a text field.

This form field type can be added to forms as any other moodle form element, but it does not make sense without a group of radio inputs, so is hard to find it alone and detect it by behat_field_manager\get_form_field(), where is useful is when the default behat_form_field class is being used, it finds a input[type=radio] and it delegates set_value() and get_value() to behat_form_radio.

Copyright

2013 David Monllaó

License

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

Member Function Documentation

get_attribute()

behat_form_field::get_attribute ( $name )

inherited

Get the value of an attribute set on this field.

Parameters

string

$name

The attribute name

Return values

string

The attribute value

get_field_instance_for_element()

behat_form_field::get_field_instance_for_element ( NodeElement $element )

protectedinherited

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

Parameters

NodeElement

$element

The node element

Return values

behat_form_field

get_field_locator()

behat_form_field::get_field_locator ( $locatortype = false )

protectedinherited

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 ( )

protectedinherited

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_radio::get_value

(

)

Returns the radio input value attribute.

Here we can not extend behat_form_checkbox because isChecked() does internally a (bool)getValue() and it is not good for radio buttons.

Return values

string

The value attribute

Reimplemented from behat_form_checkbox.

getSession()

behat_form_field::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

Implements behat_session_interface.

key_press()

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

inherited

Presses specific keyboard key.

Parameters

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

matches()

behat_form_checkbox::matches ( $expectedvalue = false )

inherited

Is it enabled?

Parameters

string

$expectedvalue

Anything !empty() is considered checked.

Return values

bool

Reimplemented from behat_form_field.

running_javascript()

behat_form_field::running_javascript ( )

protectedinherited

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

Return values

bool

set_value()

behat_form_radio::set_value

(

$value

)

Sets the value of a radio.

Partially overwriting behat_form_checkbox implementation as when JS is disabled we can not check() and we should use setValue()

Parameters

string

$value

Return values

void

Reimplemented from behat_form_checkbox.

text_matches()

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

protectedinherited

Checks if the provided text matches the field value.

Parameters

string	$expectedvalue
string | null	$actualvalue	The 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 ( )

protectedinherited

Waits for all the JS activity to be completed.

Return values

bool	Whether 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:

• lib/behat/form_field/behat_form_radio.php