Browsershot wrapper for Laravel 5
This package takes advantage of Google Chrome's Headless mode to take screenshots and generate PDFs from websites, views and raw html
Requirements
- Node 7.6.0 or higher
- Google Chrome
- Puppeteer Node library.
You can install Puppeteer in your project via NPM:
npm install puppeteer
Or you could opt to just install it globally
npm install puppeteer --global
On a Forge provisioned Ubuntu 16.04 server you can install the latest stable version of Chrome like this:
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs gconf-service libasound2 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0 libgtk-3-0 libnspr4 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 ca-certificates fonts-liberation libappindicator1 libnss3 lsb-release xdg-utils wget
sudo npm install --global --unsafe-perm puppeteer
sudo chmod -R o+rx /usr/lib/node_modules/puppeteer/.local-chromium
Installation
Install the package through composer
composer require verumconsilium/laravel-browsershot
After the package is installed the service provider will be automatically discovered and two new Facades PDF and Screenshot will be available
Usage
The recommended way to use this package is through its Facades
Generating a PDF from a view and returning it inline
use VerumConsilium\Browsershot\Facades\PDF;
...
return PDF::loadView('view.name', $data)
->inline();
You can chain all the methods available in the browsershot master library
Returning the PDF as a download
use VerumConsilium\Browsershot\Facades\PDF;
...
return PDF::loadView('view.name', $data)
->margins(20, 0, 0, 20)
->download();
You can pass the custom file name and additional headers the response will have to the inline and download methods like
PDF::loadHtml('Awesome PDF
')
->download('myawesomepdf.pdf', [
'Authorization' => 'token'
]);
Persisting PDF to disk
If you would like to save the generated pdf file to your storage disk you can call the store or storeAs method
$pdfStoredPath = PDF::loadUrl('https://google.com')
->store('pdfs/')
This will use the default storage driver to store the pdf in the pdfs/ folder giving it a unique name. If you would like to specify the name you can call de storeAs method
$pdfStoredPath = PDF::loadUrl('https://google.com')
->storeAs('pdfs/', 'google.pdf')
Screenshots
Screenshots are created the same way as PDFs just change the facade to Screenshot
Generating screenshots as JPG/JPEG
By default screenshots will be taken as PNG format if you would like to use JPG instead call the useJPG() method
use VerumConsilium\Browsershot\Facades\Screenshot;
Screenshot::loadView('view.name', $data)
->useJPG()
->margins(20, 0, 0, 20)
->download();
7 Dec 30, 2022
4.1k Dec 30, 2022
23 Oct 28, 2022
1.5k Dec 25, 2022
2 Jan 23, 2022
0 Feb 5, 2022
2.3k Jan 2, 2023
21 Dec 11, 2022
264 Jan 4, 2023
67 Dec 28, 2022
88 Jul 25, 2022
399 Jan 2, 2023
513 Dec 31, 2022
11 Feb 15, 2022
228 May 3, 2022
2 Sep 20, 2022
4 Dec 25, 2021
105 Dec 18, 2022
121 Dec 21, 2022
289 Nov 24, 2022