mkietlinski/doctrine-extensions

v2.5 2020-04-22 06:32 UTC

README

Build Status Latest Stable Version

本软件包包含对Doctrine ORM和MongoDB ODM的扩展,提供了新的功能或工具,使Doctrine的使用更加高效。这些行为可以轻松地附加到Doctrine的事件系统中,并以行为方式处理正在被刷新的记录。

安装

$ composer require gedmo/doctrine-extensions

扩展

ORM & MongoDB ODM

  • Blameable - 在创建、更新甚至属性更改时更新字符串或引用字段,例如用户。
  • Loggable - 帮助跟踪对象的更改和历史,也支持版本管理。
  • Sluggable - 将指定的字段转换为单个唯一的slug
  • Timestampable - 在创建、更新甚至属性更改时更新日期字段。
  • Translatable - 提供了一种非常方便的解决方案,可以将记录翻译成不同的语言。易于设置,更易于使用。
  • Tree - 自动化树处理过程,并在仓库中添加一些特定的树函数。(闭包嵌套集(MongoDB ODM仅支持materialized path)

仅ORM

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

仅MongoDB ODM

所有扩展都支持YAMLAnnotationXML映射。可以通过映射扩展轻松实现额外的映射驱动程序,以处理额外的元数据映射。

版本兼容性

如果您在没有框架的情况下设置实体管理器,请参阅示例以防止类似#1310的问题

XML映射

XML映射需要位于不同的命名空间中,Doctrine扩展声明的命名空间为http://gediminasm.org/schemas/orm/doctrine-extensions-mapping 因此根节点现在看起来像这样

<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
                 xmlns:gedmo="http://gediminasm.org/schemas/orm/doctrine-extensions-mapping">
...
</doctrine-mapping>

XML映射xsd模式也进行了版本控制,可以使用版本后缀来使用。

运行测试

pdo-sqlite 扩展是必需的。

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

  • 转到扩展的根目录
  • 下载composer: wget https://getcomposer.org.cn/composer.phar
  • 安装开发库: php composer.phar install
  • 运行: bin/phpunit -c tests
  • 可选 - 如果针对mongo测试,则运行mongodb服务

运行示例

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

  • 转到扩展的根目录
  • 下载composer: wget https://getcomposer.org.cn/composer.phar
  • 安装开发库: php composer.phar install
  • 编辑 example/em.php 并在文件顶部配置您的数据库
  • 运行: ./example/bin/consolephp example/bin/console 用于控制台命令
  • 运行: ./example/bin/console orm:schema-tool:create 以创建模式
  • 运行: php example/run.php 以运行示例

贡献者

感谢所有参与这些优秀的Doctrine扩展开发的参与者

特别是那些创建和维护新扩展的人