123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238 |
- <?php
- namespace Doctrine\Common\Persistence;
- use BadMethodCallException;
- use Doctrine\Common\Collections\ArrayCollection;
- use Doctrine\Common\Collections\Collection;
- use Doctrine\Persistence\Mapping\ClassMetadata;
- use Doctrine\Persistence\ObjectManager;
- use Doctrine\Persistence\ObjectManagerAware;
- use InvalidArgumentException;
- use RuntimeException;
- use function lcfirst;
- use function substr;
- /**
- * PersistentObject base class that implements getter/setter methods for all mapped fields and associations
- * by overriding __call.
- *
- * This class is a forward compatible implementation of the PersistentObject trait.
- *
- * Limitations:
- *
- * 1. All persistent objects have to be associated with a single ObjectManager, multiple
- * ObjectManagers are not supported. You can set the ObjectManager with `PersistentObject#setObjectManager()`.
- * 2. Setters and getters only work if a ClassMetadata instance was injected into the PersistentObject.
- * This is either done on `postLoad` of an object or by accessing the global object manager.
- * 3. There are no hooks for setters/getters. Just implement the method yourself instead of relying on __call().
- * 4. Slower than handcoded implementations: An average of 7 method calls per access to a field and 11 for an association.
- * 5. Only the inverse side associations get autoset on the owning side as well. Setting objects on the owning side
- * will not set the inverse side associations.
- *
- * @deprecated Deprecated `PersistentObject` class in 1.2. Please implement this functionality
- * directly in your application if you want ActiveRecord style functionality.
- *
- * @example
- *
- * PersistentObject::setObjectManager($em);
- *
- * class Foo extends PersistentObject
- * {
- * private $id;
- * }
- *
- * $foo = new Foo();
- * $foo->getId(); // method exists through __call
- */
- abstract class PersistentObject implements ObjectManagerAware
- {
- /** @var ObjectManager|null */
- private static $objectManager = null;
- /** @var ClassMetadata|null */
- private $cm = null;
- /**
- * Sets the object manager responsible for all persistent object base classes.
- *
- * @return void
- */
- public static function setObjectManager(?ObjectManager $objectManager = null)
- {
- self::$objectManager = $objectManager;
- }
- /**
- * @return ObjectManager|null
- */
- public static function getObjectManager()
- {
- return self::$objectManager;
- }
- /**
- * Injects the Doctrine Object Manager.
- *
- * @return void
- *
- * @throws RuntimeException
- */
- public function injectObjectManager(ObjectManager $objectManager, ClassMetadata $classMetadata)
- {
- if ($objectManager !== self::$objectManager) {
- throw new RuntimeException('Trying to use PersistentObject with different ObjectManager instances. ' .
- 'Was PersistentObject::setObjectManager() called?');
- }
- $this->cm = $classMetadata;
- }
- /**
- * Sets a persistent fields value.
- *
- * @param string $field
- * @param mixed[] $args
- *
- * @return void
- *
- * @throws BadMethodCallException When no persistent field exists by that name.
- * @throws InvalidArgumentException When the wrong target object type is passed to an association.
- */
- private function set($field, $args)
- {
- if ($this->cm->hasField($field) && ! $this->cm->isIdentifier($field)) {
- $this->$field = $args[0];
- } elseif ($this->cm->hasAssociation($field) && $this->cm->isSingleValuedAssociation($field)) {
- $targetClass = $this->cm->getAssociationTargetClass($field);
- if (! ($args[0] instanceof $targetClass) && $args[0] !== null) {
- throw new InvalidArgumentException("Expected persistent object of type '" . $targetClass . "'");
- }
- $this->$field = $args[0];
- $this->completeOwningSide($field, $targetClass, $args[0]);
- } else {
- throw new BadMethodCallException("no field with name '" . $field . "' exists on '" . $this->cm->getName() . "'");
- }
- }
- /**
- * Gets a persistent field value.
- *
- * @param string $field
- *
- * @return mixed
- *
- * @throws BadMethodCallException When no persistent field exists by that name.
- */
- private function get($field)
- {
- if ($this->cm->hasField($field) || $this->cm->hasAssociation($field)) {
- return $this->$field;
- }
- throw new BadMethodCallException("no field with name '" . $field . "' exists on '" . $this->cm->getName() . "'");
- }
- /**
- * If this is an inverse side association, completes the owning side.
- *
- * @param string $field
- * @param ClassMetadata $targetClass
- * @param object $targetObject
- *
- * @return void
- */
- private function completeOwningSide($field, $targetClass, $targetObject)
- {
- // add this object on the owning side as well, for obvious infinite recursion
- // reasons this is only done when called on the inverse side.
- if (! $this->cm->isAssociationInverseSide($field)) {
- return;
- }
- $mappedByField = $this->cm->getAssociationMappedByTargetField($field);
- $targetMetadata = self::$objectManager->getClassMetadata($targetClass);
- $setter = ($targetMetadata->isCollectionValuedAssociation($mappedByField) ? 'add' : 'set') . $mappedByField;
- $targetObject->$setter($this);
- }
- /**
- * Adds an object to a collection.
- *
- * @param string $field
- * @param mixed[] $args
- *
- * @return void
- *
- * @throws BadMethodCallException
- * @throws InvalidArgumentException
- */
- private function add($field, $args)
- {
- if (! $this->cm->hasAssociation($field) || ! $this->cm->isCollectionValuedAssociation($field)) {
- throw new BadMethodCallException('There is no method add' . $field . '() on ' . $this->cm->getName());
- }
- $targetClass = $this->cm->getAssociationTargetClass($field);
- if (! ($args[0] instanceof $targetClass)) {
- throw new InvalidArgumentException("Expected persistent object of type '" . $targetClass . "'");
- }
- if (! ($this->$field instanceof Collection)) {
- $this->$field = new ArrayCollection($this->$field ?: []);
- }
- $this->$field->add($args[0]);
- $this->completeOwningSide($field, $targetClass, $args[0]);
- }
- /**
- * Initializes Doctrine Metadata for this class.
- *
- * @return void
- *
- * @throws RuntimeException
- */
- private function initializeDoctrine()
- {
- if ($this->cm !== null) {
- return;
- }
- if (! self::$objectManager) {
- throw new RuntimeException('No runtime object manager set. Call PersistentObject#setObjectManager().');
- }
- $this->cm = self::$objectManager->getClassMetadata(static::class);
- }
- /**
- * Magic methods.
- *
- * @param string $method
- * @param mixed[] $args
- *
- * @return mixed
- *
- * @throws BadMethodCallException
- */
- public function __call($method, $args)
- {
- $this->initializeDoctrine();
- $command = substr($method, 0, 3);
- $field = lcfirst(substr($method, 3));
- if ($command === 'set') {
- $this->set($field, $args);
- } elseif ($command === 'get') {
- return $this->get($field);
- } elseif ($command === 'add') {
- $this->add($field, $args);
- } else {
- throw new BadMethodCallException('There is no method ' . $method . ' on ' . $this->cm->getName());
- }
- }
- }
|