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

Relay API网关的模板包

v0.1.20 2024-04-11 15:00 UTC

README

GitLab

集成到Relay API服务器

  • 将包作为依赖项添加
composer require dbp/relay-base-organization-connector-campusonline-bundle
  • 将包添加到 config/bundles.php
...
Dbp\Relay\BasePersonBundle\DbpRelayBaseOrganizationBundle::class => ['all' => true],
Dbp\Relay\BasePersonBundle\DbpRelayBaseOrganizationConnectorCampusonlineBundle::class => ['all' => true],
...
  • 运行 composer install 清除缓存

配置

该包有一些配置值,您可以在您的应用程序中指定,无论是通过硬编码还是通过引用环境变量。

为此,在应用程序中创建 config/packages/dbp_relay_base_organization_connector_ldap.yaml,内容如下

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)%'

有关包配置的更多信息,请参阅 https://symfony.com.cn/doc/current/bundles/configuration.html

事件

OrganizationPostEvent

此事件允许您向您想要包含在对\Dbp\Relay\BaseOrganizationBundle\Entity\Organization基础实体的响应中的Organization实体添加额外的属性("本地数据")。事件订阅者接收一个包含Organization基础实体和由Campusonline提供的组织数据的\Dbp\Relay\RelayBaseOrganizationConnectorCampusonlineBundle\Event\OrganizationPostEvent实例。

例如,创建一个事件订阅者 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());
    }
}

并将其添加到 src/Resources/config/services.yaml

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