added DocumentManagerDecorator (BC break in several internal classes)

doctrine · May 14, 2015 · 1ce94cb · 1ce94cb
1 parent 3f68f7c
commit 1ce94cb
Show file tree

Hide file tree

Showing 33 changed files with 1,219 additions and 483 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ Changelog
 1.3.0
 -----
 
+* **2015-05-14**: Added a DocumentManagerInterface and a base DocumentManagerDecorator
+                  to allow users of the library to decorate the document manager.
+                  **Potential BC break** several internal classes changed their signatures 
+                  from DocumentManager to DocumentManagerInterface.
 * **2015-04-07**: Class metadata now validates that you can not map the UUID on
                   Documents that are not referenceable. Either set your
                   documents `referenceable=true` or remove the UUID mapping.

diff --git a/lib/Doctrine/ODM/PHPCR/ChildrenCollection.php b/lib/Doctrine/ODM/PHPCR/ChildrenCollection.php
@@ -42,13 +42,13 @@ class ChildrenCollection extends PersistentCollection
     /**
      * Creates a new persistent collection.
      *
-     * @param DocumentManager $dm         The DocumentManager the collection will be associated with.
-     * @param object          $document   The parent document instance
-     * @param string|array    $filter     Filter string or array of filter string
-     * @param int             $fetchDepth Optional fetch depth, -1 to not override.
-     * @param string          $locale     The locale to use during the loading of this collection
+     * @param DocumentManagerInterface $dm  The DocumentManager the collection will be associated with.
+     * @param object          $document     The parent document instance
+     * @param string|array    $filter       Filter string or array of filter string
+     * @param int             $fetchDepth   Optional fetch depth, -1 to not override.
+     * @param string          $locale       The locale to use during the loading of this collection
      */
-    public function __construct(DocumentManager $dm, $document, $filter = null, $fetchDepth = -1, $locale = null)
+    public function __construct(DocumentManagerInterface $dm, $document, $filter = null, $fetchDepth = -1, $locale = null)
     {
         $this->dm = $dm;
         $this->document = $document;
@@ -58,7 +58,7 @@ public function __construct(DocumentManager $dm, $document, $filter = null, $fet
     }
 
     /**
-     * @param DocumentManager  $dm             The DocumentManager the collection will be associated with.
+     * @param DocumentManagerInterface  $dm    The DocumentManager the collection will be associated with.
      * @param object           $document       The parent document instance
      * @param array|Collection $collection     The collection to initialize with
      * @param string|array     $filter         Filter string or array of filter string
@@ -67,7 +67,7 @@ public function __construct(DocumentManager $dm, $document, $filter = null, $fet
      *
      * @return ChildrenCollection
      */
-    public static function createFromCollection(DocumentManager $dm, $document, $collection, $filter = null, $fetchDepth = -1, $forceOverwrite = false)
+    public static function createFromCollection(DocumentManagerInterface $dm, $document, $collection, $filter = null, $fetchDepth = -1, $forceOverwrite = false)
     {
         $childrenCollection = new self($dm, $document, $filter, $fetchDepth);
         $childrenCollection->initializeFromCollection($collection, $forceOverwrite);