diff --git a/README.md b/README.md index 786c7e9..ed9b528 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,78 @@ This pdfreactor recipe for [ddev](https://ddev.readthedocs.io) installs a [`.dde * The PDFreactor instance will listen on TCP port 9423 (the PDFreactor default). * Configure your application to access PDFreactor on the host:port `pdfreactor:9423`. +## Example to use this PDFreactor service with the official PDFreactor Web Service PHP client + +```php + 'http://www.pdfreactor.com/product/samples/textbook/textbook.html', +]; + +// Render document and save result to $result +$result = null; +try { + $result = $pdfReactor->convertAsBinary($config); + header('Content-Type: application/pdf'); + echo $result; +} catch (PDFreactorWebserviceException $e) { + echo '

An Error Has Occurred

'; + echo '

' . $e->getMessage() . '

'; +} +``` + +More infos: [https://www.pdfreactor.com/php/](https://www.pdfreactor.com/php/) + +## Example to use this PDFreactor service with Pimcore + +1. Install Pimcore demo +``` +mkdir -p pimcore-demo +cd pimcore-demo +ddev config --project-type=php --docroot=public --webserver-type=apache-fpm --create-docroot --php-version=8.0 --database=mariadb:10.5 +ddev composer create -y -n pimcore/demo +ddev exec php vendor/pimcore/pimcore/bin/pimcore-install --admin-username admin --admin-password demo --mysql-host-socket db --mysql-username db --mysql-password db --mysql-database db --no-interaction +``` +2. Install ddev-pdfreactor Addon +``` +ddev get blankse/ddev-pdfreactor +ddev restart +``` +3. Config + 1. When you have a PDFreactor license key you can add this to `.ddev/pdfreactor/licensekey.txt` + 2. Login to the admin interface https://pimcore-demo.ddev.site/admin (Username: admin, Password: demo) + 3. Go to the Web2Print settings + + ![Web-to-print settings menu](images/web-to-print-settings-menu.jpg) + + 4. Set the config and click the save button + + | Setting | Value | + |----------|-------------------------------| + | Tool | PDFreactor | + | Protocol | http | + | Server | pdfreactor | + | Port | 9423 | + | BaseURL | http://pimcore-demo.ddev.site | + +4. Test a Print document + 1. Execute Maintenance Worker: + + `ddev php bin/console messenger:consume pimcore_core pimcore_maintenance` + + 3. Go to the demo Print catalog (/print/Demo-Catalog) + 4. Click to "Generate PDF" button + ## License ddev-pdfreactor is distributed under the [Apache 2.0 license](LICENSE). diff --git a/images/web-to-print-settings-menu.jpg b/images/web-to-print-settings-menu.jpg new file mode 100644 index 0000000..aff2c61 Binary files /dev/null and b/images/web-to-print-settings-menu.jpg differ