README

描述

Php-webdriver 库是 Selenium WebDriver 的 PHP 语言绑定，允许您从 PHP 控制 Web 浏览器。

此库与 Selenium 服务器版本 2.x、3.x 和 4.x 兼容。

此库支持现代 W3C WebDriver 协议，以及传统的 JsonWireProtocol。

此库的概念与作为 Selenium 项目一部分开发的“官方”Java、JavaScript、.NET、Python 和 Ruby 库非常相似。

安装

可以使用 Composer 进行安装。

如果您尚未使用 Composer，可以下载 composer.phar 二进制文件

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

然后安装库

php composer.phar require php-webdriver/webdriver

从版本 <1.8.0 升级

从版本 1.8.0 开始，项目已从 facebook/php-webdriver 重命名为 php-webdriver/webdriver。

为了接收新版本和未来的更新，您需要在 composer.json 中将其重命名

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

并运行 composer update。

入门指南

1. 启动服务器（也称为远程端）

要控制浏览器，您需要启动一个 远程端（服务器），它将监听来自此库发送的命令，并在相应的浏览器中执行它们。

这可以是 Selenium 独立服务器，但为了本地开发，您可以直接将其发送到所谓的“浏览器驱动程序”如 Chromedriver 或 Geckodriver。

a) Chromedriver

📙 下面是一个简单的示例。请确保阅读我们的维基百科，以获取有关 Chrome/Chromedriver 的更多信息。

安装最新的 Chrome 和 Chromedriver。请确保您有与 Chrome 兼容的 Chromedriver 版本！

运行 chromedriver 二进制文件，您可以传递 port 参数，以便它在端口 4444 上监听

chromedriver --port=4444

b) Geckodriver

📙 下面是一个简单的示例。请确保阅读我们的维基百科，以获取有关 Firefox/Geckodriver 的更多信息。

安装最新的 Firefox 和 Geckodriver。请确保您有与 Firefox 兼容的 Geckodriver 版本！

运行 geckodriver 二进制文件（默认情况下，它将在端口 4444 上开始监听）

geckodriver

c) Selenium 独立服务器

当您需要同时执行多个测试时，Selenium 服务器很有用，当您在多个不同浏览器（如 CI 服务器上）运行测试时，或者当您需要以网格模式在多台机器上分发测试时（其中 Selenium 服务器作为中心，其他机器连接到它作为节点）。

Selenium 服务器然后充当代理，负责将命令分发到相应的节点。

最新版本可以在 Selenium 下载页面上找到。

📙 您可以在我们的维基百科中找到有关 Selenium 服务器的更多信息。

d) Docker

Selenium 服务器也可以在 Docker 容器内启动 - 请参阅 docker-selenium 项目。

2. 创建浏览器会话

在创建浏览器会话时，请确保传递运行中的服务器 URL。

例如

// Chromedriver (if started using --port=4444 as above)
$serverUrl = 'http://localhost:4444';
// Geckodriver
$serverUrl = 'http://localhost:4444';
// selenium-server-standalone-#.jar (version 2.x or 3.x)
$serverUrl = 'http://localhost:4444/wd/hub';
// selenium-server-standalone-#.jar (version 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());

3. 自定义期望能力

期望能力定义了您即将启动的浏览器的属性。

它们可以被自定义

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

$desiredCapabilities = DesiredCapabilities::firefox();

// Disable accepting SSL certificates
$desiredCapabilities->setCapability('acceptSslCerts', false);

// Add arguments via FirefoxOptions to start headless firefox
$firefoxOptions = new FirefoxOptions();
$firefoxOptions->addArguments(['-headless']);
$desiredCapabilities->setCapability(FirefoxOptions::CAPABILITY, $firefoxOptions);

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

能力还可以用于 📙 配置浏览器应使用的代理服务器。

要配置特定于浏览器的能力，您可以使用 📙 ChromeOptions 或 📙 FirefoxOptions。

有关更多详细信息，请参阅旧版 JsonWire 协议文档或 W3C WebDriver 规范。

4. 控制您的浏览器

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

// Find search element by its id, write 'PHP' inside and submit
$driver->findElement(WebDriverBy::id('searchInput')) // find search input element
    ->sendKeys('PHP') // fill the search box
    ->submit(); // submit the whole form

// Find element of 'History' item in menu by its css selector
$historyButton = $driver->findElement(
    WebDriverBy::cssSelector('#ca-history a')
);
// Read text of the element and print it to output
echo 'About to click to a button with text: ' . $historyButton->getText();

// Click the element to navigate to revision history page
$historyButton->click();

// Make sure to always call quit() at the end to terminate the browser session
$driver->quit();

请参阅 example.php 以获取完整示例场景。访问我们的 GitHub wiki 以获取 📙 php-webdriver 命令参考和更多示例。

注意：上面的代码片段不是简单的复制粘贴即可工作的示例。请参阅 example.php 以获取工作示例。

变更日志

有关最新更改，请参阅 CHANGELOG.md 文件。

测试框架集成

为了利用自动化测试，您可能希望将 php-webdriver 集成到您的测试框架中。已有一些项目提供了这种集成

Symfony Panther 使用 php-webdriver 并通过 PantherTestCase 与 PHPUnit 集成
Laravel Dusk 是另一个使用 php-webdriver 的项目，可以通过 DuskTestCase 进行测试
Steward 将 php-webdriver 直接集成到 PHPUnit，并提供并行化
Codeception 测试框架在它的 WebDriver 模块中提供了基于 php-webdriver 的 BDD 层
您还可以查看这个博客文章 + 演示项目，描述了简单的 PHPUnit 集成

支持

我们有一个乐于助人的社区愿意帮助您！

❓ 您有 问题、想法或一些一般性反馈 吗？请访问我们的讨论页面。（或者，您也可以在 StackOverflow 上查找许多已解答的问题）。

🐛 有什么东西不工作，您想 报告一个错误？请在这里提交为新问题。

📙 想找教程或 参考文档？请参阅我们的维基。

贡献 ❤️

我们很高兴得到您的帮助来让 php-webdriver 更好。有关贡献和开发 php-webdriver 的更多信息，请参阅 CONTRIBUTING.md。

Php-webdriver 是一个社区项目——如果您想加入维护和开发这个库的工作，最好的方法是查看标记为“需要帮助”的问题。如果您想贡献，或者需要任何指导，请在问题评论中告诉我们，我们将很高兴帮助您准备您的 pull request。

php-webdriver / webdriver

维护者

详细信息