library browserstack-screenshots-php

ksenzee/browserstack-screenshots-php

A PHP client for the Browserstack Screenshots API

Installation

1. Get Composer: Download the composer.phar executable or use the installer., _(*1)

   sh $ curl -sS https://getcomposer.org/installer | php, _(*2)

   If you already have Composer installed globally, skip this step., _(*3)

2. Create a composer.json file specifying BrowserstackScreenshots as a dependency. You can have Composer do this for you by using this command:, _(*4)

   ``` sh $ php composer.phar require ksenzee/browserstack-screenshots-php:*, <sub>(*5)</sub>

   
   Or, if you already have Composer installed:
   
   ``` sh
   $ composer require ksenzee/browserstack-screenshots-php:*
   

   Or if you'd rather, you can create your composer.json file by hand:, <sub>(*6)</sub>

   json { "require": { "ksenzee/browserstack-screenshots-php": "*" } }, <sub>(*7)</sub>

3. Use Composer to install BrowserstackScreenshots (and anything else you listed in your composer.json file):, <sub>(*8)</sub>

   ``` sh $ php composer.phar install, <sub>(*9)</sub>

   
   Or, if you have Composer installed globally:
   
   ``` sh
   $ composer install
   

Instantiating the client

``` php, <sub>(*10)</sub>

require_once 'vendor/autoload.php';, <sub>(*11)</sub>

$credentials = array( 'username' => 'janedoe', 'password' => 'abc123', ); $client = new \BrowserstackScreenshots\ScreenshotsClient($credentials);, <sub>(*12)</sub>

## Requesting a set of screenshots

``` php
// The JobConfig class is designed to help you generate JSON that meets the
// criteria at http://www.browserstack.com/screenshots/api#generate-screenshots.
$config = new \BrowserstackScreenshots\JobConfig();
$config->setUrl('http://www.google.com');
$config->setWaitTime(5);
$config->setQuality('original');
$config->addBrowser(array('os' => 'Windows', 'os_version' => '7', 'browser' => 'ie', 'browser_version' => '11.0'));
$config->addBrowser(array('os' => 'ios', 'os_version' => '6.0', 'device' => 'iPhone 4S (6.0)'));

// You can use it to generate the JSON to describe your job:
$json = $config->getJson();

// ... or you can skip the JobConfig class entirely and write your own JSON:
$json = '{"url":"https:\/\/www.google.com","wait_time":5,"quality":"original","browsers":[{"os":"Windows","os_version":"7","browser":"ie","browser_version":"11.0"},{"os":"ios","os_version":"6.0","device":"iPhone 4S (6.0)"}]}';

// Once you have valid JSON describing a URL and a set of browsers, use it to
// send a POST request to start a screenshot job:
print "Requesting screenshots:\n";
$request_info = $client->generateScreenshots($json);
$job_id = $request_info['job_id'];

Checking on job status

``` php // See whether the job is finished: $finished = $client->jobFinished($job_id);, <sub>(*13)</sub>

// Get more details on the job status (whether it's done, queued, or timed out): $job_status = $client->getStatus($job_id);, <sub>(*14)</sub>

// Or just retrieve all available information about your job: $job_info = $client->getJobInfo($job_id);, <sub>(*15)</sub>

```, <sub>(*16)</sub>