Doctrine Behavioral Extensions 技术文档

本文档将详细介绍如何安装和使用Doctrine Behavioral Extensions，包括安装指南、使用说明以及项目API使用文档。

1. 安装指南

要安装Doctrine Behavioral Extensions，请使用以下命令：

composer require gedmo/doctrine-extensions

根据您的框架，以下是一些特定框架的安装指南：

• Symfony
• Laravel 5
• Laminas

2. 项目使用说明

Doctrine Behavioral Extensions为Doctrine ORM和MongoDB ODM提供了一系列扩展，这些扩展可以通过Doctrine的事件系统轻松附加，并以行为化的方式处理被刷新的记录。

以下是可用扩展的简要说明：

ORM & MongoDB ODM

• Blameable - 在创建、更新甚至属性变更时更新字符串或引用字段。
• Loggable - 跟踪对象的变化和历史，支持版本管理。
• Sluggable - 将指定的字段转换为唯一的slug。
• Timestampable - 在创建、更新甚至属性变更时更新日期字段。
• Translatable - 提供了一个非常方便的解决方案来将记录翻译成不同的语言。
• Tree - 自动化树形结构处理，并为仓库添加了一些树形特定的函数。

ORM Only

• IpTraceable - 继承自Timestampable，设置IP地址而不是时间戳。
• SoftDeleteable - 允许隐式删除记录。
• Sortable - 使任何文档或实体可排序。
• Uploadable - 提供文件上传处理在实体字段中。

MongoDB ODM Only

• References - 支持在文档和实体之间链接。
• ReferenceIntegrity - 约束ODM MongoDB文档引用。

所有扩展支持Attribute、XML和Annotation（已弃用）映射。可以通过Mapping扩展轻松实现其他映射驱动程序，以处理额外的元数据映射。

3. 项目API使用文档

具体的API使用文档请参考各个扩展的文档：

• Blameable
• Loggable
• Sluggable
• Timestampable
• Translatable
• Tree
• IpTraceable
• SoftDeleteable
• Sortable
• Uploadable
• References
• ReferenceIntegrity

4. 项目安装方式

以下是项目的安装方式：

• 使用Composer安装扩展。
• 根据您的框架选择适当的安装指南。
• 配置您的数据库连接。
• 运行相应的命令以创建数据库模式。

运行测试

要设置和运行测试，请按照以下步骤操作：

1. 安装Docker并确保您有docker compose。
2. 从项目根目录，运行docker compose up -d以在守护进程模式下启动容器。
3. 通过docker compose exec php bash进入容器（您现在位于根目录：/var/www）。
4. 通过composer install安装Composer依赖项。
5. 运行测试：vendor/bin/phpunit。

运行示例

要设置和运行示例，请按照以下步骤操作：

1. 进入扩展的根目录。
2. 下载Composer。
3. 安装开发库：composer install。
4. 编辑example/em.php并在文件顶部配置您的数据库。
5. 运行：php example/bin/console或php example/bin/console以运行控制台命令。
6. 运行：php example/bin/console orm:schema-tool:create以创建模式。
7. 运行：php example/bin/console app:print-category-translation-tree以运行示例并打印分类翻译树。