Download the PHP package dbp/relay-blob-connector-campusonline-dms-bundle without Composer
On this page you can find all versions of the php package dbp/relay-blob-connector-campusonline-dms-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dbp/relay-blob-connector-campusonline-dms-bundle
More information about dbp/relay-blob-connector-campusonline-dms-bundle
Files in dbp/relay-blob-connector-campusonline-dms-bundle
Package relay-blob-connector-campusonline-dms-bundle
Short Description A template bundle for the Relay API gateway
License AGPL-3.0-or-later
Informations about the package relay-blob-connector-campusonline-dms-bundle
Relay-API Bundle README Template
DbpRelay{{Name}}Bundle
GitHub | Packagist | Frontend Application | {{Name}} Website
The {{name}} bundle provides an API for interacting with ...
There is a corresponding frontend application that uses this API at {{Name}} Frontend Application.
Bundle installation
You can install the bundle directly from packagist.org.
Integration into the Relay API Server
- Add the bundle to your
config/bundles.php
in front ofDbpRelayCoreBundle
:
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 install
to clear caches
Configuration
The bundle has a database_url
configuration value that you can specify in your
app, either by hard-coding it, or by referencing an environment variable.
For this create config/packages/dbp_relay_{{name}}.yaml
in the app with the following
content:
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.
Scripts
Database migration
Run this script to migrate the database. Run this script after installation of the bundle and after every update to adapt the database to the new source code.
Error codes
/{{name}}/submissions
POST
relay:errorId | Status code | Description | relay:errorDetails | Example |
---|---|---|---|---|
{{name}}:submission-not-created |
500 | The submission could not be created. | message |
['message' => 'Error message'] |
{{name}}:submission-invalid-json |
422 | The dataFeedElement doesn't contain valid json. | message |
/{{name}}/submissions/{identifier}
GET
relay:errorId | Status code | Description | relay:errorDetails | Example |
---|---|---|---|---|
{{name}}:submission-not-found |
404 | Submission was not found. |
Roles
This bundle needs the role ROLE_SCOPE_{{NAME}}
assigned to the user to get permissions to fetch data.
To create a new submission entry the Symfony role ROLE_SCOPE_{{NAME}}-POST
is required.
Events
To extend the behavior of the bundle the following event is registered:
CreateSubmissionPostEvent
This event allows you to react on submission creations. You can use this for example to email the submitter of the submission.
An event subscriber receives a Dbp\Relay\{{Name}}Bundle\Event\CreateSubmissionPostEvent
instance
in a service for example in src/EventSubscriber/CreateSubmissionSubscriber.php
:
All versions of relay-blob-connector-campusonline-dms-bundle with dependencies
ext-json Version *
api-platform/core Version ^3.2
dbp/relay-blob-bundle Version ^0.1.54
dbp/relay-core-bundle Version ^0.1.182
doctrine/doctrine-migrations-bundle Version ^3.3
symfony/config Version ^6.4
symfony/dependency-injection Version ^6.4
symfony/framework-bundle Version ^6.4
symfony/http-kernel Version ^6.4
symfony/uid Version ^6.4