digital-blueprint / relay-base-organization-connector-campusonline-bundle

DbpRelayBaseOrganizationConnectorCampusonlineBundle

GitLab

Integration into the Relay API Server

• Add the bundle package as a dependency:

composer require dbp/relay-base-organization-connector-campusonline-bundle

• Add the bundle to your config/bundles.php:

...
Dbp\Relay\BasePersonBundle\DbpRelayBaseOrganizationBundle::class => ['all' => true],
Dbp\Relay\BasePersonBundle\DbpRelayBaseOrganizationConnectorCampusonlineBundle::class => ['all' => true],
...

• Run composer install to clear caches

Configuration

The bundle has some configuration values 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_base_organization_connector_ldap.yaml in the app with the following content:

dbp_relay_base_organization_connector_campusonline:
  campus_online:
    api_token: '%env(CAMPUS_ONLINE_API_TOKEN)%'
    api_url: '%env(CAMPUS_ONLINE_API_URL)%'
    org_root_id: '%env(ORGANIZATION_ROOT_ID)%'

For more info on bundle configuration see https://symfony.com/doc/current/bundles/configuration.html

Events

OrganizationPostEvent

This event allows you to add additional attributes ("local data") to the \Dbp\Relay\BaseOrganizationBundle\Entity\Organization base-entity that you want to be included in responses to Organization entity requests. Event subscribers receive a \Dbp\Relay\RelayBaseOrganizationConnectorCampusonlineBundle\Event\OrganizationPostEvent instance containing the Organization base-entity and the organization data provided by Campusonline.

For example, create an event subscriber src/EventSubscriber/OrganizationEventSubscriber.php:

<?php
namespace App\EventSubscriber;

use Dbp\Relay\BaseOrganizationConnectorCampusonlineBundle\Event\OrganizationPostEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

class OrganizationEventSubscriber implements EventSubscriberInterface
{
    public static function getSubscribedEvents(): array
    {
        return [
            OrganizationPostEvent::NAME => 'onPost',
    ];
    }

    public function onPost(OrganizationPostEvent $event)
    {
        $organization = $event->getOrganization();
        $organizationData = $event->getOrganizationUnitData();
        $organization->trySetLocalDataValue('code', $organizationData->getCode());
    }
}

And add it to your src/Resources/config/services.yaml:

App\EventSubscriber\OrganizationEventSubscriber:
  autowire: true
  autoconfigure: true

relay-base-organization-connector-campusonline-bundle's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• fix(deps): update all non-major dependencies (patch) (dbp/relay-core-bundle, psr/log)
• chore(deps): lock file maintenance

Detected dependencies

composer

composer.json

• php >=8.1
• api-platform/core ^2.7.11 || ^3.2
• dbp/campusonline-api ^0.3.13
• dbp/relay-base-organization-bundle ^0.2.11
• dbp/relay-core-bundle ^0.1.153
• symfony/framework-bundle ^5.4 || ^6.4
• symfony/config ^5.4 || ^6.4
• symfony/event-dispatcher ^5.4 || ^6.4
• symfony/dependency-injection ^5.4 || ^6.4
• symfony/event-dispatcher-contracts ^2.5 || ^3.4
• symfony/http-foundation ^5.4 || ^6.4
• symfony/http-kernel ^5.4 || ^6.4
• psr/log ^1.1.4 || ^2.0.0 || ^3.0.0
• friendsofphp/php-cs-fixer ^3.50
• phpstan/phpstan ^1.10.59
• phpstan/phpstan-phpunit ^1.3.16
• phpunit/phpunit ^9.6.17
• symfony/browser-kit ^5.4 || ^6.4
• symfony/http-client ^5.4 || ^6.4
• symfony/monolog-bundle ^3.10
• symfony/phpunit-bridge ^7.0
• vimeo/psalm ^5.22.2

github-actions

.github/workflows/test.yml

• shivammathur/setup-php v2
• actions/checkout v4
• actions/cache v4
• shivammathur/setup-php v2
• actions/checkout v4
• actions/cache v4

---

• Check this box to trigger a request for Renovate to run again on this repository