README

ScoutNet Webservice

此Typo3插件用于ScoutNet.de JSON RPC Api。

您需要在ScoutNet.de注册账户并申请您的网站API密钥。请发送电子邮件至 scoutnetconnect@scoutnet.de

安装

要安装，您可以使用来自TER的版本，或者将此git仓库安装到

/typo3conf/ext/sh_scoutnet_webservice

或者，您可以使用composer

composer require scoutnet/sh-scoutnet-webservice

设置

您需要激活此插件并设置AES密钥/IV和正确的提供者名称。您可以在组权限配置中找到这些信息。

https://www.scoutnet.de/community/rechte/rechte-verwalten.html

开发

如果您想贡献力量，请随时这样做。仓库位于这里

https://github.com/scoutnet/plugins.typo3.sh_scoutnet_webservice

只需运行 make init

测试

所需：GnuMake、PHP、Docker和docker-compose

初始化

make init

要运行所有测试，请调用

make test

您可以使用 -phpx 后缀来指定您要检查的PHP版本，例如 make test-php81

对于仅测试特定功能或PHP版本，有不同的后缀。例如

make lintTest-php81
make unitTest-php83
make unitTest 将使用php 8.1至php 8.3调用单元测试

对于仅运行特定测试，请使用

TEST_FILE=$(pwd)/Tests/Functional/Plugins/WebringPluginTest.php EXTRA_TEST_OPTIONS='--filter testRedirect' make functionalTest-php83

使用PhpStorm测试：设置新的远程PHP解释器。Docker-Compose

compose文件： Tests/Build/docker-compose.yml
服务： functional_mariadb

设置新的测试框架

phpunit的路径： bin/phpunit
默认配置： vendor/typo3/testing-framework/Resources/Core/Build/UnitTests.xml
添加路径映射： <绝对路径到该目录> -> <绝对路径到该目录>（所有路径映射与主机相同）

为 单元测试 设置新的运行配置

测试范围： <绝对路径到该目录>/Tests/Unit
自定义工作目录： <绝对路径到该目录>/.Build/
测试运行器选项： --coverage-filter <绝对路径到该目录>/Classes

为 功能测试 设置新的运行配置

测试范围： <绝对路径到该目录>/Tests/Functional
自定义工作目录： <绝对路径到该目录>/.Build/
使用替代配置文件： <aps. Path to this dir>/.Build/vendor/typo3/testing-framework/Resources/Core/Build/FunctionalTests.xml
测试运行器选项： --coverage-filter <绝对路径到该目录>/Classes
环境变量： typo3DatabaseUsername=root;typo3DatabasePassword=funcp;typo3DatabaseHost=mariadb10;typo3DatabaseName=func_test

祝您测试愉快

不使用docker

CGL测试： .Build/bin/php-cs-fixer fix -v --dry-run --diff --config=.Build/vendor/typo3/coding-standards/templates/extension _php-cs-fixer.dist.php --using-cache=no Classes/ Resources/ Tests/

单元测试： .Build/bin/phpunit -c .Build/vendor/typo3/testing-framework/Resources/Core/Build/UnitTests.xml Tests/Unit

更新

1.x->3.0

如果您从版本 < 2.0 更新，请注意该插件已完全重写。它现在基于Extbase。因此，API已完全更改。使用Extbase，您可以通过依赖注入包含webservice。一些API也发生了更改。

3.x->4.0

更新后，有很多破坏性更改。结构被重命名为使用英文命名，并且使用了正确的书写。

详细信息

Categorie -> Category
Stufe -> Section

因此，仓库也发生了变化。现在章节知道关于类别对象，而不仅仅是存储类别ID。

UserRepository->findByUid已被重命名为findByUsername（因为这就是它所做的工作）

4.x->5.0

待定

5.x->6.0

待定

作者

如果您对此软件有任何问题，您可以给我发电子邮件到 muetze@scoutnet.de

待办事项

许可证

本脚本分发旨在使其有用，但没有任何保证；甚至没有关于其适销性或适用于特定用途的暗示保证。有关更多信息，请参阅GNU通用公共许可证。

scoutnet / sh-scoutnet-webservice

维护者