https://github.com/pontedilana/php-weasyprint
PHP library allowing PDF generation or snapshot from an URL or an HTML page. Wrapper for Kozea/WeasyPrint
https://github.com/pontedilana/php-weasyprint
pdf php weasyprint
Last synced: about 1 year ago
JSON representation
PHP library allowing PDF generation or snapshot from an URL or an HTML page. Wrapper for Kozea/WeasyPrint
- Host: GitHub
- URL: https://github.com/pontedilana/php-weasyprint
- Owner: pontedilana
- License: mit
- Created: 2021-07-15T07:20:19.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-31T16:16:17.000Z (about 1 year ago)
- Last Synced: 2025-04-04T01:15:51.217Z (about 1 year ago)
- Topics: pdf, php, weasyprint
- Language: PHP
- Homepage:
- Size: 137 KB
- Stars: 58
- Watchers: 6
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# PhpWeasyPrint
PhpWeasyPrint is a PHP library allowing PDF generation from a URL or an HTML page.
It's a wrapper for [WeasyPrint](https://weasyprint.org/), a smart solution helping web developers to create PDF documents, available everywhere Python runs.
You will have to download and install WeasyPrint to use PhpWeasyPrint (version 56 or greater is recommended).
This library is massively inspired by [KnpLabs/snappy](https://github.com/KnpLabs/snappy), of which it aims to be a one-to-one substitute (`GeneratorInterface` is the same).
See "[Differences with Snappy](#differences-with-snappy)" section to see how the two differs
## Installation using [Composer](https://getcomposer.org/)
```bash
$ composer require pontedilana/php-weasyprint
```
## Usage
### Initialization
```php
setBinary('/usr/local/bin/weasyprint');
```
### Display the pdf in the browser
```php
$pdf = new Pdf('/usr/local/bin/weasyprint');
header('Content-Type: application/pdf');
echo $pdf->getOutput('https://www.github.com');
```
### Download the pdf from the browser
```php
$pdf = new Pdf('/usr/local/bin/weasyprint');
header('Content-Type: application/pdf');
header('Content-Disposition: attachment; filename="file.pdf"');
echo $pdf->getOutput('https://www.github.com');
```
### Generate local pdf file
```php
$pdf = new Pdf('/usr/local/bin/weasyprint');
$pdf->generateFromHtml('
Bill
You owe me money, dude.
', '/tmp/bill-123.pdf');
```
### Pass options to PhpWeasyPrint
```php
// Type weasyprint -h to see the list of options
$pdf = new Pdf('/usr/local/bin/weasyprint');
$pdf->setOption('encoding', 'utf8');
$pdf->setOption('media-type', 'screen');
$pdf->setOption('presentational-hints', true);
$pdf->setOption('optimize-images', true);
$pdf->setOption('stylesheet', ['/path/to/first-style.css', '/path/to/second-style.css']);
$pdf->setOption('attachment', ['/path/to/image.png', '/path/to/logo.jpg']);
```
### Reset options
Options can be reset to their initial values with `resetOptions()` method.
```php
$pdf = new Pdf('/usr/local/bin/weasyprint');
// Set some options
$pdf->setOption('media-type', 'screen');
// ..
// Reset options
$pdf->resetOptions();
```
### Timeouts
A default timeout of 10 seconds is set for the WeasyPrint process to prevent orphaned or hanging processes.
This is a defensive measure that applies in most cases and helps ensure system stability.
You can change the timeout with the `setTimeout()` method:
```php
$pdf = new Pdf('/usr/local/bin/weasyprint');
$pdf->setTimeout(30); // 30 seconds
```
The timeout can be disabled entirely using either of the following:
```php
$pdf->setTimeout(null);
// or
$pdf->disableTimeout();
```
This is especially useful if you're running inside a *queue worker*, *job runner*, or other environments that already handle timeouts (e.g. Symfony Messenger, Laravel Queue, Supervisor).
Disabling the internal timeout in those cases avoids conflicts with higher-level timeout strategies.
> **Note:**
> The `setTimeout()` method affects **both**:
> - how long the process is allowed to run before being forcibly stopped, and
> - the `--timeout` option passed to the WeasyPrint command-line tool.
>
> If you only want to disable WeasyPrint's own timeout (while keeping the execution time limit), use:
>
> ```php
> $pdf->setOption('timeout', null);
> ```
## Differences with Snappy
Although PhpWeasyPrint and Snappy are interchangeable, there are a couple of differences between the two, due to WeasyPrint CLI API:
* WeasyPrint doesn't support multiple sources to be merged in one single output pdf, so only one input source (string or URL) is accepted in PhpWeasyPrint;
* WeasyPrint version >= 53 doesn't generate images, so image generation from HTML string or URL is possible only with WeasyPrint lower versions and an unsupported PhpWeasyPrint version (`Pontedilana\PhpWeasyPrint\Image` has been successfully tested with Weasyprint 52.5 on PhpWeasyPrint 0.13.0).
## Bugs & Support
If you found a bug please fill a [detailed issue](https://github.com/pontedilana/php-weasyprint/issues) with all the following points.
If you need some help, please at least provide a complete reproducer, so we could help you based on facts rather than assumptions.
* OS and its version
* WeasyPrint, its version and how you installed it
* A complete reproducer with relevant PHP and html/css/js code
If your reproducer is big, please try to shrink it. It will help everyone to narrow the bug.
## Credits
PhpWeasyPrint has been originally developed by the [Pontedilana](https://www.pontedilana.it) dev team.
Snappy has been originally developed by the [KnpLabs](https://knplabs.com) team.