php-webdriver – Selenium WebDriver PHP 绑定技术文档

1. 安装指南

使用 Composer 安装

php-webdriver 库可以通过 Composer 进行安装。如果你还没有使用过 Composer，可以通过以下命令下载 composer.phar 二进制文件：

curl -sS https://getcomposer.org/installer | php

然后安装 php-webdriver 库：

php composer.phar require php-webdriver/webdriver

从版本 <1.8.0 升级

从版本 1.8.0 开始，项目名称从 facebook/php-webdriver 更改为 php-webdriver/webdriver。为了接收新版本和未来的更新，你需要在 composer.json 中更改包名并运行 composer update：

"require": {
-    "facebook/webdriver": "(version you use)",
+    "php-webdriver/webdriver": "(version you use)",
}

2. 项目使用说明

启动服务器（远程端）

要控制浏览器，你需要启动一个远程端（服务器），该服务器将监听从 php-webdriver 库发送的命令，并在相应的浏览器中执行这些命令。

a) Chromedriver

1. 安装最新版本的 Chrome 和 Chromedriver。
2. 确保 Chromedriver 和 Chrome 版本兼容。
3. 运行 chromedriver 二进制文件，并指定端口 4444：

chromedriver --port=4444

b) Geckodriver

1. 安装最新版本的 Firefox 和 Geckodriver。
2. 确保 Geckodriver 和 Firefox 版本兼容。
3. 运行 geckodriver 二进制文件（默认监听端口 4444）：

geckodriver

c) Selenium 独立服务器

Selenium 服务器可以在需要执行多个测试、在不同浏览器中运行测试或在网格模式下分发测试时使用。

1. 下载最新版本的 Selenium 服务器。
2. 运行 Selenium 服务器：

java -jar selenium-server-standalone-#.jar

创建浏览器会话

在创建浏览器会话时，确保传递正在运行的服务器的 URL。例如：

// Chromedriver (如果使用 --port=4444 启动)
$serverUrl = 'http://localhost:4444';
// Geckodriver
$serverUrl = 'http://localhost:4444';
// selenium-server-standalone-#.jar (版本 2.x 或 3.x)
$serverUrl = 'http://localhost:4444/wd/hub';
// selenium-server-standalone-#.jar (版本 4.x)
$serverUrl = 'http://localhost:4444';

然后你可以启动你选择的浏览器：

use Facebook\WebDriver\Remote\RemoteWebDriver;

// Chrome
$driver = RemoteWebDriver::create($serverUrl, DesiredCapabilities::chrome());
// Firefox
$driver = RemoteWebDriver::create($serverUrl, DesiredCapabilities::firefox());
// Microsoft Edge
$driver = RemoteWebDriver::create($serverUrl, DesiredCapabilities::microsoftEdge());

自定义期望能力

期望能力定义了你即将启动的浏览器的属性。可以通过以下方式进行自定义：

use Facebook\WebDriver\Firefox\FirefoxOptions;
use Facebook\WebDriver\Remote\DesiredCapabilities;

$desiredCapabilities = DesiredCapabilities::firefox();

// 禁用接受 SSL 证书
$desiredCapabilities->setCapability('acceptSslCerts', false);

// 通过 FirefoxOptions 添加参数以启动无头 Firefox
$firefoxOptions = new FirefoxOptions();
$firefoxOptions->addArguments(['-headless']);
$desiredCapabilities->setCapability(FirefoxOptions::CAPABILITY, $firefoxOptions);

$driver = RemoteWebDriver::create($serverUrl, $desiredCapabilities);

控制浏览器

// 访问 URL
$driver->get('https://en.wikipedia.org/wiki/Selenium_(software)');

// 通过 ID 查找搜索元素，输入 'PHP' 并提交
$driver->findElement(WebDriverBy::id('searchInput')) // 查找搜索输入元素
    ->sendKeys('PHP') // 填写搜索框
    ->submit(); // 提交整个表单

// 通过 CSS 选择器查找菜单中的 'History' 元素
$historyButton = $driver->findElement(
    WebDriverBy::cssSelector('#ca-history a')
);
// 读取元素的文本并输出
echo 'About to click to a button with text: ' . $historyButton->getText();

// 点击元素以导航到修订历史页面
$historyButton->click();

// 确保在最后调用 quit() 以终止浏览器会话
$driver->quit();

3. 项目 API 使用文档

常用 API

• RemoteWebDriver::create($serverUrl, $desiredCapabilities)：创建浏览器会话。
• $driver->get($url)：访问指定的 URL。
• $driver->findElement(WebDriverBy::id($id))：通过 ID 查找元素。
• $element->sendKeys($text)：向元素输入文本。
• $element->submit()：提交表单。
• $element->click()：点击元素。
• $driver->quit()：终止浏览器会话。

期望能力

• DesiredCapabilities::chrome()：创建 Chrome 浏览器的期望能力。
• DesiredCapabilities::firefox()：创建 Firefox 浏览器的期望能力。
• DesiredCapabilities::microsoftEdge()：创建 Microsoft Edge 浏览器的期望能力。

浏览器选项

• ChromeOptions：用于配置 Chrome 浏览器的选项。
• FirefoxOptions：用于配置 Firefox 浏览器的选项。

4. 项目安装方式

通过 Composer 安装

php composer.phar require php-webdriver/webdriver

从版本 <1.8.0 升级

"require": {
-    "facebook/webdriver": "(version you use)",
+    "php-webdriver/webdriver": "(version you use)",
}

运行 composer update 以更新包。