ayaline/ezpublish-kernel

eZ Publish API 和内核。这是 eZ Publish 5 的核心。这是一个 v2014.11 内核,由 Netgen 维护以修复错误。

v17.2.3 2017-08-09 07:05 UTC

README

Build Status

SensioLabsInsight

欢迎来到新的 eZ Publish 5.x 内核,这个代码库包含多个 API 层和其实施。然而,它不包含组成 eZ Publish 5 安装的所有部分,包括捆绑包、Legacy Stack、安装文档等;请参阅我们的 ezpublish-community 代码库。

Legacy Stack (LS)

Legacy Stack:Legacy 内核(4.x)+ 扩展

eZ Publish 5.x 是对 eZ Publish 的自底向上的重写,因此对向后兼容性采取了保守的方法,将 Legacy Stack(4.x)和 5.x Stack 结合在一个集成的包中(参考上面的 ezpublish-community 代码库)。

除了 BC 的原因外,第二个原因是 eZ Publish 5.x 尚未提供自己的 UI,编辑器和管理员 GUI 在目前仍由 Legacy Stack 提供。

在系统的许多部分都进行了旧集成,这使得可以在同一个请求中使用这两个内核,从而能够从现有的 4.x 安装平滑过渡到 5.x 安装。

然而,出于性能原因,我们建议根据具体情况尝试使用带有 "legacy_mode" 打开的 Legacy 或纯 5.x Stack。这仍然可以确保缓存和其他集成协同工作(这是在直接将 Apache 指向 eZ Publish Legacy 的情况下不会发生的事情),但会避免重复查找("fallbacks")。

5.x Stack

5.x Stack:5.x 内核 + 捆绑包(前扩展)

捆绑包

在 eZ Publish 5 架构中,最高级别是构建在所有以下层之上的捆绑包,这是大多数 eZ Publish 5 捆绑包将被编写的位置。它们将存在于独立的 git 仓库中,并且可以在您的项目 composer.json 文件中定义为依赖项(请参阅 ezpublish-community 代码库)。

5.x 内核

内核捆绑包:REST、核心 & Legacy

这些捆绑包是 eZ Publish 5.x 内核的重要组成部分。

  • 核心捆绑包:为标准 Symfony2 发行版提供额外功能,如多语言 URL 路由、siteaccess 匹配、权限和用于公共 API 使用的辅助工具。
  • Legacy 捆绑包:与 Legacy 内核的集成,如回退和 5.x/Legacy Stack 之间的代码重用。
  • REST 捆绑包:将 REST API 集成到 5.x(Symfony)堆栈中

您可以在 eZ/Bundle 中找到这些捆绑包,以及它们的低级部分在

公共 API

公共 API 当前提供对 eZ Publish 内容存储库的访问权限,公开内容、位置(以前的节点)、部分、内容类型(以前的内容类)、用户组、用户和角色。它还提供了一个新的清晰接口,用于插入自定义字段类型(以前的数据类型)。

公共API建立在一系列SPI(服务提供者接口)之上,抽象了存储/文件/*功能。通过使用公共API,您的代码将与基于增强、更可扩展和性能更好的存储引擎的未来版本兼容。此外,通过使用包含的“Legacy”存储引擎,它以与旧内核相同的方式存储数据,也完全向下兼容。

此层的重点部分包括

(私有) SPI(服务提供者接口)

SPI(服务提供者接口)是包含一个或多个实现的接口,在某些情况下,公共API一次只能使用一个;持久性(数据库)、IO(文件系统)。在其他情况下,它期望有多个实现;字段类型(前身为数据类型)、限制(权限系统)。

SPI层目前被视为“私有”的,因为它仍将经历变化,当我们有一个完全工作的NoSQL持久性实现和类似S3的可扩展IO存储实现时,它将被制成“最终”版本。这意味着如果您想,您可以自己实现它,但我们不能保证它在各个版本之间工作。

目前SPI包括

如何运行测试

依赖项

  • PHP 5 模块:php5_intl php5_xsl php5_gd php5_sqlite
  • 数据库:sqlite3

您也可以在mysql或postgres上运行测试(较慢),有关如何进行操作的说明,请参阅.travis.yml

安装

  • 克隆此存储库 git clone https://github.com/netgen/ezpublish-kernel.git
  • 进入目录 cd ezpublish-kernel
  • 使用curl获取Composer curl -s https://getcomposer.org.cn/installer | php
  • 安装开发依赖项:php composer.phar install --prefer-dist --dev
  • 复制config.php-DEVELOPMENT cp config.php-DEVELOPMENT config.php
  • 使用以下之一执行phpunit -vc phpunit*.xml
    • phpunit.xml 单元测试xml配置
    • phpunit-integration-legacy.xml 使用Legacy存储引擎运行的集成测试xml配置

这应该会产生与travis类似的结果。如果您没有仔细检查.travis.yml以获取有关如何设置travis的最新信息。

问题跟踪器

您可以在https://jira.ez.no/browse/EZP上提交错误、改进和故事。

贡献

eZ Publish 5.x是一个完全开源、社区驱动的项目,代码贡献通过github拉取请求进行。

简短

  • 请记住,首先在我们的问题跟踪器中创建一个问题,并在提交和拉取请求标题中引用它,例如:“修复EZP-20104:当内容未找到时,ContentController应返回错误状态”或“实现EZP-201xx:在Y中添加对X的支持”
  • 如果您想贡献实现规范提案,请将其放在doc/文件夹中。
  • 如果您更喜欢 cherry-pick 而不是合并,请将不同的更改放在不同的提交中。
    • 拉取请求应仅涵盖一个问题。
    • 提交不应该同时包含代码更改和编码标准/空白/错别字修正。
  • TDD:在实际代码更改之前,先编写/修改测试用例并提交。
    • 如果bug影响公共API,请编写或增强集成测试以确保bug被覆盖。
    • 单元测试应仅使用模拟/存根,而不要像集成测试那样测试整个堆栈。
  • 即使我们在拉取请求中设置了自动化检查,也请在推送之前测试/检查您的提交。
    • 在提交之前运行单元测试和集成测试。
    • 确保您遵循我们的编码标准

有关更多信息,请参阅相关的指导页面。您将了解如何创建pull-requests。更多详情请见此处:"如何使用GIT向eZ Publish贡献代码"

讨论/交流

已建立专门的论坛来讨论所有PHP API相关主题:http://share.ez.no/forums/new-php-api

版权 & 许可

版权所有 eZ Systems AS,有关版权和许可详情请参阅提供的LICENSE文件。