dbp / relay-verity-connector-verapdf-bundle
A template bundle for the Relay API gateway
Installs: 860
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 1
Type:symfony-bundle
pkg:composer/dbp/relay-verity-connector-verapdf-bundle
Requires
- php: >=8.2
- ext-json: *
- dbp/relay-core-bundle: ^0.1.181
- dbp/relay-verity-bundle: ^0.1.2
- symfony/config: ^6.4
- symfony/dependency-injection: ^6.4
- symfony/framework-bundle: ^6.4
- symfony/http-kernel: ^6.4
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.50
- phpstan/phpstan: ^1.10.59
- phpstan/phpstan-phpunit: ^1.3.16
- phpstan/phpstan-symfony: ^1.3.7
- phpunit/phpunit: ^11.0
- symfony/browser-kit: ^6.4
- symfony/http-client: ^6.4
- symfony/monolog-bundle: ^3.10
- symfony/phpunit-bridge: ^7.0.4
- symfony/runtime: ^6.4
README
The Verity Connector VeraPDF bundle provides an API for interacting with VeraPDF wich is a PDF validating service.
Bundle installation
You can install the bundle directly from packagist.org.
composer require dbp/relay-verity-connector-verapdf-bundle
Integration into the Relay API Server
- Add the bundle to your
config/bundles.phpin front ofDbpRelayCoreBundle:
... Dbp\Relay\VerityConnectorVerapdfBundle\DbpRelayVerityConnectorVerapdfBundle::class => ['all' => true], Dbp\Relay\CoreBundle\DbpRelayCoreBundle::class => ['all' => true], ];
If you were using the DBP API Server Template as template for your Symfony application, then this should have already been generated for you.
- Run
composer installto clear caches
Configuration
The bundle has a url configuration value that you can specify in your app, either by hard-coding it,
or by referencing an environment variable.
There is also a maxsize configuration value, specifying the maximum size of a document sent to the VeraPDF backend.
For this create config/packages/dbp_relay_verity-connector-verapdf.yaml in the app with the following
content:
dbp_relay_verity_connector_verapdf: url: '%env(VERA_PDF_URI)%' maxsize: 33554432
If you were using the DBP API Server Template as template for your Symfony application, then the configuration file should have already been generated for you.
For more info on bundle configuration see https://symfony.com/doc/current/bundles/configuration.html.
Development & Testing
- Install dependencies:
composer install - Run tests:
composer test - Run linters:
composer run lint - Run cs-fixer:
composer run cs-fix
Bundle dependencies
Don't forget you need to pull down your dependencies in your main application if you are installing packages in a bundle.
# updates and installs dependencies of dbp/relay-verity-connector-verapdf-bundle
composer update dbp/relay-verity-connector-verapdf-bundle