behat_repository_upload Class Reference

Steps definitions for the upload repository type. More...

Inheritance diagram for behat_repository_upload:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session.
	i_upload_and_overwrite_file_to_filemanager ($filepath, $filemanagerelement)
	Uploads a file to the specified filemanager leaving other fields in upload form default and confirms to overwrite an existing file.
	i_upload_and_overwrite_file_to_filemanager_as ($filepath, $filemanagerelement, TableNode $data)
	Uploads a file to the specified filemanager.
	i_upload_file_to_filemanager ($filepath, $filemanagerelement)
	Uploads a file to the specified filemanager leaving other fields in upload form default.
	i_upload_file_to_filemanager_as ($filepath, $filemanagerelement, TableNode $data)
	Uploads a file to the specified filemanager and confirms to overwrite an existing file.

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

Protected Member Functions
	get_filepicker_node ($filepickerelement)
	Try to get the filemanager node specified by the element.
	upload_file_to_filemanager ($filepath, $filemanagerelement, TableNode $data, $overwriteaction=false)
	Uploads a file to filemanager.

Detailed Description

Steps definitions for the upload repository type.

Copyright

2013 David Monllaó

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later Steps definitions to deal with the upload repository.

Copyright

2013 David Monllaó

License

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

Member Function Documentation

get_filepicker_node()

behat_repository_upload::get_filepicker_node ( $filepickerelement )

protected

Try to get the filemanager node specified by the element.

Parameters

string

$filepickerelement

Return values

Behat\Mink\Element\NodeElement

Exceptions

ExpectationException

Reimplemented in behat_theme_classic_behat_repository_upload.

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.

i_upload_and_overwrite_file_to_filemanager()

behat_repository_upload::i_upload_and_overwrite_file_to_filemanager	(		$filepath,
			$filemanagerelement )

Uploads a file to the specified filemanager leaving other fields in upload form default and confirms to overwrite an existing file.

The paths should be relative to moodle codebase.

@When /^I upload and overwrite "(?P<filepath_string>(?:[^"]|::")*)" file to "(?P<filemanager_field_string>(?:[^"]|")*)" filemanager$/

Exceptions

DriverException
ExpectationException	Thrown by behat_base\find

Parameters

string	$filepath
string	$filemanagerelement

i_upload_and_overwrite_file_to_filemanager_as()

behat_repository_upload::i_upload_and_overwrite_file_to_filemanager_as	(		$filepath,
			$filemanagerelement,
		TableNode	$data )

Uploads a file to the specified filemanager.

The paths should be relative to moodle codebase.

@When /^I upload and overwrite "(?P<filepath_string>(?:[^"]|::")*)" file to "(?P<filemanager_field_string>(?:[^"]|")*)" filemanager as:$/

Exceptions

DriverException
ExpectationException	Thrown by behat_base\find

Parameters

string	$filepath
string	$filemanagerelement
TableNode	$data	Data to fill in upload form

i_upload_file_to_filemanager()

behat_repository_upload::i_upload_file_to_filemanager	(		$filepath,
			$filemanagerelement )

Uploads a file to the specified filemanager leaving other fields in upload form default.

The paths should be relative to moodle codebase.

@When /^I upload "(?P<filepath_string>(?:[^"]|::")*)" file to "(?P<filemanager_field_string>(?:[^"]|")*)" filemanager$/

Exceptions

DriverException
ExpectationException	Thrown by behat_base\find

Parameters

string	$filepath
string	$filemanagerelement

i_upload_file_to_filemanager_as()

behat_repository_upload::i_upload_file_to_filemanager_as	(		$filepath,
			$filemanagerelement,
		TableNode	$data )

Uploads a file to the specified filemanager and confirms to overwrite an existing file.

The paths should be relative to moodle codebase.

@When /^I upload "(?P<filepath_string>(?:[^"]|::")*)" file to "(?P<filemanager_field_string>(?:[^"]|")*)" filemanager as:$/

Exceptions

DriverException
ExpectationException	Thrown by behat_base\find

Parameters

string	$filepath
string	$filemanagerelement
TableNode	$data	Data to fill in upload form

upload_file_to_filemanager()

behat_repository_upload::upload_file_to_filemanager ( $filepath, $filemanagerelement, TableNode $data, $overwriteaction = false )

protected

Uploads a file to filemanager.

Exceptions

DriverException
ExpectationException	Thrown by behat_base\find

Parameters

string	$filepath	Normally a path relative to $CFG->dirroot, but can be an absolute path too.
string	$filemanagerelement
TableNode	$data	Data to fill in upload form
false | string	$overwriteaction	false if we don't expect that file with the same name already exists, or button text in overwrite dialogue ("Overwrite", "Rename to ...", "Cancel")

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:

• repository/upload/tests/behat/behat_repository_upload.php