Doctrine2 behavioral extensions
This package contains extensions for Doctrine ORM and MongoDB ODM that offer new functionality or tools to use Doctrine more efficiently. These behaviors can be easily attached to the event system of Doctrine and handle the records being flushed in a behavioral way.
3.0 will focus on refreshing this package for today's PHP. This includes:
- Bumping minimum version requirements of PHP, Doctrine, and other dependencies
- Updating the test suite, add code and style standards, and other needed build tools
- Cleaning up documentation, code, comments, etc.
While major code changes are not expected initially for 3.0, it will be a major release due to changes in requirements and toolsets.
For the current stable version, see the v2.4.x branch.
$ composer require gedmo/doctrine-extensions
- Blameable - updates string or reference fields on create, update and even property change with a string or object (e.g. user).
- Loggable - helps tracking changes and history of objects, also supports version management.
- Sluggable - urlizes your specified fields into single unique slug
- Timestampable - updates date fields on create, update and even property change.
- Translatable - gives you a very handy solution for translating records into different languages. Easy to setup, easier to use.
- Tree - automates the tree handling process and adds some tree-specific functions on repository. (closure, nested set or materialized path) (MongoDB ODM only supports materialized path)
- IpTraceable - inherited from Timestampable, sets IP address instead of timestamp
- SoftDeleteable - allows to implicitly remove records
- Sortable - makes any document or entity sortable
- Uploadable - provides file upload handling in entity fields
- References - supports linking Entities in Documents and vice versa
- ReferenceIntegrity - constrains ODM MongoDB Document references
All extensions support YAML, Annotation and XML mapping. Additional mapping drivers can be easily implemented using Mapping extension to handle the additional metadata mapping.
|Extensions Version||Compatible Doctrine ORM & Common Library|
|2.3||2.2 - 2.4|
If you are setting up the Entity Manager without a framework, see the the example to prevent issues like #1310
XML mapping needs to be in a different namespace, the declared namespace for Doctrine extensions is http://gediminasm.org/schemas/orm/doctrine-extensions-mapping So root node now looks like this:
<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping" xmlns:gedmo="http://gediminasm.org/schemas/orm/doctrine-extensions-mapping"> ... </doctrine-mapping>
XML mapping xsd schemas are also versioned and can be used by version suffix:
- Latest version - http://gediminasm.org/schemas/orm/doctrine-extensions-mapping
- 2.2.x version - http://gediminasm.org/schemas/orm/doctrine-extensions-mapping-2-2
- 2.1.x version - http://gediminasm.org/schemas/orm/doctrine-extensions-mapping-2-1
To set up and run the tests, follow these steps:
- Install Lando, a Docker-based dev environment tool
lando startfrom the project root
- Make sure you
composer installproject dependencies
lando php bin/phpunit -c tests
To set up and run example, follow these steps:
- go to the root directory of extensions
- download composer:
- install dev libraries:
php composer.phar install
example/em.phpand configure your database on top of the file
php example/bin/consolefor console commands
./example/bin/console orm:schema-tool:createto create schema
php example/run.phpto run example
Thanks to everyone participating in the development of these great Doctrine extensions!
And especially ones who create and maintain new extensions: