stechstudio / snapthis
PHP SDK for SnapThis screenshot service
Installs: 2 590
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 4
Forks: 0
Open Issues: 0
Requires
- php: ^7.2|^8.0
- stechstudio/laravel-record: ^1.5
Requires (Dev)
- orchestra/testbench: ^6.0
- phpunit/phpunit: ^9.3
README
SnapThis is a screenshot service that will convert an URL or HTML payload into a PNG image or PDF file.
Installation
You can install the package via composer:
composer require stechstudio/snapthis
Store your API key in the .env file:
SNAPTHIS_API_KEY=[your api key]
Quickstart
Take a snapshot by using the snapshot
or pdf
methods. Return this result from a controller method to redirect to the snapshot:
use SnapThis; // Will take a PNG image snapshot and redirect the user: return SnapThis::snapshot('https://laravel.com');
Or add the download
method to force the snapshot to download for your user.
return SnapThis::pdf('https://laravel.com')->download();
To get the raw binary contents use the contents
method:
$contents = SnapThis::pdf('https://laravel.com')->contents();
You can pass in an HTML string instead of a URL:
SnapThis::pdf("<strong>Hello there</strong>");
You can also pass in a blade view, then simply chain the snapshot
or pdf
methods.
$users = User::all(); return SnapThis::view('reports.users', ['users' => $users])->pdf();
Options
There are quite a few options for customizing the snapshot. Documentation coming!
License
The MIT License (MIT). Please see License File for more information.