Merge pull request php-webdriver#82 from DavertMik/master

Keyboard

Author: whhone

lib/WebDriverKeyboard.php

@@ -0,0 +1,38 @@
+<?php
+// Copyright 2004-present Facebook. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+interface WebDriverKeyboard {
+
+  public function sendKeys($keys);
+
+  /**
+   * Press a modifier key
+   *
+   * @see WebDriverKeys
+   * @param $key
+   * @return $this
+   */
+  public function pressKey($key);
+
+  /**
+   * Release a modifier key
+   *
+   * @see WebDriverKeys
+   * @param $key
+   * @return $this
+   */
+  public function releaseKey($key);
+
+}

lib/WebDriverKeys.php

@@ -83,4 +83,16 @@ class WebDriverKeys {
   const META            = "\xEE\x80\xBD";
   const COMMAND         = "\xEE\x80\xBD"; // ALIAS
   const ZENKAKU_HANKAKU = "\xEE\x80\xC0";
+
+  static function encode(array $keys)
+  {
+    $encoded = array();
+    foreach ($keys as $key)
+    {
+      if (is_array($key)) $key = implode('',$key).self::NULL;
+      $encoded[] = (string)$key;
+    }
+    return $encoded;
+  }
+
 }

lib/__init__.php

@@ -30,6 +30,7 @@
 require_once('WebDriverKeys.php');
 require_once('WebDriverNavigation.php');
 require_once('WebDriverMouse.php');
+require_once('WebDriverKeyboard.php');
 require_once('WebDriverOptions.php');
 require_once('WebDriverPoint.php');
 require_once('WebDriverSelect.php');
@@ -50,6 +51,7 @@
 require_once('interactions/internal/WebDriverMoveToOffsetAction.php');
 require_once('internal/WebDriverLocatable.php');
 require_once('remote/RemoteMouse.php');
+require_once('remote/RemoteKeyboard.php');
 require_once('remote/RemoteWebDriver.php');
 require_once('remote/RemoteWebElement.php');
 require_once('remote/WebDriverBrowserType.php');

lib/remote/RemoteKeyboard.php

@@ -0,0 +1,73 @@
+<?php
+// Copyright 2004-present Facebook. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * Execute keyboard commands for RemoteWebDriver.
+ */
+class RemoteKeyboard implements WebDriverKeyboard {
+
+  private $executor;
+
+
+  public function __construct($executor) {
+    $this->executor = $executor;
+  }
+
+  /**
+   * Send keys to active element
+   *
+   * @param $keys
+   * @return $this
+   */
+  public function sendKeys($keys) {
+    $this->sendKeysToActiveElement(WebDriverKeys::encode(func_get_args()));
+    return $this;
+  }
+
+  /**
+   * Press a modifier key
+   *
+   * @see WebDriverKeys
+   * @param $key
+   * @return $this
+   */
+  public function pressKey($key)
+  {
+    $this->sendKeysToActiveElement(array($key));
+    return $this;
+  }
+
+  /**
+   * Release a modifier key
+   *
+   * @see WebDriverKeys
+   * @param $key
+   * @return $this
+   */
+  public function releaseKey($key)
+  {
+    $this->sendKeysToActiveElement(array($key));
+    return $this;
+  }
+
+  private function sendKeysToActiveElement($value)
+  {
+    $params = array(
+      'value' => $value
+    );
+    $this->executor->execute('sendKeys', $params);
+  }    
+
+}

lib/remote/RemoteWebDriver.php

@@ -265,11 +265,12 @@ public function getMouse() {
     return $this->mouse;
   }
 
-  /**
-   * @return WebDriverKeyboard
-   */
-  public function getKeyboard() {
-    throw new UnsupportedOperationException('not yet implemented');
+  public function getKeyboard()
+  {
+    if (!$this->keyboard) {
+      $this->keyboard = new RemoteKeyboard($this->executor);
+    }
+    return $this->keyboard;
   }
 
   /**

lib/remote/RemoteWebElement.php

@@ -247,12 +247,19 @@ public function isSelected() {
   /**
    * Simulate typing into an element, which may set its value.
    *
+   * ``` php
+   * $element->sendKeys('foo'); // => 'foo'
+   * $element->sendKeys('test', WebDriverKeys::ARROW_LEFT, 's' ); // => 'test'
+   * $element->sendKeys(array(WebDriverKeys::CONTROL, 'a'), WebDriverKeys::SPACE); // => ' '
+   * ```
+   *
    * @param mixed $value The data to be typed.
    * @return WebDriverElement The current instance.
    */
   public function sendKeys($value) {
+    $value = WebDriverKeys::encode(func_get_args());
     $params = array(
-      'value' => array((string)$value),
+      'value' => $value,
       ':id'   => $this->id,
     );
     $this->executor->execute('sendKeysToElement', $params);