lsolesen/edbbrugs-php-sdk

PHP-SDK 用于与 EDB-BRUGS 平台集成,该平台是丹麦免费学校用于管理学生的平台。

0.5.3 2021-10-08 10:27 UTC

This package is auto-updated.

Last update: 2024-09-08 17:05:09 UTC


README

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Total Downloads License

PHP 7 SDK 用于与 De frie skolers EDB-BRUGS 通信。

要求

  • 访问 EDB-BRUGS 程序。
  • “Webtilmeldinger” 许可证(联系 EDB-BRUGS 支持)
  • EDB-BRUGS 使用新的“stamdata”系统

入门

该服务通过 SOAP 与 EDB-BRUGS 通信。您只能创建新的注册信息,必须手动操作并使用 EDB-BRUGS Windows 程序将其放入正确的课程。

要获取对服务的访问权限,您需要联系 EDB-BRUGS 支持。您需要以下信息

  • SOAP 服务的 WSDL(将 ?wsdl 添加到从 EDB-BRUGS 收到的 WSDL 终端)
  • 用户名
  • 密码
  • 学校代码

安装

Composer

如果您使用 Composer 管理项目的依赖项,只需将 lsolesen/edbbrugs-php-sdk 作为依赖项添加到项目的 composer.json 文件中。以下是一个仅定义对 EDBBrugs-PHP-SDK 依赖项的最小 composer.json 文件示例

{
    "require": {
        "lsolesen/edbbrugs-php-sdk": "0.2.*"
    }
}

运行 composer install 后,您可以使用 vendor/autoload.php 中的 Composer 自动加载器。

用法

<?php
use EDBBrugs\Client;
use EDBBrugs\Credentials;
use EDBBrugs\RegistrationRepository;

$soap = new \SoapClient('https://www.webtilmeldinger.dk/TilmeldingsFormularV2Ws/Service.asmx?wsdl', array('trace' => 1));
$credentials = new Credentials($username, $password, $school_code);
$client = new Client($credentials, $soap);
$registration_repository = new RegistrationRepository($client);

// Add registrations.
$registrations = array(
    array(
        'Kartotek' => 'XX', // required - provided by the user of EDB-Brugs
        'Kursus' => 'Vinterkursus 18/19', // required - name of the course
        // The following is available for Elev, Mor, Far, Voksen
        'Elev.Fornavn' => 'Svend Aage',
        'Elev.Efternavn' => 'Thomsen',
        'Elev.Adresse' => 'Ørnebjergvej 28',
        'Elev.Lokalby' => 'Grejs',
        'Elev.Postnr' => '7100',
        'Elev.Bynavn' => 'Vejle',
        'Elev.CprNr' => '010119421942',
        'Elev.Fastnet' => '75820811',
        'Elev.FastnetBeskyttet' => 0, // 0 = No, 1 = Yes
        'Elev.Mobil' => '75820811',
        'Elev.MobilBeskyttet' => 0, // 0 = No, 1 = Yes
        'Elev.Email' => 'kontor@vih.dk',
        'Elev.Land' => 'Danmark',
        'Elev.Notat' => 'Svend Aage Thomsen er skolens grundlægger',
        'Elev.Linje' => 'Fodbold', // optional and specific for a student
        // You can add Far, Mor, Voksen - but only one of each
        'Voksen.Fornavn' => 'Svend Aage',
        'Voksen.Efternavn' => 'Thomsen',
        'Voksen.Adresse' => 'Ørnebjergvej 28',
        'Voksen.Lokalby' => 'Grejs',
        'Voksen.Postnr' => '7100',
        'Voksen.Bynavn' => 'Vejle',
        'Voksen.Fastnet' => '75820811',
        'Voksen.FastnetBeskyttet' => 0, // 0 = No, 1 = Yes
        'Voksen.Mobil' => '75820811',
        'Voksen.MobilBeskyttet' => 0, // 0 = No, 1 = Yes
        'Voksen.Email' => 'kontor@vih.dk',
        'Voksen.Land' => 'Danmark',
    )
);

$registration_repository->addRegistrations($registrations);

// Get new registrations.
$registration_repository->getNewRegistrations();

// Get handled registrations.
$registration_repository->getHandledRegistrations();
?>

如果您需要将某些内容放入自定义字段,您必须这样做

// Add registrations.
$registrations = array(
    array(
        'Kartotek' => 'XX', // required - provided by the user of EDB-Brugs
        'EgneFelter.EgetFelt30' => '[Forening450l]12.12.2018 Web Ja'
    )
);

测试

您可以在命令行上运行以下命令来测试方法

php vendor/bin/phpunit --exclude-group=IntegrationTest tests

如果您想测试集成,请根据 ´phpunit.dist.xml´ 创建一个基于 ´phpunit.xml´ 的文件,并包含访问服务所需的信息。

php vendor/bin/phpunit tests

在测试过程中,您需要手动使用 Windows EDB-BRUGS 程序删除网络注册。 没有使用 SOAP 服务删除的方法