doctrine / mongodb-odm

lib/Doctrine/ODM/MongoDB/Proxy/ProxyFactory.php

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\Proxy;

use Closure;
use Doctrine\Common\EventManager;
use Doctrine\Common\NotifyPropertyChanged;
use Doctrine\Common\Persistence\Mapping\ClassMetadata as BaseClassMetadata;
use Doctrine\Common\Proxy\AbstractProxyFactory;
use Doctrine\Common\Proxy\Proxy as BaseProxy;
use Doctrine\Common\Proxy\ProxyDefinition;
use Doctrine\Common\Proxy\ProxyGenerator;
use Doctrine\Common\Util\ClassUtils;
use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\DocumentNotFoundException;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadataFactory;
use Doctrine\ODM\MongoDB\Persisters\DocumentPersister;
use Doctrine\ODM\MongoDB\UnitOfWork;
use Doctrine\ODM\MongoDB\Utility\LifecycleEventManager;
use ReflectionProperty;
use function get_class;

/**
 * This factory is used to create proxy objects for documents at runtime.
 */
class ProxyFactory extends AbstractProxyFactory

The class Doctrine\Common\Proxy\AbstractProxyFactory has been deprecated with message: The Doctrine\Common\Proxy component is deprecated, please use ocramius/proxy-manager instead.

{
    /** @var ClassMetadataFactory */
    private $metadataFactory;

Consider using a different property name as you override a private property of the parent class.

    /** @var UnitOfWork The UnitOfWork this factory is bound to. */
    private $uow;

    /** @var string The namespace that contains all proxy classes. */
    private $proxyNamespace;

    /** @var EventManager */
    private $lifecycleEventManager;

    /**
     * Initializes a new instance of the <tt>ProxyFactory</tt> class that is
     * connected to the given <tt>DocumentManager</tt>.
     *
     * @param DocumentManager $documentManager The DocumentManager the new factory works for.
     * @param string          $proxyDir        The directory to use for the proxy classes. It
     *                                         must exist.
     * @param string          $proxyNamespace  The namespace to use for the proxy classes.
     * @param int             $autoGenerate    Whether to automatically generate proxy classes.
     */
    public function __construct(DocumentManager $documentManager, $proxyDir, $proxyNamespace, $autoGenerate = AbstractProxyFactory::AUTOGENERATE_NEVER)
    {
        $this->metadataFactory       = $documentManager->getMetadataFactory();
        $this->uow                   = $documentManager->getUnitOfWork();
        $this->proxyNamespace        = $proxyNamespace;
        $this->lifecycleEventManager = new LifecycleEventManager($documentManager, $this->uow, $documentManager->getEventManager());
        $proxyGenerator              = new ProxyGenerator($proxyDir, $proxyNamespace);

The class Doctrine\Common\Proxy\ProxyGenerator has been deprecated with message: The Doctrine\Common\Proxy component is deprecated, please use ocramius/proxy-manager instead.

        $proxyGenerator->setPlaceholder('baseProxyInterface', Proxy::class);

        parent::__construct($proxyGenerator, $this->metadataFactory, $autoGenerate);
    }

    /**
     * {@inheritDoc}
     */
    public function skipClass(BaseClassMetadata $class)
    {
        /** @var ClassMetadata $class */
        return $class->isMappedSuperclass || $class->isQueryResultDocument || $class->getReflectionClass()->isAbstract();
    }

    /**
     * {@inheritDoc}
     */
    public function createProxyDefinition($className)
    {
        /** @var ClassMetadata $classMetadata */
        $classMetadata     = $this->metadataFactory->getMetadataFor($className);
        $documentPersister = $this->uow->getDocumentPersister($className);
        $reflectionId      = $classMetadata->reflFields[$classMetadata->identifier];

        return new ProxyDefinition(

The class Doctrine\Common\Proxy\ProxyDefinition has been deprecated with message: The Doctrine\Common\Proxy component is deprecated, please use ocramius/proxy-manager instead.

            ClassUtils::generateProxyClassName($className, $this->proxyNamespace),
            $classMetadata->getIdentifierFieldNames(),
            $classMetadata->getReflectionProperties(),
            $this->createInitializer($classMetadata, $documentPersister, $reflectionId),
            $this->createCloner($classMetadata, $documentPersister, $reflectionId)
        );
    }

    /**
     * Generates a closure capable of initializing a proxy
     *
     * @return Closure
     *
     * @throws DocumentNotFoundException
     */
    private function createInitializer(
        BaseClassMetadata $classMetadata,
        DocumentPersister $documentPersister,
        ReflectionProperty $reflectionId
    ) {
        if ($classMetadata->getReflectionClass()->hasMethod('__wakeup')) {
            return function (BaseProxy $proxy) use ($documentPersister, $reflectionId) {
                $proxy->__setInitializer(null);
                $proxy->__setCloner(null);

                if ($proxy->__isInitialized()) {
                    return;
                }

                $properties = $proxy->__getLazyProperties();

                foreach ($properties as $propertyName => $property) {
                    if (isset($proxy->$propertyName)) {
                        continue;
                    }

                    $proxy->$propertyName = $properties[$propertyName];
                }

                $proxy->__setInitialized(true);
                $proxy->__wakeup();

The method __wakeup() does not seem to exist on object<Doctrine\Common\Proxy\Proxy>.

                $id = $reflectionId->getValue($proxy);

                if ($documentPersister->load(['_id' => $id], $proxy) === null) {
                    if (! $this->lifecycleEventManager->documentNotFound($proxy, $id)) {

The method documentNotFound() does not seem to exist on object<Doctrine\Common\EventManager>.

                        throw DocumentNotFoundException::documentNotFound(get_class($proxy), $id);
                    }
                }

                if (! ($proxy instanceof NotifyPropertyChanged)) {
                    return;
                }

                $proxy->addPropertyChangedListener($this->uow);
            };
        }

        return function (BaseProxy $proxy) use ($documentPersister, $reflectionId) {
            $proxy->__setInitializer(null);
            $proxy->__setCloner(null);

            if ($proxy->__isInitialized()) {
                return;
            }

            $properties = $proxy->__getLazyProperties();

            foreach ($properties as $propertyName => $property) {
                if (isset($proxy->$propertyName)) {
                    continue;
                }

                $proxy->$propertyName = $properties[$propertyName];
            }

            $proxy->__setInitialized(true);

            $id = $reflectionId->getValue($proxy);

            if ($documentPersister->load(['_id' => $id], $proxy) === null) {
                if (! $this->lifecycleEventManager->documentNotFound($proxy, $id)) {

The method documentNotFound() does not seem to exist on object<Doctrine\Common\EventManager>.

                    throw DocumentNotFoundException::documentNotFound(get_class($proxy), $id);
                }
            }

            if (! ($proxy instanceof NotifyPropertyChanged)) {
                return;
            }

            $proxy->addPropertyChangedListener($this->uow);
        };
    }

    /**
     * Generates a closure capable of finalizing a cloned proxy
     *
     * @return Closure
     *
     * @throws DocumentNotFoundException
     */
    private function createCloner(
        BaseClassMetadata $classMetadata,
        DocumentPersister $documentPersister,
        ReflectionProperty $reflectionId
    ) {
        return function (BaseProxy $proxy) use ($documentPersister, $classMetadata, $reflectionId) {
            if ($proxy->__isInitialized()) {
                return;
            }

            $proxy->__setInitialized(true);
            $proxy->__setInitializer(null);

            $id       = $reflectionId->getValue($proxy);
            $original = $documentPersister->load(['_id' => $id]);

            if ($original === null) {
                if (! $this->lifecycleEventManager->documentNotFound($proxy, $id)) {

The method documentNotFound() does not seem to exist on object<Doctrine\Common\EventManager>.

                    throw DocumentNotFoundException::documentNotFound(get_class($proxy), $id);
                }
            }

            foreach ($classMetadata->getReflectionClass()->getProperties() as $reflectionProperty) {
                $propertyName = $reflectionProperty->getName();

                if (! $classMetadata->hasField($propertyName) && ! $classMetadata->hasAssociation($propertyName)) {
                    continue;
                }

                $reflectionProperty->setAccessible(true);
                $reflectionProperty->setValue($proxy, $reflectionProperty->getValue($original));
            }
        };
    }
}