README

GitHub

此Symfony包可以用作创建DBP Relay项目新包的模板。

当将此包包含到您的API服务器中时，它将获得以下功能

自定义 ./bin/console 命令
一个示例实体
为此实体实现了各种HTTP方法

TL;DR

使用此模板包的最快方法是输入所需的名称到一个命令，并生成一个带有正确命名的可使用包。

有关更多信息，请参阅生成DBP Symfony包。

将包作为模板使用

复制存储库内容
调整composer.json中的包名，在这个例子中，我们假设您将包命名为dbp/relay-your-bundle
发明一个新的PHP命名空间并在所有PHP文件中调整它
将src/DbpRelaySublibraryConnectorCampusonlineBundle和DependencyInjection/DbpRelaySublibraryConnectorCampusonlineExtension重命名为与新的项目名称匹配

集成到API服务器中

将包推送到git服务器，在这个例子中，我们将使用git@gitlab.tugraz.at:dbp/relay/dbp-relay-your-bundle.git
将存储库添加到您的composer.json（一旦您将包发布到Packagist，您可以再次删除该块）

    "repositories": [
        {
            "type": "vcs",
            "url": "git@gitlab.tugraz.at:dbp/relay/dbp-relay-your-bundle.git"
        }
    ],

将包包作为依赖项添加

composer require dbp/relay-your-bundle=dev-main

将包添加到您的config/bundles.php

...
Dbp\Relay\YourBundle\DbpRelayYourBundle::class => ['all' => true],
DBP\API\CoreBundle\DbpCoreBundle::class => ['all' => true],
];

运行composer install以清除缓存

配置

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

为此，在应用程序中创建config/packages/dbp_relay_sublibrary_connector_campusonline.yaml，其内容如下

dbp_relay_sublibrary_connector_campusonline:
  example_config: 42
  # example_config: '%env(EXAMPLE_CONFIG)%'

该值在DbpRelaySublibraryConnectorCampusonlineExtension（您的扩展将具有不同的名称）中读取，并在创建MyCustomService服务时传递。

有关包配置的更多信息，请参阅Symfony包配置。

开发与测试

安装依赖项：composer install
运行测试：composer test
运行linters：composer run lint
运行cs-fixer：composer run cs-fix

包依赖项

不要忘记，如果您在包中安装包，您需要在主应用程序中拉取依赖项。

# updates and installs dependencies from dbp/relay-your-bundle
composer update dbp/relay-your-bundle

dbp / relay-sublibrary-connector-campusonline-bundle

维护者

详细信息