workdigital/casperjs-php-driver

An improved general purpose PHP driver for CasperJS

CasperJS PHP Driver

, _(*1)

Prerequisites

This driver will assume that the command casperjs is available in your $PATH. If not, you can install it with:, _(*2)

npm install -g casperjs

Installation

You can use this package in your project via composer. Add these lines to your composer.json:, _(*3)

"require": {
  "workdigital/casperjs-php-driver": "1.*"
},
…

Latest stable release is 1.0, _(*4)

Examples

Basic usage

$driver = new CasperJs\Driver();
$output = $driver->start('http://someurl.com')
                 ->run();

Setting request parameters and interacting with the page

The entire point of using a tool like Casper is to be able to properly interact with the DOM for both testing and scraping purposes. This driver tries to expose a friendly interface to do so where you can define both request params and DOM interaction before making the actual call., _(*5)

$driver = new CasperJs\Driver();
$driver->start('http://someurl.com')
       ->setUserAgent('AmericanPizzaiolo')
       ->setHeaders([
           'Accept-Language' => ['en-US'],
           'Some-Header' => 'Foo-bar',
       ])
       ->evaluate('make me a pizza')
       ->setViewPort(1024, 768)
       ->waitForSelector('.selector', 30000)
       ->wait(10000)
       ->click('.selector');

$output = $driver->run();

Using a proxy for your call

$driver = new CasperJs\Driver();
$driver->start('http://someurl.com')
       ->useProxy('1.1.1.1');

$output = $driver->run();

Getting the Casper Output

Whenever you execute Driver::run() the Driver will return an Output object that will encapsulate the Casper output. Output will expose the captured casper data or throw an exception in case the desired behaviour wasn't performed (i.e. if a css selector to be present in the page after timeout expired)., _(*6)

Extracting Data

$html = $output->getHtml();
$statusCode = $output->getStatusCode();
$currentUrl = $output->getCurrentUrl();

More examples

For more examples check out test/DriverTest.php, _(*7)

Credits

This driver is essentially an enhanced and improved version of the original alwex/php-casperjs., _(*8)