konsulting / assert-pdfs
Simple PHP(Unit) Package to help with making assertions on PDFs
Requires
- ext-imagick: *
Requires (Dev)
- phpunit/phpunit: ^7.5
This package is auto-updated.
Last update: 2024-10-16 23:31:55 UTC
README
A simple assertion package to work with PDFs and PHPUnit.
Please ensure that you have Imagick install/available and it has permission to write to PDF (see this post on stack overflow). You may need to run something like:
sudo sed -i -e 's/rights="none" pattern="PDF"/rights="read|write" pattern="PDF"/' /etc/ImageMagick-6/policy.xml
This is effectively a package up of this starting point from Gordon Lesti.
Installation
composer require --dev konsulting/assert-pdfs
Usage
Use the Konsulting\Testing\AssertPdfs
trait on your test class. Available methods:
assertPdfSame($assertedPdf, $testPdf, $saveDiffToFile = null)
- You can optionally save the diff of the pdf on
failure to a file by providing a path to save to.
Hopefully we can add some more methods when we need them (or you do).
Contribution
Please feel free to contribute.