Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LukeTowers/oc-snappypdf-plugin
SnappyPDF integration for OctoberCMS
https://github.com/LukeTowers/oc-snappypdf-plugin
barryvdh laravel octobercms pdf plugin wkhtmltopdf
Last synced: 3 months ago
JSON representation
SnappyPDF integration for OctoberCMS
- Host: GitHub
- URL: https://github.com/LukeTowers/oc-snappypdf-plugin
- Owner: LukeTowers
- License: mit
- Created: 2017-04-17T17:57:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-06-21T14:56:22.000Z (over 2 years ago)
- Last Synced: 2024-05-02T03:00:30.999Z (6 months ago)
- Topics: barryvdh, laravel, octobercms, pdf, plugin, wkhtmltopdf
- Language: PHP
- Size: 25.4 KB
- Stars: 11
- Watchers: 2
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-wintercms - LukeTowers.SnappyPDF - Integrates SnappyPDF PDF generation into Winter CMS. (Uncategorized / Uncategorized)
README
# About
October-fied wrapper around the [wkhtmltopdf and wkhtmltoimage](https://wkhtmltopdf.org/) conversion libraries provided through the [barryvdh/laravel-snappy](https://github.com/barryvdh/laravel-snappy) package.
# Installation
To install from the [Marketplace](https://octobercms.com/plugin/luketowers-snappypdf), click on the "Add to Project" button and then select the project you wish to add it to before updating the project to pull in the plugin.
To install from the backend, go to **Settings -> Updates & Plugins -> Install Plugins** and then search for `LukeTowers.SnappyPDF`.
To install from [the repository](https://github.com/luketowers/oc-snappypdf-plugin), clone it into **plugins/luketowers/snappypdf** and then run `composer update` from your project root in order to pull in the dependencies.
To install it with Composer, run `composer require luketowers/oc-snappypdf-plugin` from your project root.
> **NOTE:** On some Linux systems you may need to install the following dependencies (generally when the process fails with "The exit status code 127 says something went wrong"). Pulled from https://github.com/barryvdh/laravel-snappy/issues/68.
```bash
sudo apt-get install -y \
libxrender1 \
libfontconfig1 \
libx11-dev \
libjpeg62 \
libxtst6
```
If you get "The exit status code 1 says something went wrong" you may need to install the following dependencies. Pulled from https://github.com/wkhtmltopdf/wkhtmltopdf/issues/3001#issuecomment-309673453
```bash
sudo apt-get install -y \
libssl1.0-dev
```
> **NOTE:** You might not be able to install `libssl1.0-dev` in Homestead, make sure you run `sudo apt-get update` first.
# Configuration
The main configuration values that you may wish to change would be the paths to the executable binaries for `wkhtmltopdf` and `wkhtmltoimage`. These binaries are pulled into **plugins/luketowers/snappypdf/vendor/bin** by default (when installing from the marketplace) and the default configuration reflects this. Also supported by default is installing by cloning the [repository](https://github.com/luketowers/oc-snappypdf-plugin) and loading the dependencies with `composer update` (where the binaries will be located in your project's **vendor/bin**).
If you need to change the path used to locate those binaries, then you have a few options. If you are already using [`.env` files for environment level configuration](http://octobercms.com/docs/setup/configuration#environment-config-extended) then you can simply add `SNAPPY_PDF_BINARY` and `SNAPPY_IMAGE_BINARY` with their respective paths to your `.env` file and call it a day.
If you are not using `.env` files, or you need to change a configuration value other than the binary paths; then you can override this plugin's configuration and change the necessary values by copying **config/config.php** from the plugin into your project's **config/luketowers/snappypdf/config.php** file [(as specified in the OctoberCMS docs)](http://octobercms.com/docs/plugin/settings#file-configuration).
# Usage
When using this plugin, it is highly recommended that you [add a dependency on it](http://octobercms.com/docs/plugin/registration#dependency-definitions) to the plugin you are using it from.
In order to use the libraries provided by this plugin (`SnappyPDF` and `SnappyImage`), simply import them with `use` statements at the top of your PHP files.
### Stream PDF to browser
The example below will render a record from a controller and stream it to the browser for downloading or viewing.
```php
$example,
]);
// Render as a PDF
$pdf = SnappyPDF::loadHTML($renderedHtml)
->setOption('margin-top', 0)
->setOption('margin-bottom', 0)
->setOption('margin-left', 0)
->setOption('margin-right', 0)
->setPaper('letter')
->output();
return Response::make($pdf, 200, [
'Content-Type' => 'application/pdf',
'Content-Disposition' => "filename={$example->name}.pdf",
]);
}
}
```
### Return a PDF to the AJAX framework for downloading
```
$example,
]);
// Render as a PDF
$pdf = SnappyPDF::loadHTML($renderedHtml)->output();
return Response::make($pdf, 200, [
'Content-Type' => 'application/pdf',
'Content-Transfer-Encoding' => 'binary',
'Content-Disposition' => "attachment; filename=\"{$example->name}.pdf\"",
]);
}
}
```
More information on utilizing the libraries is available at the [barryvdh/laravel-snappy repository](https://github.com/barryvdh/laravel-snappy#usage) and the [wkhtmltopdf manual](http://wkhtmltopdf.org/usage/wkhtmltopdf.txt).