PHP Class WebDriver\Session

Inheritance: extends Container
Show file Open project: instaclick/php-webdriver Class Usage Examples

Public Methods

Method Description
activeElement ( ) : mixed Get active element (i.e., has focus): /session/:sessionId/element/active (POST) - $session->activeElement()
application_cache ( ) : WebDriver\ApplicationCache application cache chaining, e.g., - $session->application_cache()->status()
capabilities ( ) : mixed Get browser capabilities: /session/:sessionId (GET)
close ( ) : mixed Close session: /session/:sessionId (DELETE)
deleteAllCookies ( ) : Session Delete all cookies: /session/:sessionId/cookie (DELETE)
deleteCookie ( string $cookieName ) : Session Delete a cookie: /session/:sessionId/cookie/:name (DELETE)
deleteWindow ( ) : Session Delete window: /session/:sessionId/window (DELETE)
focusWindow ( mixed $name ) : Session Set focus to window: /session/:sessionId/window (POST)
frame ( ) : Session | WebDriver\Frame frame methods: /session/:sessionId/frame (POST) - $session->frame($json) - change focus to another frame on the page - $session->frame()->method() - chaining
getAllCookies ( ) : mixed Get all cookies: /session/:sessionId/cookie (GET) Alternative to: $session->cookie();
ime ( ) : WebDriver\Ime ime method chaining, e.g., - $session->ime()->method()
local_storage ( ) : WebDriver\Storage local_storage method chaining, e.g., - $session->local_storage()->method()
log ( ) : mixed log methods: /session/:sessionId/log (POST) - $session->log($type) - get log for given log type - $session->log()->method() - chaining
open ( string $url ) : Session Open URL: /session/:sessionId/url (POST) An alternative to $session->url($url);
session_storage ( ) : WebDriver\Storage session_storage method chaining, e.g., - $session->session_storage()->method()
setCookie ( array $cookieJson ) : Session Set cookie: /session/:sessionId/cookie (POST) Alternative to: $session->cookie($cookie_json);
timeouts ( ) : Session | WebDriver\Timeouts timeouts methods: /session/:sessionId/timeouts (POST) - $session->timeouts($json) - set timeout for an operation - $session->timeouts()->method() - chaining
touch ( ) : WebDriver\Touch touch method chaining, e.g., - $session->touch()->method()
window ( ) : WebDriver\Window | Session window methods: /session/:sessionId/window (POST, DELETE) - $session->window() - close current window - $session->window($name) - set focus - $session->window($window_handle)->method() - chaining

Protected Methods

Method Description
getElementPath ( $elementId )
methods ( )
obsoleteMethods ( )

Method Details

activeElement() public method

Get active element (i.e., has focus): /session/:sessionId/element/active (POST) - $session->activeElement()
public activeElement ( ) : mixed
return mixed

application_cache() public method

application cache chaining, e.g., - $session->application_cache()->status()
public application_cache ( ) : WebDriver\ApplicationCache
return WebDriver\ApplicationCache

capabilities() public method

Get browser capabilities: /session/:sessionId (GET)
public capabilities ( ) : mixed
return mixed

close() public method

Close session: /session/:sessionId (DELETE)
public close ( ) : mixed
return mixed

deleteAllCookies() public method

Delete all cookies: /session/:sessionId/cookie (DELETE)
public deleteAllCookies ( ) : Session
return Session

deleteCookie() public method

Delete a cookie: /session/:sessionId/cookie/:name (DELETE)
public deleteCookie ( string $cookieName ) : Session
$cookieName string
return Session

deleteWindow() public method

Delete window: /session/:sessionId/window (DELETE)
public deleteWindow ( ) : Session
return Session

focusWindow() public method

Set focus to window: /session/:sessionId/window (POST)
public focusWindow ( mixed $name ) : Session
$name mixed window handler or name attribute
return Session

frame() public method

frame methods: /session/:sessionId/frame (POST) - $session->frame($json) - change focus to another frame on the page - $session->frame()->method() - chaining
public frame ( ) : Session | WebDriver\Frame
return Session | WebDriver\Frame

getAllCookies() public method

Note: get cookie by name not implemented in API
public getAllCookies ( ) : mixed
return mixed

getElementPath() protected method

protected getElementPath ( $elementId )

ime() public method

ime method chaining, e.g., - $session->ime()->method()
public ime ( ) : WebDriver\Ime
return WebDriver\Ime

local_storage() public method

local_storage method chaining, e.g., - $session->local_storage()->method()
public local_storage ( ) : WebDriver\Storage
return WebDriver\Storage

log() public method

log methods: /session/:sessionId/log (POST) - $session->log($type) - get log for given log type - $session->log()->method() - chaining
public log ( ) : mixed
return mixed

methods() protected method

protected methods ( )

obsoleteMethods() protected method

protected obsoleteMethods ( )

open() public method

Open URL: /session/:sessionId/url (POST) An alternative to $session->url($url);
public open ( string $url ) : Session
$url string
return Session

session_storage() public method

session_storage method chaining, e.g., - $session->session_storage()->method()
public session_storage ( ) : WebDriver\Storage
return WebDriver\Storage

setCookie() public method

Set cookie: /session/:sessionId/cookie (POST) Alternative to: $session->cookie($cookie_json);
public setCookie ( array $cookieJson ) : Session
$cookieJson array
return Session

timeouts() public method

timeouts methods: /session/:sessionId/timeouts (POST) - $session->timeouts($json) - set timeout for an operation - $session->timeouts()->method() - chaining
public timeouts ( ) : Session | WebDriver\Timeouts
return Session | WebDriver\Timeouts

touch() public method

touch method chaining, e.g., - $session->touch()->method()
public touch ( ) : WebDriver\Touch
return WebDriver\Touch

window() public method

window methods: /session/:sessionId/window (POST, DELETE) - $session->window() - close current window - $session->window($name) - set focus - $session->window($window_handle)->method() - chaining
public window ( ) : WebDriver\Window | Session
return WebDriver\Window | Session