Download the PHP package grasenhiller/silverstripe-wkhtmltox without Composer
On this page you can find all versions of the php package grasenhiller/silverstripe-wkhtmltox. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download grasenhiller/silverstripe-wkhtmltox
More information about grasenhiller/silverstripe-wkhtmltox
Files in grasenhiller/silverstripe-wkhtmltox
Package silverstripe-wkhtmltox
Short Description Create pdfs and images out of SilverStripe with WkHtmlToX
License BSD-3-Clause
Homepage https://github.com/grasenhiller/silverstripe-wkhtmltox
Informations about the package silverstripe-wkhtmltox
SilverStripe WkHtmlToX
Create pdfs and images out of SilverStripe with WkHtmlToX. Based on WkHtmlToPdf and mikehaertl's php wrapper.
Installation
SilverStripe Module
WkHtmlToX Binaries
WKHtmlToPdf must be installed on your server to use this module. If it's not, you can try to use the provided binaries (v. 0.12.5). To do so, at first login via SSH and go into your home directory.
After this, if you're typing ./wkhtmltox/wkhtmltopdf -V
you should see the version number. Now it should work ;)
At last you need to provide the correct path to the binaries. Inside your .env
file, define these environment variables
To get the absolute path, go into our wkhtmltox directory and type pwd
;
Behind a proxy?
You could define global proxy settings inside your .env
file
or without the need for authentication
Change binary paths
You can define a different binary path for wkhtmltopdf and wkhtmtltoimage inside your .env
file
BasicAuth protected environment?
If you're working on a protected environment (dev?) and want to create pdfs or images from "locale" content, you need to define your BasicAuth credentials inside your .env
file
WkHtmlToX help/docs and examples?
Navigate to http://your-website.tld/gh-wkhtmltox/
Configuration (YML)
TBD
Methods for both, pdf and image creation
These methods work with new WkPdf()
and new WkImage()
Set folder where files should be saved
Generate html from SilverStripe templates
- $obj: The dataobject or page you want to render
- $variables: An array with extra data (optional)
- $template: The desired template (optional)
Replace relative image links
HTMLEditorFields normally don't store image links with absolute links. But WkHtmlToX needs absolute links to work. So just replace them with this method.
Get options the pdf or image will be created with
Get all options
Get a specific option
Set (new) or remove (existing) options
setOptions() setOption() removeOption() removeOptions()
Sry, no time to finish the readme until now ...
Overwrite global options
Simple Example
Header & footer
gh-wkhtmltox/header gh-wkhtmltox/footer $all_variables + variables from docs
Specific basic auth
Helpful
viewport-size zoom 1.045 window-status h1 { page-break-before: always; }
px & dpi
WkImage
add() construct
WkPdf
add() construct
WkImage + WkPdf
preview() download() save() getAsString()
WkController
- docs
- demo
- header + hook
- footer + hook
Config
- pdf global
- pdf "pages" predefined + custom
- image global + custom
- bypass_proxy_for_own_site
templates
html!
Todo
- Set Options setz mehrere optionen + set / get global options
- Statische Links ersetzen bei get_html (als Option)
- Stylesheets (user-style-sheet)
- Kommentare durchgehen
- README!
- IDE Annotation
Known Bugs
- Header / Footer can't be loaded