nucleos / dompdf-bundle
This bundle provides a wrapper for using dompdf inside symfony.
Fund package maintenance!
core23
Opencollective
Ko-Fi
Other
Installs: 370 438
Dependents: 3
Suggesters: 0
Security: 0
Stars: 41
Watchers: 3
Forks: 12
Open Issues: 6
Type:symfony-bundle
Requires
- php: ^8.1
- dompdf/dompdf: ^1.0.0 || ^2.0.0 || ^3.0.0
- symfony/config: ^6.4 || ^7.0
- symfony/dependency-injection: ^6.4 || ^7.0
- symfony/event-dispatcher-contracts: ^1.1 || ^2.0 || ^3.0
- symfony/expression-language: ^6.4 || ^7.0
- symfony/framework-bundle: ^6.4 || ^7.0
- symfony/http-foundation: ^6.4 || ^7.0
- symfony/http-kernel: ^6.4 || ^7.0
Requires (Dev)
- ergebnis/composer-normalize: ^2.0.1
- symfony/browser-kit: ^6.4 || ^7.0
Suggests
- symfony/event-dispatcher: If you need to modify the PDF rendering
- 4.4.x-dev
- 4.3.x-dev
- 4.3.0
- 4.2.x-dev
- 4.2.0
- 4.1.x-dev
- 4.1.0
- 4.0.x-dev
- 4.0.0
- 3.2.x-dev
- 3.2.0
- 3.1.x-dev
- 3.1.1
- 3.1.0
- 3.0.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.0.1
- 1.0.0
- dev-renovate/major-phpstan-packages
- dev-renovate/matthiasnoback-symfony-dependency-injection-test-6.x
- dev-renovate/phpunit-phpunit-11.x
- dev-readme-badge
- dev-shared-pipelines
This package is auto-updated.
Last update: 2024-12-05 07:35:53 UTC
README
This bundle provides a wrapper for using dompdf inside Symfony.
Installation
Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:
composer require nucleos/dompdf-bundle
Enable the Bundle
Then, enable the bundle by adding it to the list of registered bundles in config/bundles.php
file of your project:
// config/bundles.php return [ // ... Nucleos\DompdfBundle\NucleosDompdfBundle::class => ['all' => true], ];
Configure the Bundle
# config/packages/nucleos_dompdf.yaml nucleos_dompdf: defaults: defaultFont: 'helvetica' # See https://github.com/dompdf/dompdf/wiki/Usage#options for available options
Usage
Whenever you need to turn a html page into a PDF use dependency injection for your service:
use Nucleos\DompdfBundle\Factory\DompdfFactoryInterface; use Nucleos\DompdfBundle\Wrapper\DompdfWrapperInterface; final class MyService { public function __construct(DompdfFactoryInterface $factory) { $this->factory = $factory; } public function render() { // ... /** @var Dompdf\Dompdf $dompdf */ $dompdf = $this->factory->create(); // Or pass an array of options: $dompdf = $this->factory->create(['chroot' => '/home']); // ... } } final class MyOtherService { public function __construct(DompdfWrapperInterface $wrapper) { $this->wrapper = $wrapper; } public function stream() { // ... $html = '<h1>Sample Title</h1><p>Lorem Ipsum</p>'; /** @var Symfony\Component\HttpFoundation\StreamedResponse $response */ $response = $this->wrapper->getStreamResponse($html, "document.pdf"); $response->send(); // ... } public function binaryContent() { // ... return $this->wrapper->getPdf($html); // ... } }
Render pdf using Twig
If you use Twig to create the content, make sure to use renderView()
instead of render()
.
Otherwise you might get the following HTTP header printed inside your PDF:
HTTP/1.0 200 OK Cache-Control: no-cache
$html = $this->renderView('my_pdf.html.twig', array( // ... )); $this->wrapper->getStreamResponse($html, 'document.pdf');
Using asset() to link assets
First, make sure your chroot
is correctly set and isRemoteEnabled
is true.
# config/packages/nucleos_dompdf.yaml nucleos_dompdf: defaults: chroot: '%kernel.project_dir%/public/assets' isRemoteEnabled: true
Second, use {{ absolute_url( asset() ) }}
<img src={{ absolute_url( asset('assets/example.jpg') ) }}>
Events
The dompdf wrapper dispatches events to conveniently get the inner dompdf instance when creating the PDF.
dompdf.output
is dispatched ingetPdf()
dompdf.stream
is dispatched instreamHtml()
See Symfony Events and Event Listeners for more info.
License
This bundle is under the MIT license.