add Timeout helpers

Author: robocoder

lib/WebDriver/Timeouts.php

@@ -4,8 +4,6 @@
  * @copyright 2011 Anthon Pang
  * @license Apache-2.0
  *
- * @package WebDriver
- *
  * @author Anthon Pang <apang@softwaredevelopment.ca>
  */
 
@@ -16,23 +14,90 @@
 /**
  * WebDriver\Timeouts class
  *
- * @package WebDriver
- *
- * @method void async_script($json) Set the amount of time, in milliseconds, that asynchronous scripts (executed by execute_async) are permitted to run before they are aborted and a timeout error is returned to the client.
- * @method void implicit_wait($json) Set the amount of time the driver should wait when searching for elements.
+ * @method void async_script($parameters) Set the amount of time, in milliseconds, that asynchronous scripts (executed by execute_async) are permitted to run before they are aborted and a timeout error is returned to the client.
+ * @method void implicit_wait($parameters) Set the amount of time the driver should wait when searching for elements.
  */
 class Timeouts extends AbstractWebDriver
 {
+    // Timeout name constants
+    const IMPLICIT  = 'implicit';
+    const PAGE_LOAD = 'pageLoad';
+    const SCRPT     = 'script';
+
     /**
      * {@inheritdoc}
      */
     protected function methods()
     {
-        return array(
+        return [
             // Legacy JSON Wire Protocol
-            'async_script' => array('POST'),
-            'implicit_wait' => array('POST'),
-        );
+            'async_script'  => ['POST'],
+            'implicit_wait' => ['POST'],
+        ];
+    }
+
+    /**
+     * Implicitly wait: /session/:sessionId/timeout/implicit_wait (POST)
+     *
+     * @deprecated
+     *
+     * @param array|integer $ms Parameters {ms: ...}
+     *
+     * @return \WebDriver\Timeouts
+     */
+    public function implicitlyWait($ms)
+    {
+        $parameters = is_array($ms)
+            ? $ms
+            : ['ms' => $ms];
+
+        // trigger_error(__METHOD__ . ': use "setTimeout()" instead', E_USER_DEPRECATED);
+
+        $result = $this->curl('POST', '/implicit_wait', $parameters);
+
+        return $this;
+    }
+
+    /**
+     * Set script timeout: /session/:sessionId/timeout/async_script (POST)
+     *
+     * @deprecated
+     *
+     * @param array|integer $ms Parameters {ms: ...}
+     *
+     * @return \WebDriver\Timeouts
+     */
+    public function setScriptTimeout($ms)
+    {
+        $parameters = is_array($ms)
+            ? $ms
+            : ['ms' => $ms];
+
+        // trigger_error(__METHOD__ . ': use "setTimeout()" instead', E_USER_DEPRECATED);
+
+        $result = $this->curl('POST', '/async_script', $parameters);
+
+        return $this;
+    }
+
+    /**
+     * Set timeout: /session/:sessionId/timeouts (POST)
+     *
+     * @param string|array $type    Timeout name (see constants above)
+     * @param integer      $timeout Duration in milliseconds
+     *
+     * @return \WebDriver\Timeouts
+     */
+    public function setTimeout($type, $timeout = null)
+    {
+        // set timeouts
+        $parameters = func_num_args() === 1 && is_array($type)
+            ? $type
+            : [$type => $timeout];
+
+        $this->curl('POST', '', $parameters);
+
+        return $this;
     }
 
     /**
@@ -47,7 +112,7 @@ protected function methods()
      *
      * @throws \Exception if thrown by callback, or \WebDriver\Exception\Timeout if helper times out
      */
-    public function wait($callback, $maxIterations = 1, $sleep = 0, $args = array())
+    public function wait($callback, $maxIterations = 1, $sleep = 0, $args = [])
     {
         $i = max(1, $maxIterations);