behat_transformations Class Reference

Transformations to apply to steps arguments. More...

Inheritance diagram for behat_transformations:

Public Member Functions
	arg_insert_wwwroot (string $string)
	Convert wwwroot# to the wwwroot config value, so it is possible to reference fully qualified URLs within the site.
	arg_replace_nasty_strings ($argument)
	Replaces $NASTYSTRING vars for a nasty string.
	arg_replace_slashes ($string)
	Removes escaped argument delimiters.
	arg_time_to_string ($time)
	Convert string time to timestamp.
	getSession ($name=null)
	Returns the Mink session.
	prefixed_tablenode_transformations ()
	replace_nasty_strings ($string)
	Replaces $NASTYSTRING vars for a nasty string.
	tablenode_transformations (TableNode $tablenode)
	Transformations for TableNode arguments.

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

Protected Member Functions
	get_transformed_timestamp ($time)
	Return timestamp for the time passed.
	replace_wwwroot (string $string)
	Replace wwwroot# with the actual wwwroot config value.

Detailed Description

Transformations to apply to steps arguments.

This methods are applied to the steps arguments that matches the regular expressions specified in the @Transform tag.

Copyright

2013 David Monllaó

License

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

Member Function Documentation

arg_insert_wwwroot()

behat_transformations::arg_insert_wwwroot

(

string

$string

)

Convert wwwroot# to the wwwroot config value, so it is possible to reference fully qualified URLs within the site.

@Transform /^((.*)wwwroot#(.*))$/

Parameters

string

$string

Return values

string

arg_replace_nasty_strings()

behat_transformations::arg_replace_nasty_strings

(

$argument

)

Replaces $NASTYSTRING vars for a nasty string.

@Transform /^((.*)$NASTYSTRING(\d)(.*))$/

Parameters

string

$argument

The whole argument value.

Return values

string

arg_replace_slashes()

behat_transformations::arg_replace_slashes

(

$string

)

Removes escaped argument delimiters.

We use double quotes as arguments delimiters and to add the " as part of an argument we escape it with a backslash, this method removes this backslash. @Transform /^((.*)"(.*))$/

Parameters

string

$string

Return values

string

The string with the arguments fixed.

arg_time_to_string()

behat_transformations::arg_time_to_string

(

$time

)

Convert string time to timestamp.

Use time\STRING_TIME_TO_CONVERT\DATE_FORMAT::

@Transform /^##(.*)##$/

Parameters

string

$time

Return values

int	timestamp.

get_transformed_timestamp()

behat_transformations::get_transformed_timestamp ( $time )

protected

Return timestamp for the time passed.

Parameters

string

$time

time to convert

Return values

string

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.

prefixed_tablenode_transformations()

behat_transformations::prefixed_tablenode_transformations

(

)

Deprecated

since Moodle 3.2

replace_nasty_strings()

behat_transformations::replace_nasty_strings

(

$string

)

Replaces $NASTYSTRING vars for a nasty string.

Method reused by TableNode tranformation.

Parameters

string

$string

Return values

string

replace_wwwroot()

behat_transformations::replace_wwwroot ( string $string )

protected

Replace wwwroot# with the actual wwwroot config value.

Parameters

string

$string

String to attempt the replacement in.

Return values

string

tablenode_transformations()

behat_transformations::tablenode_transformations

(

TableNode

$tablenode

)

Transformations for TableNode arguments.

Transformations applicable to TableNode arguments should also be applied, adding them in a different method for Behat API restrictions.

@Transform table:*

Parameters

TableNode

$tablenode

Return values

TableNode

The transformed table

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/tests/behat/behat_transformations.php