<?php
namespace Facebook\WebDriver;
use Facebook\WebDriver\Exception\IndexOutOfBoundsException;
use Facebook\WebDriver\Exception\Internal\LogicException;
use Facebook\WebDriver\Exception\UnsupportedOperationException;
use Facebook\WebDriver\Remote\DriverCommand;
use Facebook\WebDriver\Remote\ExecuteMethod;
/**
* An abstraction allowing the driver to manipulate the browser's window
*/
class WebDriverWindow
{
/**
* @var ExecuteMethod
*/
protected $executor;
/**
* @var bool
*/
protected $isW3cCompliant;
public function __construct(ExecuteMethod $executor, $isW3cCompliant = false)
{
$this->executor = $executor;
$this->isW3cCompliant = $isW3cCompliant;
}
/**
* Get the position of the current window, relative to the upper left corner
* of the screen.
*
* @return WebDriverPoint The current window position.
*/
public function getPosition()
{
$position = $this->executor->execute(
DriverCommand::GET_WINDOW_POSITION,
[':windowHandle' => 'current']
);
return new WebDriverPoint(
$position['x'],
$position['y']
);
}
/**
* Get the size of the current window. This will return the outer window
* dimension, not just the view port.
*
* @return WebDriverDimension The current window size.
*/
public function getSize()
{
$size = $this->executor->execute(
DriverCommand::GET_WINDOW_SIZE,
[':windowHandle' => 'current']
);
return new WebDriverDimension(
$size['width'],
$size['height']
);
}
/**
* Minimizes the current window if it is not already minimized.
*
* @return WebDriverWindow The instance.
*/
public function minimize()
{
if (!$this->isW3cCompliant) {
throw new UnsupportedOperationException('Minimize window is only supported in W3C mode');
}
$this->executor->execute(DriverCommand::MINIMIZE_WINDOW, []);
return $this;
}
/**
* Maximizes the current window if it is not already maximized
*
* @return WebDriverWindow The instance.
*/
public function maximize()
{
if ($this->isW3cCompliant) {
$this->executor->execute(DriverCommand::MAXIMIZE_WINDOW, []);
} else {
$this->executor->execute(
DriverCommand::MAXIMIZE_WINDOW,
[':windowHandle' => 'current']
);
}
return $this;
}
/**
* Makes the current window full screen.
*
* @return WebDriverWindow The instance.
*/
public function fullscreen()
{
if (!$this->isW3cCompliant) {
throw new UnsupportedOperationException('The Fullscreen window command is only supported in W3C mode');
}
$this->executor->execute(DriverCommand::FULLSCREEN_WINDOW, []);
return $this;
}
/**
* Set the size of the current window. This will change the outer window
* dimension, not just the view port.
*
* @return WebDriverWindow The instance.
*/
public function setSize(WebDriverDimension $size)
{
$params = [
'width' => $size->getWidth(),
'height' => $size->getHeight(),
':windowHandle' => 'current',
];
$this->executor->execute(DriverCommand::SET_WINDOW_SIZE, $params);
return $this;
}
/**
* Set the position of the current window. This is relative to the upper left
* corner of the screen.
*
* @return WebDriverWindow The instance.
*/
public function setPosition(WebDriverPoint $position)
{
$params = [
'x' => $position->getX(),
'y' => $position->getY(),
':windowHandle' => 'current',
];
$this->executor->execute(DriverCommand::SET_WINDOW_POSITION, $params);
return $this;
}
/**
* Get the current browser orientation.
*
* @return string Either LANDSCAPE|PORTRAIT
*/
public function getScreenOrientation()
{
return $this->executor->execute(DriverCommand::GET_SCREEN_ORIENTATION);
}
/**
* Set the browser orientation. The orientation should either
* LANDSCAPE|PORTRAIT
*
* @param string $orientation
* @throws IndexOutOfBoundsException
* @return WebDriverWindow The instance.
*/
public function setScreenOrientation($orientation)
{
$orientation = mb_strtoupper($orientation);
if (!in_array($orientation, ['PORTRAIT', 'LANDSCAPE'], true)) {
throw LogicException::forError('Orientation must be either PORTRAIT, or LANDSCAPE');
}
$this->executor->execute(
DriverCommand::SET_SCREEN_ORIENTATION,
['orientation' => $orientation]
);
return $this;
}
}