README

文章警报模块POC

这是一个 概念验证，用于在OXID eShop 6.2中引入六角模块架构。

关于模块

此模块将创建电子邮件警报以通知缺货产品功能添加到文章详情页面。

客户可以在文章详情页面输入其电子邮件地址，该地址将与有关文章的附加信息一起保存在存储中。

该存储可以通过微服务使用，如果产品再次有货，则发送通知。（不属于模块！）

限制

此模块是概念验证，不适合任何形式的商业使用。

兼容性

仅适用于OXID eShop 6.2及更高版本
该模块在OXID eShop社区版上构建并运行
该模块应适用于OXID eShop专业版和企业版
该模块在OXID eShop社区版上进行了测试
该模块在OXID eShop专业版和企业版上未进行测试

要求

OXID eShop 6.2社区版（或更高版本）
PHP 7.1（或更高版本）

通过composer安装模块

默认安装通过packagist（推荐）

将模块添加到您的商店composer.json中
- cd <shop root>
- composer require patrick-blom/article-alert-poc

通过GitHub的替代安装（手动）

在商店根目录下创建一个名为"thirdparty"的新文件夹，其中包含名为"pb"的子文件夹（与composer.json在同一级别）
- cd <shop root>
- mkdir -p thirdparty/pb
将存储库克隆到新文件夹
- git clone git@github.com:patrick-blom/article-alert.git thirdparty/pb/ArticleAlert
导航回商店根目录并添加存储库到composer.json
- composer config repositories.patrick-blom/article-alert-poc path thirdparty/pb/ArticleAlert
将模块添加到您的商店composer.json中
- composer require patrick-blom/article-alert-poc

OXID eShop模块激活（默认安装和替代安装相同）

准备eShop 6.2的模块配置
- vendor/bin/oe-console oe:module:install-configuration source/modules/pb/ArticleAlert/
- vendor/bin/oe-console oe:module:apply-configuration
激活模块
- vendor/bin/oe-console oe:module:activate articlealertpoc
由于模块添加了新的数据库字段，因此需要重新生成统一命名空间和视图
- vendor/bin/oe-eshop-unified_namespace_generator
- vendor/bin/oe-eshop-db_views_regenerate

使用

安装和激活后，模块即可使用，并将功能集成到产品详情页面上的details_productmain_tobasket块中。
默认情况下，您将在<shop root>/tmp下找到名为article_alert_db的文件，其中包含有关警报的所有信息。

测试

!注意！

即使这是一个概念验证。测试过程应在开发环境或CI管道中进行。

准备

按照说明安装模块
准备OXID测试库，如其在仓库中所描述，或者使用oxvm_eshop / docker-eshop-sdk
将pb/ArticleAlert添加到您的test_config.yml文件中的部分模块路径（例如：partial_module_paths: 'pb/ArticleAlert'）
将vendor模块目录中的config.inc.TEST.php.dist复制到您的商店根目录，并将其重命名为config.inc.TEST.php
根据您的需求调整config.inc.TEST.php中的设置（测试数据库名称、错误报告等）
修改您的config.inc.php文件，确保在测试期间加载config.inc.TEST.php

    // bottom of config.inc.php
    if (defined('OXID_PHP_UNIT')) {
        include "config.inc.TEST.php";
    }

运行测试

导航到商店根目录
使用以下命令运行测试：php vendor/bin/runtests <商店根目录绝对路径>/source/modules/pb/ArticleAlert/Tests
使用以下命令运行覆盖率：php vendor/bin/runtests-coverage <商店根目录绝对路径>/source/modules/pb/ArticleAlert/Tests

运行静态分析

使用以下命令安装phpstan：composer require --dev phpstan/phpstan
使用以下命令运行静态分析：
- 导航到<商店根目录>
- 使用以下参数运行phpstan：vendor/bin/phpstan analyze -c source/modules/pb/ArticleAlert/phpstan.neon

许可证

该模块在GPL-3.0许可证下发布。要查看完整概述，请查看LICENSE文件。

patrick-blom / article-alert-poc

维护者

详细信息