php-webdriver – Selenium WebDriver bindings for PHP

Description

Php-webdriver library is PHP language binding for Selenium WebDriver, which allows you to control web browsers from PHP.

This library is compatible with Selenium server version 2.x and 3.x. It implements the JsonWireProtocol, which is currently supported by the Selenium server and will also implement the W3C WebDriver specification in the future.

The concepts of this library are very similar to the "official" Java, .NET, Python and Ruby bindings from the Selenium project.

This is new version of PHP client, rewritten from scratch starting 2013. Using the old version? Check out Adam Goucher's fork of it.

Looking for API documentation of php-webdriver? See https://facebook.github.io/php-webdriver/

Any complaint, question, idea? You can post it on the user group https://www.facebook.com/groups/phpwebdriver/.

Installation

Installation is possible using Composer.

If you don't already use Composer, you can download the composer.phar binary:

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

Then install the library:

php composer.phar require facebook/webdriver

Getting started

All you need as the server for this client is the selenium-server-standalone-#.jar file provided here: http://selenium-release.storage.googleapis.com/index.html

Download and run that file, replacing # with the current server version. Keep in mind you must have Java 8+ installed to start this command.

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

When using Selenium server 3.5 and newer with some remote end clients (eg. Firefox with Geckodriver), you MUST disable so called "pass-through" mode, so that remote browser's protocol is translated to the protocol supported by php-webdriver (see issue #469):

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

Then when you create a session, be sure to pass the url to where your server is running.

// This would be the url of the host running the server-standalone.jar
$host = 'http://localhost:4444/wd/hub'; // this is the default

Launch Firefox

Make sure to have latest Firefox and Geckodriver installed.

$driver = RemoteWebDriver::create($host, DesiredCapabilities::firefox());

Launch Chrome

Make sure to have latest Chrome and Chromedriver installed.

$driver = RemoteWebDriver::create($host, DesiredCapabilities::chrome());

You can also customize the desired capabilities

$desired_capabilities = DesiredCapabilities::firefox();
$desired_capabilities->setCapability('acceptSslCerts', false);
$driver = RemoteWebDriver::create($host, $desired_capabilities);

See https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities for more details.
Above snippets are not intended to be a working example by simply copy pasting. See example.php for working example.

Changelog

For latest changes see CHANGELOG.md file.

More information

Some how-tos are provided right here in our GitHub wiki.

You may also want to check out the Selenium docs and wiki.

Testing framework integration

To take advantage of automatized testing you will most probably want to integrate php-webdriver to your testing framework. There are some project already providing this:

Steward integrates php-webdriver directly to PHPUnit, also providers parallelization.
Codeception testing framework provides BDD-layer on top of php-webdriver in its WebDriver module.
You can also check out this blogpost + demo project, describing simple PHPUnit integration.

Support

We have a great community willing to try and help you!

Via our Facebook Group - If you have questions or are an active contributor consider joining our facebook group and contributing to the communal discussion and support.
Via StackOverflow - You can also ask a question or find many already answered question on StackOverflow.
Via GitHub - Another option if you have a question (or bug report) is to submit it here as an new issue.

Contributing

We love to have your help to make php-webdriver better. See CONTRIBUTING.md for more information about contributing and developing php-webdriver.