Download the PHP package sensiolabs/gotenberg-bundle without Composer
On this page you can find all versions of the php package sensiolabs/gotenberg-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sensiolabs/gotenberg-bundle
More information about sensiolabs/gotenberg-bundle
Files in sensiolabs/gotenberg-bundle
Package gotenberg-bundle
Short Description Gotenberg support for Symfony
License MIT
Informations about the package gotenberg-bundle
Gotenberg Bundle
[!WARNING]
This Bundle is experimental and subject to change in a future release.
What is it?
This bundle allows you to generate, stream and save PDF locally from URL, HTML, Markdown or any Office file. Different options are available depending on the source.
It also helps you to generate, stream and save images locally from URL, HTML and Markdown by taking a screenshot.
How to install
Install the bundle using composer:
[!NOTE] This bundle interacts with Gotenberg 8.x which is used under the hood.
With Symfony Flex
If you accept the Symfony Flex recipe during installation:
- The bundle will be automatically registered.
- A configuration skeleton file will be created.
- Docker Compose will be updated with a new gotenberg service.
- The
.env
file will be updated with aGOTENBERG_DSN
value pointing togotenberg:3000
. You can update this value if your Gotenberg instance is hosted elsewhere.
Without Symfony Flex
[!NOTE] You first need to install and configure Gotenberg 8.x by yourself.
Manually enable the bundle by adding it to the list of registered bundles in your config/bundles.php
file:
Basic Usage
You can generate a PDF locally from URL, HTML, Markdown or any Office files.
URL
After injecting GotenbergPdfInterface
you simply need to call the method url
,
which will return a UrlPdfBuilder
instance.
UrlPdfBuilder
lets you pass the URL of the page you want to convert into PDF
to the method url
.
[!TIP] For more information go to Gotenberg documentations.
Twig
[!WARNING]
Every Twig template you pass to Gotenberg must have the following structure.
Even Header or Footer parts.
If a template needs to link to a static asset (e.g. an image), this bundle
provides a {{ gotenberg_asset() }}
Twig function to generate the correct
path AND add it to the builder automatically.
This function work as asset() Twig function
and fetch your assets in the assets
folder of your application.
If your files are in another folder, you can override the default value of assets_directory
in your configuration file config/sensiolabs_gotenberg.yml
. The path provided
can be relative as well as absolute.
[!TIP] For more information go to Gotenberg documentations.
Screenshot
You can generate a screenshot locally from URL, HTML and Markdown.
URL
After injecting GotenbergScreenshotInterface
you simply need to call the
method url
, which will return a UrlScreenshotBuilder
instance.
UrlScreenshotBuilder
lets you pass the URL of the page you want to convert
into screenshot to the method url
.
Twig
After injecting GotenbergScreenshotInterface
you simply need to call the method
html
, which will return a HtmlScreenshotBuilder
instance.
HtmlScreenshotBuilder
lets you pass the content of the page you want to convert
into screenshot to the method content
.
[!TIP] For more information go to Gotenberg documentations.
Advanced Usage
- Configuration
- Processing (saving for example)
- Working with assets
- Builders API
- Async & Webhooks
- Working with fonts
- Add header / footer
- HTML Builder
- Markdown Builder
- Url Builder
- Office Builder (available extensions for conversion below)
123
,602
,abw
,bib
,bmp
,cdr
,cgm
,cmx
,csv
,cwk
,dbf
,dif
,doc
,docm
,docx
,dot
,dotm
,dotx
,dxf
,emf
,eps
,epub
,fodg
,fodp
,fods
,fodt
,fopd
,gif
,htm
,html
,hwp
,jpeg
,jpg
,key
,ltx
,lwp
,mcw
,met
,mml
,mw
,numbers
,odd
,odg
,odm
,odp
,ods
,odt
,otg
,oth
,otp
,ots
,ott
,pages
,pbm
,pcd
,pct
,pcx
,pdb
,pdf
,pgm
,png
,pot
,potm
,potx
,ppm
,pps
,ppt
,pptm
,pptx
,psd
,psw
,pub
,pwp
,pxl
,ras
,rtf
,sda
,sdc
,sdd
,sdp
,sdw
,sgl
,slk
,smf
,stc
,std
,sti
,stw
,svg
,svm
,swf
,sxc
,sxd
,sxg
,sxi
,sxm
,sxw
,tga
,tif
,tiff
,txt
,uof
,uop
,uos
,uot
,vdx
,vor
,vsd
,vsdm
,vsdx
,wb2
,wk1
,wks
,wmf
,wpd
,wpg
,wps
,xbm
,xhtml
,xls
,xlsb
,xlsm
,xlsx
,xlt
,xltm
,xltx
,xlw
,xml
,xpm
,zabw
- Merge Builder
- Convert Builder
- Split Builder
- PDF customization (available for every builder except LibreOffice, Merge and Split)
Screenshot
- HTML Builder
- Markdown Builder
- Url Builder
- Screenshot customization
Profiler
Comes with a built-in profiler panel to help you during your development.
Credits
This bundle was inspired by Gotenberg PHP.
- Steven RENAUX
- Adrien ROCHES
- Hubert LENOIR
- All Contributors
Licence
MIT License (MIT): see the License File for more details.
FAQ
My PDF / Screenshot is blank but I have no errors!
It may be because Gotenberg is trying to access an invalid URL (when using the `->url()` or `->route()` modes). For example if Gotenberg tries to access a page on `https://localhost:8001` but the SSL is a local provided one. Then Chromium won't be able to authorize access to the website. To fix this you can update your Gotenberg Docker service as followed: It can also be because from Gotenberg PoV the URL of your Symfony app is not reachable. Let's say you are using [symfony CLI](https://symfony.com/download) to run your project locally with Gotenberg running in Docker. You need to configure the `request_context` like so:All versions of gotenberg-bundle with dependencies
psr/container Version ^2.0
psr/log Version ^3.0
symfony/config Version ^6.4 || ^7.0
symfony/dependency-injection Version ^6.4 || ^7.0
symfony/filesystem Version ^6.4 || ^7.0
symfony/http-client-contracts Version ^3.5
symfony/http-foundation Version ^6.4 || ^7.0
symfony/http-kernel Version ^6.4 || ^7.0
symfony/mime Version ^6.4 || ^7.0