vendor/doctrine/common/lib/Doctrine/Common/Persistence/ObjectManagerAware.php

   1 <?php
   2 /*
   3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * This software consists of voluntary contributions made by many individuals
  16  * and is licensed under the MIT license. For more information, see
  17  * <http://www.doctrine-project.org>.
  18  */
  19
  20 namespace Doctrine\Common\Persistence;
  21
  22 use Doctrine\Common\Persistence\Mapping\ClassMetadata;
  23
  24 /**
  25  * Makes a Persistent Objects aware of its own object-manager.
  26  *
  27  * Using this interface the managing object manager and class metadata instances
  28  * are injected into the persistent object after construction. This allows
  29  * you to implement ActiveRecord functionality on top of the persistance-ignorance
  30  * that Doctrine propagates.
  31  *
  32  * Word of Warning: This is a very powerful hook to change how you can work with your domain models.
  33  * Using this hook will break the Single Responsibility Principle inside your Domain Objects
  34  * and increase the coupling of database and objects.
  35  *
  36  * Every ObjectManager has to implement this functionality itself.
  37  *
  38  * @author Benjamin Eberlei <kontakt@beberlei.de>
  39  */
  40 interface ObjectManagerAware
  41 {
  42     /**
  43      * Injects responsible ObjectManager and the ClassMetadata into this persistent object.
  44      *
  45      * @param ObjectManager $objectManager
  46      * @param ClassMetadata $classMetadata
  47      */
  48     public function injectObjectManager(ObjectManager $objectManager, ClassMetadata $classMetadata);
  49 }