Silverstripe Screenshot Module

Simple SDK with helpers to screenshot websites and save or download to PDF or JPEG via printscreenapi.com

There's a free plan which is perfect for small projects and allows for 100 fresh screenshots per month with unlimited access to cached images and PDFs.

• Get an API key
• Documentation

Requirements

• SilverStripe Framework 4.0+

Installation

Via composer

• Run composer require beetpix/silverstripe-screenshot
• Run /dev/build in your browser

Manually

• Download and extract files into printscreenapi/ in your project's root folder
• Run /dev/build in your browser

Configure API key

Add your API key via YAML or environment file:

YAML

Beetpix\PrintScreen
  api_key: YOUR_API_KEY_HERE

Environment (.env)

PRINTSCREENAPI_KEY="YOUR_API_KEY_HERE"

Example usage

Get image screenshot URL:

$url = \Beetpix\PrintScreen::inst()
    ->fullPage()
    ->getImage('https://www.example.com');

Download as PDF:

\Beetpix\PrintScreen::inst()
    ->downloadPDF('https://www.example.com');

Additional options, flush cache and read raw result:

$inst = \Beetpix\PrintScreen::inst()
    ->device('phone-landscape')
    ->click('.btn-accept-cookies')
    ->fullPage()
    ->flush();

// Get URL
$url = $inst->getImage('https://www.example.com');

// Download image
$inst->downloadImage('https://www.example.com');

// Read raw result
print_r($inst->getResult());

Available methods

For detailed explanation about each parameter, please check out the the documentation at:
https://printscreenapi.com/api/

Note

Since the API call may take a few extra seconds to complete depending on the parameters you set (eg. delay or fullPage) it is recommended that you make calls via AJAX if adding screenshot functionality that requires user interaction via web browser to prevent timeouts.

License

• BSD 2