/DoctrineExtensions

Extensions and diferent behaviors for Doctrine 2, Translatable, Sluggable, Tree - NestedSet, Timestampable, Loggable

Primary LanguagePHPMIT LicenseMIT

Some Doctrine 2 Extensions

Notice: This branch is compatible with Doctrine2.0.x versions and will be maintained only to support 2.0.x branch. All latest features and functionality updates are on master branch and compatible with upcomming releases of Doctrine2.1

This package contains extensions for Doctrine 2 that hook into the facilities of Doctrine and offer new functionality or tools to use Doctrine 2 more efficently. This package contains mostly used behaviors which can be easily attached to your event system of Doctrine 2 and handle the records being flushed in the behavioral way. List of extensions:

  • Tree - this extension automates the tree handling process and adds some tree specific functions on repository. (closure or nestedset)
  • Translatable - gives you a very handy solution for translating records into diferent languages. Easy to setup, easier to use.
  • Sluggable - urlizes your specified fields into single unique slug
  • Timestampable - updates date fields on create, update and even property change.
  • Loggable - helps tracking changes and history of objects, also supports version managment.

Currently these extensions support Yaml and Annotation mapping. Additional mapping drivers can be easy implemented using Mapping extension to handle the additional metadata mapping.

Notice: from now on there is only one listener per extension which supports ODM and ORM adapters to deal with objects. Only one instance of listener is required, and can be attached to many different type object managers, currently supported (ORM or ODM)

Latest updates

2011-04-16

  • Translation query walker is a killer feature for translatable extension. It lets to translate any query components and filter or order by translated fields. I recommmend you to use it extensively since it is very performative also.

2011-04-11

  • Tree nestedset was improved, now all in memory nodes are synchronized and do not require $em->clear() all the time. If you have any problems with new feature, open an issue.
  • Extensions now use only one listener instance for different object managers

ODM MongoDB support

Extensions which fully supports ODM:

  • Translatable
  • Sluggable
  • Timestampable
  • Loggable

All these extensions can be nested together. And most allready use only annotations without interface requirement to not to aggregate the entity itself and has implemented proper caching for metadata.

There is a post introducing to these extensions on doctrine project

You can test these extensions on my blog.

All tutorials for basic usage examples are on my blog also.

Recommendations

  • Use Symfony/Component/ClassLoader/UniversalClassLoader for autoloading these extensions, it will help to avoid triggering fatal error during the check of class_exists

Running the tests:

PHPUnit 3.4 or newer is required. To setup and run tests follow these steps:

  • go to the root directory of extensions
  • run: git submodule update --init
  • go to tests directory: cd tests
  • run cp phpunit.dist.xml phpunit.xml
  • run: phpunit
  • optional - run mongodb in background to complete all tests

Contributors: