add chainable() support

Author: robocoder

lib/WebDriver/AbstractWebDriver.php

@@ -62,6 +62,16 @@ protected function obsoleteMethods()
         return [];
     }
 
+    /**
+     * Return array of chainable method/property names
+     *
+     * @return array
+     */
+    protected function chainable()
+    {
+        return [];
+    }
+
     /**
      * Constructor
      *
@@ -172,6 +182,10 @@ public function __call($name, $arguments)
             return new $className($this->url . '/' . $this->extensions[$name][1]);
         }
 
+        if (count($arguments) === 0 && array_key_exists($name, $this->chainable())) {
+            return call_user_func([$this, $name]);
+        }
+
         if (preg_match('/^(get|post|delete)/', $name, $matches)) {
             $requestMethod = strtoupper($matches[0]);
             $webdriverCommand = strtolower(substr($name, strlen($requestMethod)));
@@ -204,6 +218,22 @@ public function __call($name, $arguments)
         return $result['value'];
     }
 
+    /**
+     * Magic method that maps property names to chainable methods
+     *
+     * @param string $name Property name
+     *
+     * @return mixed
+     */
+    public function __get($name)
+    {
+        if (array_key_exists($name, $this->chainable())) {
+            return call_user_func([$this, $name]);
+        }
+
+        trigger_error('Undefined property: ' . __CLASS__ . '::$' . $name, E_USER_WARNING);
+    }
+
     /**
      * Serialize script arguments (containing web elements and/or shadow roots)
      *

lib/WebDriver/Element.php

@@ -82,6 +82,16 @@ protected function obsoleteMethods()
         ];
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    protected function chainable()
+    {
+        return [
+            'shadow' => 'shadow',
+        ];
+    }
+
     /**
      * Constructor
      *

lib/WebDriver/Session.php

@@ -112,6 +112,21 @@ protected function obsoleteMethods()
         ];
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    protected function chainable()
+    {
+        return [
+            'actions'  => 'actions',
+            'alert'    => 'alert',
+            'execute'  => 'execute',
+            'frame'    => 'frame',
+            'timeouts' => 'timeouts',
+            'window'   => 'window',
+        ];
+    }
+
     /**
      * Constructor
      *
@@ -416,6 +431,19 @@ public function activeElement()
         return $this->makeElement($result['value']);
     }
 
+    /**
+     * actions method chaining, e.g.,
+     * - $session->actions()->method() - chaining
+     * - $session->actions->method() - chaining
+     *
+     * @return mixed
+     */
+    protected function actions()
+    {
+        return Actions::getInstance($this->url . '/actions');
+    }
+
+
     /**
      * touch method chaining, e.g.,
      * - $session->touch()->method()