Download the PHP package dbp/relay-verity-bundle without Composer

On this page you can find all versions of the php package dbp/relay-verity-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of dbp/relay-verity-bundle

Informations about the package relay-verity-bundle

DbpRelayVeritasBundle

GitHub | Packagist

The verity bundle provides an API for interacting with objects to validate (e.g. a PDF to validate against PDF/A-1b).

Bundle installation

You can install the bundle directly from packagist.org.

Integration into the Relay API Server

If you were using the DBP API Server Template as template for your Symfony application, then this should have already been generated for you.

Configuration

For this create config/packages/dbp_relay_verity.yaml in the app with the following content:

There are two sections in this bundle configuration:

  1. backends for the configuration of backend services
  2. profiles for the checks available via the API

In this example, a backend with the name pdfa is implemented by the PHP class PDFAValidationAPI. There is also a profile defines with the name archive. A profile performs all checks and stores the results (the validity and also errors) in a variable named like the check, here pdfa and pdfa_b2. Each check has the name of its backend to use and a flavour to set the type of check to perform. The results of all checks are then evaluated by the rule of the profile. The syntax of the rule is almost PHP syntax, but before any function is available, they must be registered first!

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

Bundle dependencies

Don't forget you need to pull down your dependencies in your main application if you are installing packages in a bundle.

Scripts

Error codes

/verity/reports

POST

relay:errorId Status code Description
'verity:create-report-missing-profile' 400 Unknown profile "$profileName"!
'verity:create-report-missing-file' 400 No file with parameter key "file" was received!
'verity:create-report-file-hash-mismatch' 400 Parameter file hash mismatch.
'verity:create-report-file-size-zero' 400 Parameter file size is 0 (zero).
'verity:create-report-file-content-empty' 400 File content is empty.
'verity:create-report-file-size-mismatch' 400 Parameter file size mismatch.
'verity:create-report-backend-exception' 400 $profileName throws an exception

/verity/reports/{identifier}

GET

relay:errorId Status code Description relay:errorDetails Example
verity:report-not-found 404 Submission was not found.

Roles

This bundle needs the role ROLE_SCOPE_VALIDATION assigned to the user to get permissions to fetch data. To create a new submission entry the Symfony role ROLE_SCOPE_VALIDATION-POST is required.

Events

To extend the behavior of the bundle the following event is registered:

VerityRequestEvent

This event allows you to send a request for validation internally. See tests/EventSubscriberTest.php as an example.

VerityEvent

This event allows you to get notifications for (all) verity reports.

An event subscriber receives a Dbp\Relay\VerityBundle\Event\VerityEvent instance:

All versions of relay-verity-bundle with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
ext-curl Version *
ext-fileinfo Version *
ext-json Version *
api-platform/core Version ^3.4 || ^4.1
dbp/relay-core-bundle Version ^0.1.210
psr/log Version ^2.0 || ^3.0
symfony/config Version ^6.4
symfony/dependency-injection Version ^6.4
symfony/event-dispatcher Version ^6.4
symfony/event-dispatcher-contracts Version ^2.5 || ^3.5
symfony/expression-language Version ^6.4
symfony/framework-bundle Version ^6.4
symfony/http-client Version ^6.4
symfony/http-client-contracts Version ^2.5 || ^3.5
symfony/http-foundation Version ^6.4
symfony/http-kernel Version ^6.4
symfony/serializer Version ^6.4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package dbp/relay-verity-bundle contains the following files

Loading the files please wait ....