Overview

Classes

  • VideoTestWebTestCaseDriver
  • VideoTestWebTestCaseDriverFunctions
  • Overview
  • Class

Class VideoTestWebTestCaseDriverFunctions

Collection of video functions

Located at VideoTestWebTestCaseDriver.php
Methods summary
public CWebTestCase
# videoSetVisible( string $element )

Makes sure that element is visible. Scrolls page up or down if necessary. No horizontal scroll.

Makes sure that element is visible. Scrolls page up or down if necessary. No horizontal scroll.

Parameters

$element
  • same as element in Selenium methods

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoMouseClick( string $element, true|array $nearTheLeftSide = false, $highlightCallback = false )

Draws mouse cursor which moves towards desired control, then invokes mouseOver This method DOES NOT CLICK, this method only animates mouse cursor (arrow)

Draws mouse cursor which moves towards desired control, then invokes mouseOver This method DOES NOT CLICK, this method only animates mouse cursor (arrow)

Parameters

$element
  • same as element in Selenium methods
$nearTheLeftSide

true -> mouse will move to the left side of the element (useful for labels of checkboxes) array(top,left) - exact coordinates (px) where to move array(+5, +0) - tweak coordinates - add 5 px to top and leave left as is

$highlightCallback

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoSleep( integer $millis = 2000 )

Just pause to let user see what's on the screen.

Just pause to let user see what's on the screen.

Pause is skipped in any of fast modes.

Parameters

$millis
time to sleep in milliseconds, default = 2000 (2 seconds)

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoCustomSelectBoxSelect( string $id, string $value )

Selects an item from drop-down select box, when custom selectbox is used

Selects an item from drop-down select box, when custom selectbox is used

Parameters

$id
id of select element
$value
value to be selected. IMPORTANT: value should be visible initially, scrolling is not implemented yet

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoHideDatePicker( )

Removes DatePicker window, that will eventually appear after you focus on date text input

Removes DatePicker window, that will eventually appear after you focus on date text input

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoSetDefaultMessagePosition( $position = VideoTestWebTestCaseDriverFunctions::VIDEO_DEFAULT_MESSAGE_POSITION )

Sets default position for message window.

Sets default position for message window.

Parameters

$position

a CSS style definition, e.g.: 'top: 100px; left: 100px; right: 100px; height: 200px;'. IMPORTANT: the ; at the end is mandatory

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoShowImage( array $files, integer|array $durations = 5 )

Shows slideshow of images. Use it when animation is not possible.

Shows slideshow of images. Use it when animation is not possible.

Parameters

$files
array of filenames of images to be shown
$durations

pause between sequental images, measured in seconds. If array is specified, then it should have same keys and same number of items as $files

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoShowMessage( $text, $position = null, $moreMsToWait = 0 )

Shows message

Shows message

Parameters

$text
  • the text. Use "\n" to separate lines.
$position
see videoSetDefaultMessagePosition
$moreMsToWait

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoType( string $element, string $text )

Types text inside specified element

Types text inside specified element

Parameters

$element
  • same as element in Selenium methods
$text
  • text to type

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoStart( string $name )

Starts video recording

Starts video recording

Parameters

$name
  • name of video file

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoStop( )

Finishes video

Finishes video

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoInit( )

Prepares for video recording - opens homepage, clears cookies, maximizes window, sets ENVIRONMENT=SELENIUM_TEST cookie to let backend know that test configuration should be used

Prepares for video recording - opens homepage, clears cookies, maximizes window, sets ENVIRONMENT=SELENIUM_TEST cookie to let backend know that test configuration should be used

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoFast( )

Force fast mode -- used when debugging tests to save time

Force fast mode -- used when debugging tests to save time

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoSlow( )

Force slow mode -- used when debugging tests to save time

Force slow mode -- used when debugging tests to save time

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoSkip( )

Force skip mode -- used when debugging tests to save even more time - all visual effects will be turned off

Force skip mode -- used when debugging tests to save even more time - all visual effects will be turned off

Returns

CWebTestCase
$this for chaining
public CWebTestCase
# videoDefault( )

Reset mode to default (defined by config) -- used when debugging tests to save time

Reset mode to default (defined by config) -- used when debugging tests to save time

Returns

CWebTestCase
$this for chaining
public boolean|integer
# isFastModeOn( )

Returns

boolean|integer
0 or false for slow mode, 1 for fast mode, 2 for skip mode
public boolean
# isSkipModeOn( )

Returns

boolean
true if skip mode is on
Constants summary
string VIDEO_DEFAULT_MESSAGE_POSITION
# 'top: 100px; left: 100px; right: 100px; height: 200px;'
Properties summary
public boolean $overrideFastMode
# false
public $testCase
#
public string $videoDefaultMessagePosition
# VideoTestWebTestCaseDriverFunctions::VIDEO_DEFAULT_MESSAGE_POSITION
API documentation generated by ApiGen