README

OpenEuropa 的 Webtools 集成。Webtools 是可以集成到网站中的交互式服务。

目录

• 安装
• 开发设置
• 贡献
• 版本控制

安装

推荐安装 OpenEuropa Webtools 模块的方式是通过 Composer。

composer require openeuropa/oe_webtools

启用模块

为了在项目中启用模块，请运行

./vendor/bin/drush en oe_webtools

OpenEuropa Webtools 分析

Webtools 模块包含一个子模块，提供分析信息的服务。有关如何使用和配置此模块的更多信息，请参阅模块 README。

OpenEuropa Webtools 验证码

Webtools 模块包含一个子模块，集成了 Webtools 验证码功能。有关如何使用和配置此模块的更多信息，请参阅模块 README。

OpenEuropa Webtools eTrans

Webtools eTrans 模块提供了一个块，显示指向欧洲委员会机器翻译服务的链接。访客可以点击此链接将当前页面翻译成他们偏好的语言。

OpenEuropa Webtools Laco 服务

Webtools 模块包含一个子模块，提供检索实体资源语言覆盖范围信息的服务。有关如何使用和测试此模块的更多信息，请参阅模块 README。

OpenEuropa Webtools Laco 小部件

Webtools 模块包含一个子模块，提供与 Laco 服务集成的组件。有关如何使用和配置此模块的更多信息，请参阅模块 README。

OpenEuropa Webtools 地理编码

Webtools 模块包含一个子模块，提供与地理编码服务集成的组件。

Webtools 地理编码要求

• geocoder-php/geocoder 4.x
• drupal/geocoder 3.x
• openeuropa/webtools-geocoding-provider

Webtools 地理编码使用

如果您想使用 Webtools 地理编码服务，请启用子模块

drush en oe_webtools_geocoding

OpenEuropa Webtools 地图

Webtools 模块包含一个子模块，提供与地图服务集成的组件。

Webtools 地图要求

• drupal/geofield 1.x

OpenEuropa Webtools Cookie 允许

Webtools 模块包含一个子模块，提供 Cookie 允许套件的服务。有关如何使用和配置此模块的更多信息，请参阅模块 README。

OpenEuropa Webtools 媒体

Webtools 模块包含一个子模块，提供作为受支持媒体提供者的 Webtools 小部件。

Webtools 媒体要求

• drupal/json_field 1.x-rc3

OpenEuropa Webtools 社交分享

Webtools 模块包含一个子模块，为网站提供社交分享功能。

开发设置

您可以通过以下步骤构建测试网站。

• 安装所有 composer 依赖项

composer install

这将在./build目录中构建一个功能齐全的Drupal测试站点，可用于开发和展示模块的功能。

在设置和安装站点之前，请确保通过将runner.yml.dist复制到./runner.yml并覆盖相关属性来自定义默认配置值。

这还将

• 在./build/modules/custom/oe_webtools中创建主题的符号链接，以便它可用于测试站点
• 使用./runner.yml.dist中的值设置Drush和Drupal的设置。这包括为EULogin添加参数
• 使用./runner.yml.dist中的值设置PHPUnit和Behat配置文件

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

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

如果您不希望重新运行完整的站点设置，您只需运行

$ ./vendor/bin/run drupal:symlink-project

• 安装站点

./vendor/bin/run drupal:site-install

您的测试站点将在./build中可用。

使用Docker Compose

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

Docker提供必要的服务和技术，如Web服务器和数据库服务器，以运行站点，而无论您的本地主机配置如何。

要求

• Docker
• Docker Compose

配置

默认情况下，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
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

与内容一起工作

该项目包含以下Task Runner命令，用于在RDF存储中处理内容，它们需要Docker Compose服务运行和运行。

清除所有数据

$ docker-compose exec sparql ./vendor/bin/robo purge

或者，如果您可以在主机机器上运行命令

$ ./vendor/bin/run sparql:purge

导入默认数据

$ docker-compose exec sparql ./vendor/bin/robo import

或者，如果您可以在主机机器上运行命令

$ ./vendor/bin/run sparql:import

重置所有数据，即运行清除和导入

$ docker-compose exec sparql ./vendor/bin/robo purge
$ docker-compose exec sparql ./vendor/bin/robo import

或者，如果您可以在主机机器上运行命令

$ ./vendor/bin/run sparql:reset

逐步调试

要从命令行启用逐步调试，请向容器传递带有任何值的XDEBUG_SESSION环境变量

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

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

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

贡献

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

版本控制

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