README

关于phpList

phpList是一个开源新闻通讯管理器。该项目是对原始phpList的重新编写。

关于此包

这是phpList 3的后续版本的核心模块。它将承担以下职责

通过Doctrine模型和存储库（以及不需要模型的原始SQL）提供对数据库的访问
路由（Web前端和REST API将使用）
身份验证（Web前端和REST API将使用）
日志记录
一个脚本，可以从命令行（或cron作业）调用任务
创建和更新数据库模式的任务

请注意，此模块不提供Web前端或REST API。为此，有专门的模块phpList/web-frontend和phpList/rest-api。

不应在本地修改此模块。应通过Composer更新。

安装

由于此包仅是运行完整phpList 4安装所需的服务，因此推荐安装此包的方法是在需要此包的phpList基本分发版中运行composer install。 phpList/base-distribution在其README中包含详细的安装说明。

为此包做出贡献

对phpList存储库的贡献非常受欢迎！要开始，请查看贡献指南。它包含您需要了解的一切，包括如何运行本地样式检查和运行测试。

行为准则

本项目遵守贡献者行为准则。通过参与此项目和其社区，您应遵守此准则。

结构

运行Web服务器

phpList应用程序已配置为在开发和测试模式下运行内置的PHP Web服务器，而在生产模式下运行Apache。

请首先在config/parameters.yml中设置数据库凭据。

开发

要使用PHP内置服务器以开发模式运行应用程序，请使用以下命令

bin/console server:run -d public/

服务器将监听http://127.0.0.1:8000（如果端口8000已被占用，则监听8000之后的下一个可用端口）。

您可以通过按下 CTRL + C 停止服务器。

开发和文档

我们使用 phpDocumentor 自动生成类的文档。为了使此过程更高效、更简单，您需要通过添加 docblocks 来正确“文档化”您的 classes、properties、methods 等。

有关生成文档的更多信息，请参阅 PHPDOC.md

测试

要在测试模式下运行服务器（通常仅适用于自动化测试，请提供 --env 选项

bin/console server:run -d public/ --env=test

生产

有关使用 Apache 运行应用程序的文档，请参阅 phpList base distribution README。

更改数据库模式

对数据库模式的任何更改都必须始终在 phpList 3 及以后的版本中完成，以确保这两个版本始终具有相同的模式。

要更改数据库模式，请编辑 resources/Database/Schema.sql 并相应地调整相应的领域模型类和存储库类。

开发 phpList 模块（插件）

在 phpList 中，插件称为模块。它们是具有类型 phplist-module 的 Composer 包。

包和路由配置

如果您的模块提供任何 Symfony 包，则需要在模块的 composer.json 文件的 extra 部分列出包类名，如下所示

"extra": {
    "phplist/core": {
        "bundles": [
            "Symfony\\Bundle\\FrameworkBundle\\FrameworkBundle",
            "PhpList\\Core\\EmptyStartPageBundle\\PhpListEmptyStartPageBundle"
        ]
    }
}

请注意，extra 部分的键始终需要是 phplist/core，而不是您模块包的名称。请参阅 composer.json 在 rest-api 模块中的示例。

同样，如果您的模块提供任何路由，也需要在模块的 composer.json 文件的 extra 部分列出这些路由，如下所示

"extra": {
    "phplist/core": {
        "routes": {
            "homepage": {
                "resource": "@PhpListEmptyStartPageBundle/Controller/",
                "type": "annotation"
            }
        }
    }
}

您还可以为您的模块提供系统配置

"extra": {
    "phplist/core": {
        "configuration": {
            "framework": {
                "templating": {
                    "engines": [
                        "twig"
                    ]
                }
            }
        }
    }
}

建议您使用注释在控制器类中定义路由，以便在 composer.json 中保持路由配置最小。

访问数据库

要从模块中访问 phpList 数据表，请使用存储在 phplist/core 包（此包）中的 src/Domain/ 目录下的 Doctrine 模型和存储库类。

要访问存储库，请通过依赖注入进行注入。请不要直接从实体管理器获取存储库，因为这会跳过对该存储库的依赖注入，导致依赖于其他服务注入的方法出错。

目前，只有少数数据库表已映射为模型/存储库。如果您需要尚未提供的模型或存储库方法，请提交一个拉取请求或提交一个问题。

从第三方应用程序访问 phpList 数据

要从第三方应用程序（即不是从 phpList 模块）访问 phpList 数据，请使用 REST API。

phplist / core

维护者

详细信息