Skip to content

Commit 04ebf6f

Browse files
robocoderrobocoder
committed
Add getWindowHandle and newWindow wrappers, plus other cleanup
1 parent a4b38b4 commit 04ebf6f

File tree

7 files changed

+112
-87
lines changed

7 files changed

+112
-87
lines changed

‎lib/WebDriver/Alert.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616
*
1717
* @package WebDriver
1818
*
19-
* @method array accept() Accept Alert
20-
* @method array dismiss() Dismiss Alert
21-
* @method array getText() Get Alert Text
22-
* @method array postText() Send Alert Text
19+
* @method array accept() Accept alert.
20+
* @method array dismiss() Dismiss alert.
21+
* @method array getText() Get alert text.
22+
* @method array postText() Send alert text.
2323
*/
2424
class Alert extends AbstractWebDriver
2525
{

‎lib/WebDriver/Container.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ public function __construct($url)
3232
{
3333
parent::__construct($url);
3434

35-
$locatorStrategy = new \ReflectionClass('WebDriver\LocatorStrategy');
36-
$this->strategies = $locatorStrategy->getConstants();
35+
$locatorStrategy = new \ReflectionClass('WebDriver\LocatorStrategy');
36+
$this->strategies = $locatorStrategy->getConstants();
3737
}
3838

3939
/**

‎lib/WebDriver/Element.php‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,10 @@
2626
* @method array location() Determine an element's location on the page.
2727
* @method array location_in_view() Determine an element's location on the screen once it has been scrolled into view.
2828
* @method string name() Query for an element's tag name.
29-
* @method array property($propertyName) Get Element Property
30-
* @method array rect() Get Element Rect
31-
* @method array screenshot() Take Element Screenshot
29+
* @method array property($propertyName) Get element property.
30+
* @method array rect() Get element rect.
31+
* @method array screenshot() Take element screenshot.
32+
* @method array selected() Is element selected?
3233
* @method array size() Determine an element's size in pixels.
3334
* @method void submit() Submit a FORM element.
3435
* @method string text() Returns the visible text for the element.
@@ -65,7 +66,7 @@ protected function methods()
6566
'value' => array('POST'),
6667

6768
// Legacy JSON Wire Protocol
68-
'displayed' => array('GET'),
69+
'displayed' => array('GET'), // @see https://w3c.github.io/webdriver/#element-displayedness
6970
'equals' => array('GET'),
7071
'location' => array('GET'),
7172
'location_in_view' => array('GET'),

‎lib/WebDriver/LegacyElement.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
* @method array location() Determine an element's location on the page.
2727
* @method array location_in_view() Determine an element's location on the screen once it has been scrolled into view.
2828
* @method string name() Query for an element's tag name.
29-
* @method array property($propertyName) Get Element Property
30-
* @method array rect() Get Element Rect
31-
* @method array screenshot() Take Element Screenshot
29+
* @method array property($propertyName) Get element property.
30+
* @method array rect() Get element rect.
31+
* @method array screenshot() Take element screenshot.
3232
* @method array size() Determine an element's size in pixels.
3333
* @method void submit() Submit a FORM element.
3434
* @method string text() Returns the visible text for the element.

‎lib/WebDriver/LegacyWindow.php‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@
2525
class LegacyWindow extends AbstractWebDriver
2626
{
2727
/**
28-
* Window handle
29-
*
3028
* @var string
3129
*/
3230
private $windowHandle;
@@ -55,25 +53,33 @@ protected function obsoleteMethods()
5553
}
5654

5755
/**
58-
* Get window handle
56+
* Constructor
5957
*
60-
* @return string
58+
* @param string $url
59+
* @param string|null $windowHandle
6160
*/
62-
public function getHandle()
61+
public function __construct($url, $windowHandle = null)
6362
{
64-
return $this->windowHandle;
63+
parent::__construct($url);
64+
65+
$this->windowHandle = $windowHandle;
6566
}
6667

6768
/**
68-
* Constructor
69+
* Get window handle: /session/:sessionId/window_handle (GET)
70+
* - $session->window($handle)->getHandle()
71+
* - $session->window()->getHandle()
6972
*
70-
* @param string $url URL
71-
* @param string $windowHandle Window handle
73+
* @return string
7274
*/
73-
public function __construct($url, $windowHandle)
75+
public function getHandle()
7476
{
75-
$this->windowHandle = $windowHandle;
77+
if (! $this->windowHandle) {
78+
$result = $this->curl('GET', '_handle');
79+
80+
$this->windowHandle = $result['value'];
81+
}
7682

77-
parent::__construct($url . '/' . $windowHandle);
83+
return $this->windowHandle;
7884
}
7985
}

‎lib/WebDriver/Session.php‎

Lines changed: 47 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
* @package WebDriver
1818
*
1919
* @method void accept_alert() Accepts the currently displayed alert dialog.
20-
* @method array deleteActions() Release Actions
21-
* @method array postActions() Perform Actions
20+
* @method array deleteActions() Release actions.
21+
* @method array postActions() Perform actions.
2222
* @method string getAlert_text() Gets the text of the currently displayed JavaScript alert(), confirm(), or prompt() dialog.
2323
* @method void postAlert_text($jsonText) Sends keystrokes to a JavaScript prompt() dialog.
2424
* @method void back() Navigates backward in the browser history, if possible.
@@ -40,13 +40,13 @@
4040
* @method void moveto($jsonCoordinates) Move the mouse by an offset of the specified element (or current mouse cursor).
4141
* @method string getOrientation() Get the current browser orientation.
4242
* @method void postOrientation($jsonOrientation) Set the current browser orientation.
43-
* @method array print() Print Page
43+
* @method array print() Print page.
4444
* @method void refresh() Refresh the current page.
4545
* @method string screenshot() Take a screenshot of the current page.
4646
* @method string source() Get the current page source.
4747
* @method string title() Get the current page title.
48-
* @method string url() Retrieve the URL of the current page
49-
* @method void postUrl($jsonUrl) Navigate to a new URL
48+
* @method string url() Retrieve the URL of the current page.
49+
* @method void postUrl($jsonUrl) Navigate to a new URL.
5050
* @method string window_handle() Retrieve the current window handle.
5151
* @method array window_handles() Retrieve the list of all window handles available to the session.
5252
*/
@@ -96,7 +96,7 @@ protected function methods()
9696
'location' => array('GET', 'POST'),
9797
'moveto' => array('POST'),
9898
'orientation' => array('GET', 'POST'),
99-
'window_handle' => array('GET'),
99+
'window_handle' => array('GET'), // see also getWindowHandle()
100100
'window_handles' => array('GET'),
101101
);
102102
}
@@ -218,55 +218,67 @@ public function deleteCookie($cookieName)
218218
}
219219

220220
/**
221-
* Window method chaining, e.g.,
222-
* - $session->window($handle)->method() - chaining
221+
* Get window handle: /session/:sessionId/window (GET)
222+
* : /session/:sessionId/window_handle (GET)
223+
* - $session->getWindowHandle()
223224
*
224-
* @return \WebDriver\Window
225+
* An alternative to $session->window()->getHandle()
226+
*
227+
* @return mixed
225228
*/
226-
public function window()
229+
public function getWindowHandle()
227230
{
228-
// legacy window methods
229-
if ($this->legacy) {
230-
return call_user_func_array(array($this, 'legacyWindow'), func_get_args());
231-
}
231+
$result = $this->curl('GET', $this->legacy ? '/window_handle' : '/window');
232232

233-
return new Window($this->url . '/window');
233+
return $result['value'];
234234
}
235235

236236
/**
237-
* Legacy window methods: /session/:sessionId/window (POST, DELETE)
238-
* - $session->legacyWindow() - close current window
239-
* - $session->legacyWindow($name) - set focus
240-
* - $session->legacyWindow($window_handle)->method() - chaining
237+
* New window: /session/:sessionId/window/new (POST)
238+
* - $session->newWindow($type)
241239
*
242-
* @deprecated
240+
* @internal "new" is a reserved keyword in PHP, so $session->window()->new() isn't possible
243241
*
244-
* @return \WebDriver\LegacyWindow|\WebDriver\Session
242+
* @return \WebDriver\Window
245243
*/
246-
public function legacyWindow()
244+
public function newWindow($type)
247245
{
248-
// close current window
249-
if (func_num_args() === 0) {
250-
$this->curl('DELETE', '/window');
246+
$arg = func_get_arg(0); // json
251247

252-
return $this;
253-
}
248+
$result = $this->curl('POST', '/window/new', $arg);
249+
250+
return $result['value'];
251+
}
252+
253+
/**
254+
* window method chaining: /session/:sessionId/window (POST
255+
* - $session->window($jsonHandle) - set focus
256+
* - $session->window($handle)->method() - chaining
257+
* - $session->window()->method() - chaining
258+
*
259+
* @return \WebDriver\Session|\WebDriver\Window|\WebDriver\LegacyWindow
260+
*/
261+
public function window()
262+
{
263+
$arg = null;
254264

255-
// set focus
256-
$arg = func_get_arg(0); // window handle or name attribute
265+
// set window focus / switch to window
266+
if (func_num_args() === 1) {
267+
$arg = func_get_arg(0); // window handle or name attribute
257268

258-
if (is_array($arg)) {
259-
$this->curl('POST', '/window', $arg);
269+
if (is_array($arg)) {
270+
$this->curl('POST', '/window', $arg);
260271

261-
return $this;
272+
return $this;
273+
}
262274
}
263275

264-
// chaining
265-
return new LegacyWindow($this->url . '/window', $arg);
276+
// chaining (with optional handle in $arg)
277+
return $this->legacy ? new LegacyWindow($this->url . '/window', $arg) : new Window($this->url . '/window', $arg);
266278
}
267279

268280
/**
269-
* Delete window: /session/:sessionId/window (DELETE)
281+
* Close window: /session/:sessionId/window (DELETE)
270282
*
271283
* @return \WebDriver\Session
272284
*/

‎lib/WebDriver/Window.php‎

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,26 @@
1616
*
1717
* @package WebDriver
1818
*
19-
* @method array handles() Get Window Handles
20-
* @method array fullscreen() Fullscreen Window
19+
* @method array handles() Get window handles.
20+
* @method array fullscreen() Fullscreen window.
2121
* @method array maximize() Maximize the window if not already maximized.
22-
* @method array minimize() Minimize Window
22+
* @method array minimize() Minimize window.
2323
* @method array getPosition() Get position of the window.
2424
* @method void postPosition($json) Change position of the window.
25-
* @method array getRect() Get Window Rect
26-
* @method array postRect() Set Window Rect
27-
* @method array getSize() Get Window Size
28-
* @method array postSize() Set Window Size
25+
* @method array getRect() Get window rect.
26+
* @method array postRect() Set window rect.
27+
* @method array getSize() Get window size.
28+
* @method array postSize() Set window size.
2929
*/
3030
class Window extends AbstractWebDriver
3131
{
3232
const WEB_WINDOW_ID = 'window-fcc6-11e5-b4f8-330a88ab9d7f';
3333

34+
/**
35+
* @var string
36+
*/
37+
private $windowHandle;
38+
3439
/**
3540
* {@inheritdoc}
3641
*/
@@ -40,42 +45,43 @@ protected function methods()
4045
'handles' => array('GET'),
4146
'fullscreen' => array('POST'),
4247
'maximize' => array('POST'),
43-
'position' => array('GET', 'POST'),
44-
'size' => array('GET', 'POST'),
45-
46-
// obsolete
4748
'minimize' => array('POST'),
49+
'position' => array('GET', 'POST'),
4850
'rect' => array('GET', 'POST'),
51+
'size' => array('GET', 'POST'),
4952
);
5053
}
5154

5255
/**
53-
* Get window handle
56+
* Constructor
5457
*
55-
* @return string
58+
* @param string $url
59+
* @param string|null $windowHandle
5660
*/
57-
public function getHandle()
61+
public function __construct($url, $windowHandle = null)
5862
{
59-
$result = $this->curl('GET', $this->url);
63+
parent::__construct($url);
6064

61-
return array_key_exists(self::WEB_WINDOW_ID, $result['value'])
62-
? $result['value'][self::WEB_WINDOW_ID]
63-
: $result['value'];
65+
$this->windowHandle = $windowHandle;
6466
}
6567

6668
/**
67-
* New window: /session/:sessionId/window/new (POST)
68-
*
69-
* @deprecated
70-
*
71-
* @param string $name
69+
* Get window handle: /session/:sessionId/window (GET)
70+
* - $session->window($handle)->getHandle()
71+
* - $session->window()->getHandle()
7272
*
73-
* @return \WebDriver\Window
73+
* @return string
7474
*/
75-
public function focusWindow($name)
75+
public function getHandle()
7676
{
77-
$this->curl('POST', '/new');
77+
if (! $this->windowHandle) {
78+
$result = $this->curl('GET', $this->url);
79+
80+
$this->windowHandle = array_key_exists(self::WEB_WINDOW_ID, $result['value'])
81+
? $result['value'][self::WEB_WINDOW_ID]
82+
: $result['value'];
83+
}
7884

79-
return $this;
85+
return $this->windowHandle;
8086
}
8187
}

0 commit comments

Comments
 (0)