openeuropa/oe_corporate_countries

OpenEuropa Drupal 模块模板。

2.0.1 2024-05-07 16:14 UTC

README

此模块提供了 EC 企业国家与 Drupal 的集成。

主要模块提供企业国家存储库服务,该服务返回企业国家数据。

目录

子模块

要求

此模块依赖于以下软件

  • PHP >=8.1
  • Virtuoso(或等效)三联店,其中包含 国家 出版局(OP)词汇的 RDF 表示

安装

此模块间接依赖于 drupal/sparql_entity_storage 模块,该模块需要更新版本的 easyrdf/easyrdf 包。
首先安装此包的正确版本

composer require "easyrdf/easyrdf 0.10.0-alpha.1 as 0.9.2"

然后安装此包及其依赖项

composer require openeuropa/oe_corporate_countries

强烈建议使用包含已安装的 OP 词汇表的 Virtuoso 提供的 Docker 映像。为此,将映像添加到您的 docker-compose.yml 文件中

  sparql:
    image: openeuropa/triple-store-dev
    environment:
    - SPARQL_UPDATE=true
    - DBA_PASSWORD=dba
    ports:
      - "8890:8890"

否则,请确保您已启动三联店实例并已导入所需的词汇表。

接下来,如果您正在使用任务运行程序来设置您的站点,请添加连接到三联店的 runner.yml 配置。在 drupal 键下

  sparql:
    host: "sparql"
    port: "8890"

runner.yml 中,添加创建连接到三联店的 Drupal 设置的指令。在 drupal.settings.databases 键下

  sparql_default:
    default:
      prefix: ""
      host: ${drupal.sparql.host}
      port: ${drupal.sparql.port}
      namespace: 'Drupal\Driver\Database\sparql'
      driver: 'sparql'

然后您可以继续使用常规任务运行程序命令来设置站点。

否则,确保在您的站点的 setting.php 文件中您有连接到您自己的三联店实例的信息

$databases["sparql_default"] = array(
  'default' => array(
    'prefix' => '',
    'host' => 'your-triple-store-host',
    'port' => '8890',
    'namespace' => 'Drupal\\Driver\\Database\\sparql',
    'driver' => 'sparql'
  )
);

开发环境搭建

您可以使用 Docker 和 Docker Compose 以及提供的配置来构建开发站点。

Docker 提供了必要的服务和工具,如 Web 服务器和数据库服务器,以便在本地主机配置的情况下运行网站

要求

配置

默认情况下,Docker Compose 读取两个文件,一个是 docker-compose.yml,另一个是可选的 docker-compose.override.yml 文件。根据惯例,docker-compose.yml 包含您的基配置,并默认提供。如文件名所示,覆盖文件可以包含对现有服务或完全新服务的配置覆盖。如果服务在两个文件中都定义,Docker Compose 将合并配置。

有关 Docker Compose 扩展机制的更多信息,请参阅 官方 Docker Compose 文档

使用方法

要开始,请运行

docker-compose up

建议不要将 docker-compose 以守护进程形式运行,这样您可以在工作完成后快速关闭它(CTRL+C)。然而,如果您想以守护进程形式运行它,则需要添加标志 -d

docker-compose up -d

然后

docker-compose exec web composer install

请注意:测试站点内部通过使用 OpenEuropa Task Runner 的 Drupal 项目符号链接命令 来符号链接项目文件和目录。

如果您在项目的根目录中添加了新的文件或目录,您需要重新运行 drupal:site-setup,以确保它们被正确符号链接。

如果您不想重新运行完整的站点设置,您可以简单地运行

$ ./vendor/bin/run drupal:symlink-project
  • 通过运行以下命令安装测试站点
docker-compose exec web ./vendor/bin/run drupal:site-install

使用默认配置,开发站点的文件应位于 build 目录中,并且开发站点可在: http://127.0.0.1:8080/build 访问。

运行测试

要运行 grumphp 检查

docker-compose exec web ./vendor/bin/grumphp run

要运行 phpunit 测试

docker-compose exec web ./vendor/bin/phpunit

要运行 behat 测试

docker-compose exec web ./vendor/bin/behat

步骤调试

要启用命令行中的步骤调试,请将任何值传递给容器的 XDEBUG_SESSION 环境变量

docker-compose exec -e XDEBUG_SESSION=1 web <your command>

请注意,从 XDebug 3 开始,如果变量已设置但您的客户端未监听调试连接,将在控制台输出连接错误消息。错误消息将导致 PHPUnit 测试出现假阴性。

要从浏览器中启动步骤调试,请使用浏览器扩展或如 https://www.jetbrains.com/phpstorm/marklets/ 生成的一些书签工具设置正确的cookie。

贡献

请阅读 完整文档 了解我们的行为准则以及向我们提交拉取请求的流程。

版本控制

我们使用 SemVer 进行版本控制。有关可用版本,请参阅此存储库的 标签