This module provides a SilverStripe-centric wrapper for Snappy and wkhtml.
- Wkhtml binary either wkhtmltopdf or wkhtmltoimage
$ composer require "heyday/silverstripe-wkhtml"
Four things are required to generate a pdf or an image:
Knp\Snappy\GeneratorInterfaceThe wrapper for wkhtmltopdf or wkhtmltoimageHeyday\SilverStripe\WkHtml\Input\InputInterfaceto provide the htmlHeyday\SilverStripe\WkHtml\Output\OutputInterfaceoutput the pdf or image in different waysHeyday\SilverStripe\WkHtml\Generatorto glue everything together
- Request (generates content from a request)
- TextString (content is specified by a string)
- Template (generates content from a SilverStripe template)
- Url (generates content from a GET request to a Url)
- Viewer (generates content from an SSViewer instance)
- Browser (outputs to the browser)
- File (outputs to a file)
- RandomFile (outputs to a random filename)
- TextString (outputs to a string)
- Image
SilverStripe\Core\Injector\Injector:
# Create PDF generator as an injector service
# This allows you to specify the binary path once and have it set up
# automatically by getting the service from the injector.
Knp\Snappy\Pdf:
constructor:
- '/bin/wkhtmltopdf' # Path to your WKTHMLTOPDF binary. Use '`SOME_ENV_VAR`' to define the binary path in .envuse Heyday\SilverStripe\WkHtml;
use SilverStripe\Core\Injector\Injector;
$generator = WkHtml\Generator::create(
// Use Injector->get(Pdf::class) if you don't need to modify options
// Use Injector->create() to create a transient service for modifications (e.g. setOption)
// Using Injector->get() and making changes will cause changes to be made for all uses of get(Pdf::class) for the entire request
Injector::inst()->create(\Knp\Snappy\Pdf::class),
WkHtml\Input\Url::create('/'),
WkHtml\Output\Browser::create('test.pdf', 'application/pdf')
);
return $generator->process();\Heyday\SilverStripe\WkHtml\Input\Request::create(
// Controller::curr()->getRequest() is also an option
Injector::inst()->get(\SilverStripe\Control\HTTPRequest::class)
);\Heyday\SilverStripe\WkHtml\Input\Request::create(
Injector::inst()->get(\SilverStripe\Control\HTTPRequest::class),
new Session([
'arg' => 'value',
])
);$html = <<<HTML
<h1>Title</h1>
HTML;
\Heyday\SilverStripe\WkHtml\Input\TextString::create($html);\Heyday\SilverStripe\WkHtml\Input\Template::create('MyTemplate');
\Heyday\SilverStripe\WkHtml\Input\Template::create(
'MyTemplate',
[
'Var' => 'Hello',
]
);
\Heyday\SilverStripe\WkHtml\Input\Template::create(
'MyTemplate',
ArrayData::create([
'Var' => 'Hello',
])
);
\Heyday\SilverStripe\WkHtml\Input\Template::create(
'$Var World',
ArrayData::create([
'Var' => 'Hello',
]),
true
);\Heyday\SilverStripe\WkHtml\Input\Viewer::create(
SSViewer::create([
'Template',
]),
ArrayData::create([
'Var' => 'Hello',
])
);\Heyday\SilverStripe\WkHtml\Input\Url::create('/');
\Heyday\SilverStripe\WkHtml\Input\Url::create('http://google.co.nz/');\Heyday\SilverStripe\WkHtml\Output\Browser::create('test.pdf', 'application/pdf'); // Force download
\Heyday\SilverStripe\WkHtml\Output\Browser::create('test.pdf', 'application/pdf', true); // Embeds\Heyday\SilverStripe\WkHtml\Output\File::create(BASE_PATH . '/test.pdf');
\Heyday\SilverStripe\WkHtml\Output\File::create(BASE_PATH . '/test.pdf', true); // Overwrite\Heyday\SilverStripe\WkHtml\Output\RandomFile::create(BASE_PATH);\Heyday\SilverStripe\WkHtml\Output\TextString::create();$ composer install
$ phpunitThis project is licensed under an MIT license