Chris@0: <?php
Chris@0: /*
Chris@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Chris@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Chris@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Chris@0:  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Chris@0:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Chris@0:  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Chris@0:  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Chris@0:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Chris@0:  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@0:  *
Chris@0:  * This software consists of voluntary contributions made by many individuals
Chris@0:  * and is licensed under the MIT license. For more information, see
Chris@0:  * <http://www.doctrine-project.org>.
Chris@0:  */
Chris@0: 
Chris@0: namespace Doctrine\Common\Proxy;
Chris@0: 
Chris@0: use Doctrine\Common\Persistence\Mapping\ClassMetadata;
Chris@0: use Doctrine\Common\Proxy\Exception\InvalidArgumentException;
Chris@0: use Doctrine\Common\Proxy\Exception\UnexpectedValueException;
Chris@0: use Doctrine\Common\Util\ClassUtils;
Chris@0: 
Chris@0: /**
Chris@0:  * This factory is used to generate proxy classes.
Chris@0:  * It builds proxies from given parameters, a template and class metadata.
Chris@0:  *
Chris@0:  * @author Marco Pivetta <ocramius@gmail.com>
Chris@0:  * @since  2.4
Chris@0:  */
Chris@0: class ProxyGenerator
Chris@0: {
Chris@0:     /**
Chris@0:      * Used to match very simple id methods that don't need
Chris@0:      * to be decorated since the identifier is known.
Chris@0:      */
Chris@12:     const PATTERN_MATCH_ID_METHOD = '((public\s+)?(function\s+%s\s*\(\)\s*)\s*(?::\s*\??\s*\\\\?[a-z_\x7f-\xff][\w\x7f-\xff]*(?:\\\\[a-z_\x7f-\xff][\w\x7f-\xff]*)*\s*)?{\s*return\s*\$this->%s;\s*})i';
Chris@0: 
Chris@0:     /**
Chris@0:      * The namespace that contains all proxy classes.
Chris@0:      *
Chris@0:      * @var string
Chris@0:      */
Chris@0:     private $proxyNamespace;
Chris@0: 
Chris@0:     /**
Chris@0:      * The directory that contains all proxy classes.
Chris@0:      *
Chris@0:      * @var string
Chris@0:      */
Chris@0:     private $proxyDirectory;
Chris@0: 
Chris@0:     /**
Chris@0:      * Map of callables used to fill in placeholders set in the template.
Chris@0:      *
Chris@0:      * @var string[]|callable[]
Chris@0:      */
Chris@0:     protected $placeholders = [
Chris@0:         'baseProxyInterface'   => Proxy::class,
Chris@0:         'additionalProperties' => '',
Chris@0:     ];
Chris@0: 
Chris@0:     /**
Chris@0:      * Template used as a blueprint to generate proxies.
Chris@0:      *
Chris@0:      * @var string
Chris@0:      */
Chris@0:     protected $proxyClassTemplate = '<?php
Chris@0: 
Chris@0: namespace <namespace>;
Chris@0: 
Chris@0: /**
Chris@0:  * DO NOT EDIT THIS FILE - IT WAS CREATED BY DOCTRINE\'S PROXY GENERATOR
Chris@0:  */
Chris@0: class <proxyShortClassName> extends \<className> implements \<baseProxyInterface>
Chris@0: {
Chris@0:     /**
Chris@0:      * @var \Closure the callback responsible for loading properties in the proxy object. This callback is called with
Chris@0:      *      three parameters, being respectively the proxy object to be initialized, the method that triggered the
Chris@0:      *      initialization process and an array of ordered parameters that were passed to that method.
Chris@0:      *
Chris@0:      * @see \Doctrine\Common\Persistence\Proxy::__setInitializer
Chris@0:      */
Chris@0:     public $__initializer__;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var \Closure the callback responsible of loading properties that need to be copied in the cloned object
Chris@0:      *
Chris@0:      * @see \Doctrine\Common\Persistence\Proxy::__setCloner
Chris@0:      */
Chris@0:     public $__cloner__;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var boolean flag indicating if this object was already initialized
Chris@0:      *
Chris@0:      * @see \Doctrine\Common\Persistence\Proxy::__isInitialized
Chris@0:      */
Chris@0:     public $__isInitialized__ = false;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var array properties to be lazy loaded, with keys being the property
Chris@0:      *            names and values being their default values
Chris@0:      *
Chris@0:      * @see \Doctrine\Common\Persistence\Proxy::__getLazyProperties
Chris@0:      */
Chris@0:     public static $lazyPropertiesDefaults = [<lazyPropertiesDefaults>];
Chris@0: 
Chris@0: <additionalProperties>
Chris@0: 
Chris@0: <constructorImpl>
Chris@0: 
Chris@0: <magicGet>
Chris@0: 
Chris@0: <magicSet>
Chris@0: 
Chris@0: <magicIsset>
Chris@0: 
Chris@0: <sleepImpl>
Chris@0: 
Chris@0: <wakeupImpl>
Chris@0: 
Chris@0: <cloneImpl>
Chris@0: 
Chris@0:     /**
Chris@0:      * Forces initialization of the proxy
Chris@0:      */
Chris@0:     public function __load()
Chris@0:     {
Chris@0:         $this->__initializer__ && $this->__initializer__->__invoke($this, \'__load\', []);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      * @internal generated method: use only when explicitly handling proxy specific loading logic
Chris@0:      */
Chris@0:     public function __isInitialized()
Chris@0:     {
Chris@0:         return $this->__isInitialized__;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      * @internal generated method: use only when explicitly handling proxy specific loading logic
Chris@0:      */
Chris@0:     public function __setInitialized($initialized)
Chris@0:     {
Chris@0:         $this->__isInitialized__ = $initialized;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      * @internal generated method: use only when explicitly handling proxy specific loading logic
Chris@0:      */
Chris@0:     public function __setInitializer(\Closure $initializer = null)
Chris@0:     {
Chris@0:         $this->__initializer__ = $initializer;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      * @internal generated method: use only when explicitly handling proxy specific loading logic
Chris@0:      */
Chris@0:     public function __getInitializer()
Chris@0:     {
Chris@0:         return $this->__initializer__;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      * @internal generated method: use only when explicitly handling proxy specific loading logic
Chris@0:      */
Chris@0:     public function __setCloner(\Closure $cloner = null)
Chris@0:     {
Chris@0:         $this->__cloner__ = $cloner;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      * @internal generated method: use only when explicitly handling proxy specific cloning logic
Chris@0:      */
Chris@0:     public function __getCloner()
Chris@0:     {
Chris@0:         return $this->__cloner__;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      * @internal generated method: use only when explicitly handling proxy specific loading logic
Chris@0:      * @static
Chris@0:      */
Chris@0:     public function __getLazyProperties()
Chris@0:     {
Chris@0:         return self::$lazyPropertiesDefaults;
Chris@0:     }
Chris@0: 
Chris@0:     <methods>
Chris@0: }
Chris@0: ';
Chris@0: 
Chris@0:     /**
Chris@0:      * Initializes a new instance of the <tt>ProxyFactory</tt> class that is
Chris@0:      * connected to the given <tt>EntityManager</tt>.
Chris@0:      *
Chris@0:      * @param string $proxyDirectory The directory to use for the proxy classes. It must exist.
Chris@0:      * @param string $proxyNamespace The namespace to use for the proxy classes.
Chris@0:      *
Chris@0:      * @throws InvalidArgumentException
Chris@0:      */
Chris@0:     public function __construct($proxyDirectory, $proxyNamespace)
Chris@0:     {
Chris@0:         if ( ! $proxyDirectory) {
Chris@0:             throw InvalidArgumentException::proxyDirectoryRequired();
Chris@0:         }
Chris@0: 
Chris@0:         if ( ! $proxyNamespace) {
Chris@0:             throw InvalidArgumentException::proxyNamespaceRequired();
Chris@0:         }
Chris@0: 
Chris@0:         $this->proxyDirectory        = $proxyDirectory;
Chris@0:         $this->proxyNamespace        = $proxyNamespace;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Sets a placeholder to be replaced in the template.
Chris@0:      *
Chris@0:      * @param string          $name
Chris@0:      * @param string|callable $placeholder
Chris@0:      *
Chris@0:      * @throws InvalidArgumentException
Chris@0:      */
Chris@0:     public function setPlaceholder($name, $placeholder)
Chris@0:     {
Chris@0:         if ( ! is_string($placeholder) && ! is_callable($placeholder)) {
Chris@0:             throw InvalidArgumentException::invalidPlaceholder($name);
Chris@0:         }
Chris@0: 
Chris@0:         $this->placeholders[$name] = $placeholder;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Sets the base template used to create proxy classes.
Chris@0:      *
Chris@0:      * @param string $proxyClassTemplate
Chris@0:      */
Chris@0:     public function setProxyClassTemplate($proxyClassTemplate)
Chris@0:     {
Chris@0:         $this->proxyClassTemplate = (string) $proxyClassTemplate;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates a proxy class file.
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class    Metadata for the original class.
Chris@0:      * @param string|bool                                        $fileName Filename (full path) for the generated class. If none is given, eval() is used.
Chris@0:      *
Chris@0:      * @throws UnexpectedValueException
Chris@0:      */
Chris@0:     public function generateProxyClass(ClassMetadata $class, $fileName = false)
Chris@0:     {
Chris@0:         preg_match_all('(<([a-zA-Z]+)>)', $this->proxyClassTemplate, $placeholderMatches);
Chris@0: 
Chris@0:         $placeholderMatches = array_combine($placeholderMatches[0], $placeholderMatches[1]);
Chris@0:         $placeholders       = [];
Chris@0: 
Chris@0:         foreach ($placeholderMatches as $placeholder => $name) {
Chris@0:             $placeholders[$placeholder] = isset($this->placeholders[$name])
Chris@0:                 ? $this->placeholders[$name]
Chris@0:                 : [$this, 'generate' . $name];
Chris@0:         }
Chris@0: 
Chris@0:         foreach ($placeholders as & $placeholder) {
Chris@0:             if (is_callable($placeholder)) {
Chris@0:                 $placeholder = call_user_func($placeholder, $class);
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $proxyCode = strtr($this->proxyClassTemplate, $placeholders);
Chris@0: 
Chris@0:         if ( ! $fileName) {
Chris@0:             $proxyClassName = $this->generateNamespace($class) . '\\' . $this->generateProxyShortClassName($class);
Chris@0: 
Chris@0:             if ( ! class_exists($proxyClassName)) {
Chris@0:                 eval(substr($proxyCode, 5));
Chris@0:             }
Chris@0: 
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $parentDirectory = dirname($fileName);
Chris@0: 
Chris@0:         if ( ! is_dir($parentDirectory) && (false === @mkdir($parentDirectory, 0775, true))) {
Chris@0:             throw UnexpectedValueException::proxyDirectoryNotWritable($this->proxyDirectory);
Chris@0:         }
Chris@0: 
Chris@0:         if ( ! is_writable($parentDirectory)) {
Chris@0:             throw UnexpectedValueException::proxyDirectoryNotWritable($this->proxyDirectory);
Chris@0:         }
Chris@0: 
Chris@0:         $tmpFileName = $fileName . '.' . uniqid('', true);
Chris@0: 
Chris@0:         file_put_contents($tmpFileName, $proxyCode);
Chris@0:         @chmod($tmpFileName, 0664);
Chris@0:         rename($tmpFileName, $fileName);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates the proxy short class name to be used in the template.
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function generateProxyShortClassName(ClassMetadata $class)
Chris@0:     {
Chris@0:         $proxyClassName = ClassUtils::generateProxyClassName($class->getName(), $this->proxyNamespace);
Chris@0:         $parts          = explode('\\', strrev($proxyClassName), 2);
Chris@0: 
Chris@0:         return strrev($parts[0]);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates the proxy namespace.
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function generateNamespace(ClassMetadata $class)
Chris@0:     {
Chris@0:         $proxyClassName = ClassUtils::generateProxyClassName($class->getName(), $this->proxyNamespace);
Chris@0:         $parts = explode('\\', strrev($proxyClassName), 2);
Chris@0: 
Chris@0:         return strrev($parts[1]);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates the original class name.
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function generateClassName(ClassMetadata $class)
Chris@0:     {
Chris@0:         return ltrim($class->getName(), '\\');
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates the array representation of lazy loaded public properties and their default values.
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function generateLazyPropertiesDefaults(ClassMetadata $class)
Chris@0:     {
Chris@0:         $lazyPublicProperties = $this->getLazyLoadedPublicProperties($class);
Chris@0:         $values               = [];
Chris@0: 
Chris@0:         foreach ($lazyPublicProperties as $key => $value) {
Chris@0:             $values[] = var_export($key, true) . ' => ' . var_export($value, true);
Chris@0:         }
Chris@0: 
Chris@0:         return implode(', ', $values);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates the constructor code (un-setting public lazy loaded properties, setting identifier field values).
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function generateConstructorImpl(ClassMetadata $class)
Chris@0:     {
Chris@0:         $constructorImpl = <<<'EOT'
Chris@0:     /**
Chris@0:      * @param \Closure $initializer
Chris@0:      * @param \Closure $cloner
Chris@0:      */
Chris@0:     public function __construct($initializer = null, $cloner = null)
Chris@0:     {
Chris@0: 
Chris@0: EOT;
Chris@0:         $toUnset = [];
Chris@0: 
Chris@0:         foreach ($this->getLazyLoadedPublicProperties($class) as $lazyPublicProperty => $unused) {
Chris@0:             $toUnset[] = '$this->' . $lazyPublicProperty;
Chris@0:         }
Chris@0: 
Chris@0:         $constructorImpl .= (empty($toUnset) ? '' : '        unset(' . implode(', ', $toUnset) . ");\n")
Chris@0:             . <<<'EOT'
Chris@0: 
Chris@0:         $this->__initializer__ = $initializer;
Chris@0:         $this->__cloner__      = $cloner;
Chris@0:     }
Chris@0: EOT;
Chris@0: 
Chris@0:         return $constructorImpl;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates the magic getter invoked when lazy loaded public properties are requested.
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function generateMagicGet(ClassMetadata $class)
Chris@0:     {
Chris@0:         $lazyPublicProperties = array_keys($this->getLazyLoadedPublicProperties($class));
Chris@0:         $reflectionClass      = $class->getReflectionClass();
Chris@0:         $hasParentGet         = false;
Chris@0:         $returnReference      = '';
Chris@0:         $inheritDoc           = '';
Chris@0: 
Chris@0:         if ($reflectionClass->hasMethod('__get')) {
Chris@0:             $hasParentGet = true;
Chris@0:             $inheritDoc   = '{@inheritDoc}';
Chris@0: 
Chris@0:             if ($reflectionClass->getMethod('__get')->returnsReference()) {
Chris@0:                 $returnReference = '& ';
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         if (empty($lazyPublicProperties) && ! $hasParentGet) {
Chris@0:             return '';
Chris@0:         }
Chris@0: 
Chris@0:         $magicGet = <<<EOT
Chris@0:     /**
Chris@0:      * $inheritDoc
Chris@0:      * @param string \$name
Chris@0:      */
Chris@0:     public function {$returnReference}__get(\$name)
Chris@0:     {
Chris@0: 
Chris@0: EOT;
Chris@0: 
Chris@0:         if ( ! empty($lazyPublicProperties)) {
Chris@0:             $magicGet .= <<<'EOT'
Chris@0:         if (array_key_exists($name, $this->__getLazyProperties())) {
Chris@0:             $this->__initializer__ && $this->__initializer__->__invoke($this, '__get', [$name]);
Chris@0: 
Chris@0:             return $this->$name;
Chris@0:         }
Chris@0: 
Chris@0: 
Chris@0: EOT;
Chris@0:         }
Chris@0: 
Chris@0:         if ($hasParentGet) {
Chris@0:             $magicGet .= <<<'EOT'
Chris@0:         $this->__initializer__ && $this->__initializer__->__invoke($this, '__get', [$name]);
Chris@0: 
Chris@0:         return parent::__get($name);
Chris@0: 
Chris@0: EOT;
Chris@0:         } else {
Chris@0:             $magicGet .= <<<'EOT'
Chris@0:         trigger_error(sprintf('Undefined property: %s::$%s', __CLASS__, $name), E_USER_NOTICE);
Chris@0: 
Chris@0: EOT;
Chris@0:         }
Chris@0: 
Chris@0:         $magicGet .= "    }";
Chris@0: 
Chris@0:         return $magicGet;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates the magic setter (currently unused).
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function generateMagicSet(ClassMetadata $class)
Chris@0:     {
Chris@0:         $lazyPublicProperties = $this->getLazyLoadedPublicProperties($class);
Chris@0:         $hasParentSet         = $class->getReflectionClass()->hasMethod('__set');
Chris@0: 
Chris@0:         if (empty($lazyPublicProperties) && ! $hasParentSet) {
Chris@0:             return '';
Chris@0:         }
Chris@0: 
Chris@0:         $inheritDoc = $hasParentSet ? '{@inheritDoc}' : '';
Chris@0:         $magicSet   = <<<EOT
Chris@0:     /**
Chris@0:      * $inheritDoc
Chris@0:      * @param string \$name
Chris@0:      * @param mixed  \$value
Chris@0:      */
Chris@0:     public function __set(\$name, \$value)
Chris@0:     {
Chris@0: 
Chris@0: EOT;
Chris@0: 
Chris@0:         if ( ! empty($lazyPublicProperties)) {
Chris@0:             $magicSet .= <<<'EOT'
Chris@0:         if (array_key_exists($name, $this->__getLazyProperties())) {
Chris@0:             $this->__initializer__ && $this->__initializer__->__invoke($this, '__set', [$name, $value]);
Chris@0: 
Chris@0:             $this->$name = $value;
Chris@0: 
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0: 
Chris@0: EOT;
Chris@0:         }
Chris@0: 
Chris@0:         if ($hasParentSet) {
Chris@0:             $magicSet .= <<<'EOT'
Chris@0:         $this->__initializer__ && $this->__initializer__->__invoke($this, '__set', [$name, $value]);
Chris@0: 
Chris@0:         return parent::__set($name, $value);
Chris@0: EOT;
Chris@0:         } else {
Chris@0:             $magicSet .= "        \$this->\$name = \$value;";
Chris@0:         }
Chris@0: 
Chris@0:         $magicSet .= "\n    }";
Chris@0: 
Chris@0:         return $magicSet;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates the magic issetter invoked when lazy loaded public properties are checked against isset().
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function generateMagicIsset(ClassMetadata $class)
Chris@0:     {
Chris@0:         $lazyPublicProperties = array_keys($this->getLazyLoadedPublicProperties($class));
Chris@0:         $hasParentIsset       = $class->getReflectionClass()->hasMethod('__isset');
Chris@0: 
Chris@0:         if (empty($lazyPublicProperties) && ! $hasParentIsset) {
Chris@0:             return '';
Chris@0:         }
Chris@0: 
Chris@0:         $inheritDoc = $hasParentIsset ? '{@inheritDoc}' : '';
Chris@0:         $magicIsset = <<<EOT
Chris@0:     /**
Chris@0:      * $inheritDoc
Chris@0:      * @param  string \$name
Chris@0:      * @return boolean
Chris@0:      */
Chris@0:     public function __isset(\$name)
Chris@0:     {
Chris@0: 
Chris@0: EOT;
Chris@0: 
Chris@0:         if ( ! empty($lazyPublicProperties)) {
Chris@0:             $magicIsset .= <<<'EOT'
Chris@0:         if (array_key_exists($name, $this->__getLazyProperties())) {
Chris@0:             $this->__initializer__ && $this->__initializer__->__invoke($this, '__isset', [$name]);
Chris@0: 
Chris@0:             return isset($this->$name);
Chris@0:         }
Chris@0: 
Chris@0: 
Chris@0: EOT;
Chris@0:         }
Chris@0: 
Chris@0:         if ($hasParentIsset) {
Chris@0:             $magicIsset .= <<<'EOT'
Chris@0:         $this->__initializer__ && $this->__initializer__->__invoke($this, '__isset', [$name]);
Chris@0: 
Chris@0:         return parent::__isset($name);
Chris@0: 
Chris@0: EOT;
Chris@0:         } else {
Chris@0:             $magicIsset .= "        return false;";
Chris@0:         }
Chris@0: 
Chris@0:         return $magicIsset . "\n    }";
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates implementation for the `__sleep` method of proxies.
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function generateSleepImpl(ClassMetadata $class)
Chris@0:     {
Chris@0:         $hasParentSleep = $class->getReflectionClass()->hasMethod('__sleep');
Chris@0:         $inheritDoc     = $hasParentSleep ? '{@inheritDoc}' : '';
Chris@0:         $sleepImpl      = <<<EOT
Chris@0:     /**
Chris@0:      * $inheritDoc
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function __sleep()
Chris@0:     {
Chris@0: 
Chris@0: EOT;
Chris@0: 
Chris@0:         if ($hasParentSleep) {
Chris@0:             return $sleepImpl . <<<'EOT'
Chris@0:         $properties = array_merge(['__isInitialized__'], parent::__sleep());
Chris@0: 
Chris@0:         if ($this->__isInitialized__) {
Chris@0:             $properties = array_diff($properties, array_keys($this->__getLazyProperties()));
Chris@0:         }
Chris@0: 
Chris@0:         return $properties;
Chris@0:     }
Chris@0: EOT;
Chris@0:         }
Chris@0: 
Chris@0:         $allProperties = ['__isInitialized__'];
Chris@0: 
Chris@0:         /* @var $prop \ReflectionProperty */
Chris@0:         foreach ($class->getReflectionClass()->getProperties() as $prop) {
Chris@0:             if ($prop->isStatic()) {
Chris@0:                 continue;
Chris@0:             }
Chris@0: 
Chris@0:             $allProperties[] = $prop->isPrivate()
Chris@0:                 ? "\0" . $prop->getDeclaringClass()->getName() . "\0" . $prop->getName()
Chris@0:                 : $prop->getName();
Chris@0:         }
Chris@0: 
Chris@0:         $lazyPublicProperties = array_keys($this->getLazyLoadedPublicProperties($class));
Chris@0:         $protectedProperties  = array_diff($allProperties, $lazyPublicProperties);
Chris@0: 
Chris@0:         foreach ($allProperties as &$property) {
Chris@0:             $property = var_export($property, true);
Chris@0:         }
Chris@0: 
Chris@0:         foreach ($protectedProperties as &$property) {
Chris@0:             $property = var_export($property, true);
Chris@0:         }
Chris@0: 
Chris@0:         $allProperties       = implode(', ', $allProperties);
Chris@0:         $protectedProperties = implode(', ', $protectedProperties);
Chris@0: 
Chris@0:         return $sleepImpl . <<<EOT
Chris@0:         if (\$this->__isInitialized__) {
Chris@0:             return [$allProperties];
Chris@0:         }
Chris@0: 
Chris@0:         return [$protectedProperties];
Chris@0:     }
Chris@0: EOT;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates implementation for the `__wakeup` method of proxies.
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function generateWakeupImpl(ClassMetadata $class)
Chris@0:     {
Chris@0:         $unsetPublicProperties = [];
Chris@0:         $hasWakeup             = $class->getReflectionClass()->hasMethod('__wakeup');
Chris@0: 
Chris@0:         foreach (array_keys($this->getLazyLoadedPublicProperties($class)) as $lazyPublicProperty) {
Chris@0:             $unsetPublicProperties[] = '$this->' . $lazyPublicProperty;
Chris@0:         }
Chris@0: 
Chris@0:         $shortName  = $this->generateProxyShortClassName($class);
Chris@0:         $inheritDoc = $hasWakeup ? '{@inheritDoc}' : '';
Chris@0:         $wakeupImpl = <<<EOT
Chris@0:     /**
Chris@0:      * $inheritDoc
Chris@0:      */
Chris@0:     public function __wakeup()
Chris@0:     {
Chris@0:         if ( ! \$this->__isInitialized__) {
Chris@0:             \$this->__initializer__ = function ($shortName \$proxy) {
Chris@0:                 \$proxy->__setInitializer(null);
Chris@0:                 \$proxy->__setCloner(null);
Chris@0: 
Chris@0:                 \$existingProperties = get_object_vars(\$proxy);
Chris@0: 
Chris@0:                 foreach (\$proxy->__getLazyProperties() as \$property => \$defaultValue) {
Chris@0:                     if ( ! array_key_exists(\$property, \$existingProperties)) {
Chris@0:                         \$proxy->\$property = \$defaultValue;
Chris@0:                     }
Chris@0:                 }
Chris@0:             };
Chris@0: 
Chris@0: EOT;
Chris@0: 
Chris@0:         if ( ! empty($unsetPublicProperties)) {
Chris@0:             $wakeupImpl .= "\n            unset(" . implode(', ', $unsetPublicProperties) . ");";
Chris@0:         }
Chris@0: 
Chris@0:         $wakeupImpl .= "\n        }";
Chris@0: 
Chris@0:         if ($hasWakeup) {
Chris@0:             $wakeupImpl .= "\n        parent::__wakeup();";
Chris@0:         }
Chris@0: 
Chris@0:         $wakeupImpl .= "\n    }";
Chris@0: 
Chris@0:         return $wakeupImpl;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates implementation for the `__clone` method of proxies.
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function generateCloneImpl(ClassMetadata $class)
Chris@0:     {
Chris@0:         $hasParentClone  = $class->getReflectionClass()->hasMethod('__clone');
Chris@0:         $inheritDoc      = $hasParentClone ? '{@inheritDoc}' : '';
Chris@0:         $callParentClone = $hasParentClone ? "\n        parent::__clone();\n" : '';
Chris@0: 
Chris@0:         return <<<EOT
Chris@0:     /**
Chris@0:      * $inheritDoc
Chris@0:      */
Chris@0:     public function __clone()
Chris@0:     {
Chris@0:         \$this->__cloner__ && \$this->__cloner__->__invoke(\$this, '__clone', []);
Chris@0: $callParentClone    }
Chris@0: EOT;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates decorated methods by picking those available in the parent class.
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function generateMethods(ClassMetadata $class)
Chris@0:     {
Chris@0:         $methods           = '';
Chris@0:         $methodNames       = [];
Chris@0:         $reflectionMethods = $class->getReflectionClass()->getMethods(\ReflectionMethod::IS_PUBLIC);
Chris@0:         $skippedMethods    = [
Chris@0:             '__sleep'   => true,
Chris@0:             '__clone'   => true,
Chris@0:             '__wakeup'  => true,
Chris@0:             '__get'     => true,
Chris@0:             '__set'     => true,
Chris@0:             '__isset'   => true,
Chris@0:         ];
Chris@0: 
Chris@0:         foreach ($reflectionMethods as $method) {
Chris@0:             $name = $method->getName();
Chris@0: 
Chris@0:             if (
Chris@0:                 $method->isConstructor() ||
Chris@0:                 isset($skippedMethods[strtolower($name)]) ||
Chris@0:                 isset($methodNames[$name]) ||
Chris@0:                 $method->isFinal() ||
Chris@0:                 $method->isStatic() ||
Chris@0:                 ( ! $method->isPublic())
Chris@0:             ) {
Chris@0:                 continue;
Chris@0:             }
Chris@0: 
Chris@0:             $methodNames[$name] = true;
Chris@0:             $methods .= "\n    /**\n"
Chris@0:                 . "     * {@inheritDoc}\n"
Chris@0:                 . "     */\n"
Chris@0:                 . '    public function ';
Chris@0: 
Chris@0:             if ($method->returnsReference()) {
Chris@0:                 $methods .= '&';
Chris@0:             }
Chris@0: 
Chris@0:             $methods .= $name . '(' . $this->buildParametersString($class, $method, $method->getParameters()) . ')';
Chris@0:             $methods .= $this->getMethodReturnType($method);
Chris@0:             $methods .= "\n" . '    {' . "\n";
Chris@0: 
Chris@0:             if ($this->isShortIdentifierGetter($method, $class)) {
Chris@0:                 $identifier = lcfirst(substr($name, 3));
Chris@0:                 $fieldType  = $class->getTypeOfField($identifier);
Chris@0:                 $cast       = in_array($fieldType, ['integer', 'smallint']) ? '(int) ' : '';
Chris@0: 
Chris@0:                 $methods .= '        if ($this->__isInitialized__ === false) {' . "\n";
Chris@12:                 $methods .= '            ';
Chris@12:                 $methods .= $this->shouldProxiedMethodReturn($method) ? 'return ' : '';
Chris@12:                 $methods .= $cast . ' parent::' . $method->getName() . "();\n";
Chris@0:                 $methods .= '        }' . "\n\n";
Chris@0:             }
Chris@0: 
Chris@0:             $invokeParamsString = implode(', ', $this->getParameterNamesForInvoke($method->getParameters()));
Chris@0:             $callParamsString = implode(', ', $this->getParameterNamesForParentCall($method->getParameters()));
Chris@0: 
Chris@0:             $methods .= "\n        \$this->__initializer__ "
Chris@0:                 . "&& \$this->__initializer__->__invoke(\$this, " . var_export($name, true)
Chris@0:                 . ", [" . $invokeParamsString . "]);"
Chris@12:                 . "\n\n        "
Chris@12:                 . ($this->shouldProxiedMethodReturn($method) ? 'return ' : '')
Chris@12:                 . "parent::" . $name . '(' . $callParamsString . ');'
Chris@0:                 . "\n" . '    }' . "\n";
Chris@0:         }
Chris@0: 
Chris@0:         return $methods;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates the Proxy file name.
Chris@0:      *
Chris@0:      * @param string $className
Chris@0:      * @param string $baseDirectory Optional base directory for proxy file name generation.
Chris@0:      *                              If not specified, the directory configured on the Configuration of the
Chris@0:      *                              EntityManager will be used by this factory.
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     public function getProxyFileName($className, $baseDirectory = null)
Chris@0:     {
Chris@0:         $baseDirectory = $baseDirectory ?: $this->proxyDirectory;
Chris@0: 
Chris@0:         return rtrim($baseDirectory, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . Proxy::MARKER
Chris@0:             . str_replace('\\', '', $className) . '.php';
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Checks if the method is a short identifier getter.
Chris@0:      *
Chris@0:      * What does this mean? For proxy objects the identifier is already known,
Chris@0:      * however accessing the getter for this identifier usually triggers the
Chris@0:      * lazy loading, leading to a query that may not be necessary if only the
Chris@0:      * ID is interesting for the userland code (for example in views that
Chris@0:      * generate links to the entity, but do not display anything else).
Chris@0:      *
Chris@0:      * @param \ReflectionMethod                                  $method
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return boolean
Chris@0:      */
Chris@0:     private function isShortIdentifierGetter($method, ClassMetadata $class)
Chris@0:     {
Chris@0:         $identifier = lcfirst(substr($method->getName(), 3));
Chris@0:         $startLine = $method->getStartLine();
Chris@0:         $endLine = $method->getEndLine();
Chris@0:         $cheapCheck = (
Chris@0:             $method->getNumberOfParameters() == 0
Chris@0:             && substr($method->getName(), 0, 3) == 'get'
Chris@0:             && in_array($identifier, $class->getIdentifier(), true)
Chris@0:             && $class->hasField($identifier)
Chris@0:             && (($endLine - $startLine) <= 4)
Chris@0:         );
Chris@0: 
Chris@0:         if ($cheapCheck) {
Chris@0:             $code = file($method->getDeclaringClass()->getFileName());
Chris@0:             $code = trim(implode(' ', array_slice($code, $startLine - 1, $endLine - $startLine + 1)));
Chris@0: 
Chris@0:             $pattern = sprintf(self::PATTERN_MATCH_ID_METHOD, $method->getName(), $identifier);
Chris@0: 
Chris@0:             if (preg_match($pattern, $code)) {
Chris@0:                 return true;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return false;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates the list of public properties to be lazy loaded, with their default values.
Chris@0:      *
Chris@0:      * @param \Doctrine\Common\Persistence\Mapping\ClassMetadata $class
Chris@0:      *
Chris@0:      * @return mixed[]
Chris@0:      */
Chris@0:     private function getLazyLoadedPublicProperties(ClassMetadata $class)
Chris@0:     {
Chris@0:         $defaultProperties = $class->getReflectionClass()->getDefaultProperties();
Chris@0:         $properties = [];
Chris@0: 
Chris@0:         foreach ($class->getReflectionClass()->getProperties(\ReflectionProperty::IS_PUBLIC) as $property) {
Chris@0:             $name = $property->getName();
Chris@0: 
Chris@0:             if (($class->hasField($name) || $class->hasAssociation($name)) && ! $class->isIdentifier($name)) {
Chris@0:                 $properties[$name] = $defaultProperties[$name];
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return $properties;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param ClassMetadata          $class
Chris@0:      * @param \ReflectionMethod      $method
Chris@0:      * @param \ReflectionParameter[] $parameters
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function buildParametersString(ClassMetadata $class, \ReflectionMethod $method, array $parameters)
Chris@0:     {
Chris@0:         $parameterDefinitions = [];
Chris@0: 
Chris@0:         /* @var $param \ReflectionParameter */
Chris@0:         foreach ($parameters as $param) {
Chris@0:             $parameterDefinition = '';
Chris@0: 
Chris@0:             if ($parameterType = $this->getParameterType($class, $method, $param)) {
Chris@0:                 $parameterDefinition .= $parameterType . ' ';
Chris@0:             }
Chris@0: 
Chris@0:             if ($param->isPassedByReference()) {
Chris@0:                 $parameterDefinition .= '&';
Chris@0:             }
Chris@0: 
Chris@0:             if (method_exists($param, 'isVariadic') && $param->isVariadic()) {
Chris@0:                 $parameterDefinition .= '...';
Chris@0:             }
Chris@0: 
Chris@0:             $parameters[]     = '$' . $param->getName();
Chris@0:             $parameterDefinition .= '$' . $param->getName();
Chris@0: 
Chris@0:             if ($param->isDefaultValueAvailable()) {
Chris@0:                 $parameterDefinition .= ' = ' . var_export($param->getDefaultValue(), true);
Chris@0:             }
Chris@0: 
Chris@0:             $parameterDefinitions[] = $parameterDefinition;
Chris@0:         }
Chris@0: 
Chris@0:         return implode(', ', $parameterDefinitions);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param ClassMetadata $class
Chris@0:      * @param \ReflectionMethod $method
Chris@0:      * @param \ReflectionParameter $parameter
Chris@0:      *
Chris@0:      * @return string|null
Chris@0:      */
Chris@0:     private function getParameterType(ClassMetadata $class, \ReflectionMethod $method, \ReflectionParameter $parameter)
Chris@0:     {
Chris@12:         if (method_exists($parameter, 'hasType')) {
Chris@12:             if ( ! $parameter->hasType()) {
Chris@12:                 return '';
Chris@12:             }
Chris@0: 
Chris@12:             return $this->formatType($parameter->getType(), $parameter->getDeclaringFunction(), $parameter);
Chris@12:         }
Chris@12: 
Chris@12:         // For PHP 5.x, we need to pick the type hint in the old way (to be removed for PHP 7.0+)
Chris@0:         if ($parameter->isArray()) {
Chris@0:             return 'array';
Chris@0:         }
Chris@0: 
Chris@0:         if ($parameter->isCallable()) {
Chris@0:             return 'callable';
Chris@0:         }
Chris@0: 
Chris@0:         try {
Chris@0:             $parameterClass = $parameter->getClass();
Chris@0: 
Chris@0:             if ($parameterClass) {
Chris@0:                 return '\\' . $parameterClass->getName();
Chris@0:             }
Chris@0:         } catch (\ReflectionException $previous) {
Chris@0:             throw UnexpectedValueException::invalidParameterTypeHint(
Chris@0:                 $class->getName(),
Chris@0:                 $method->getName(),
Chris@0:                 $parameter->getName(),
Chris@0:                 $previous
Chris@0:             );
Chris@0:         }
Chris@0: 
Chris@0:         return null;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param \ReflectionParameter[] $parameters
Chris@0:      *
Chris@0:      * @return string[]
Chris@0:      */
Chris@0:     private function getParameterNamesForInvoke(array $parameters)
Chris@0:     {
Chris@0:         return array_map(
Chris@0:             function (\ReflectionParameter $parameter) {
Chris@0:                 return '$' . $parameter->getName();
Chris@0:             },
Chris@0:             $parameters
Chris@0:         );
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param \ReflectionParameter[] $parameters
Chris@0:      *
Chris@0:      * @return string[]
Chris@0:      */
Chris@0:     private function getParameterNamesForParentCall(array $parameters)
Chris@0:     {
Chris@0:         return array_map(
Chris@0:             function (\ReflectionParameter $parameter) {
Chris@0:                 $name = '';
Chris@0: 
Chris@0:                 if (method_exists($parameter, 'isVariadic') && $parameter->isVariadic()) {
Chris@0:                     $name .= '...';
Chris@0:                 }
Chris@0: 
Chris@0:                 $name .= '$' . $parameter->getName();
Chris@0: 
Chris@0:                 return $name;
Chris@0:             },
Chris@0:             $parameters
Chris@0:         );
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @Param \ReflectionMethod $method
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     private function getMethodReturnType(\ReflectionMethod $method)
Chris@0:     {
Chris@12:         if ( ! method_exists($method, 'hasReturnType') || ! $method->hasReturnType()) {
Chris@0:             return '';
Chris@0:         }
Chris@0: 
Chris@12:         return ': ' . $this->formatType($method->getReturnType(), $method);
Chris@12:     }
Chris@0: 
Chris@12:     /**
Chris@12:      * @param \ReflectionMethod $method
Chris@12:      *
Chris@12:      * @return bool
Chris@12:      */
Chris@12:     private function shouldProxiedMethodReturn(\ReflectionMethod $method)
Chris@12:     {
Chris@12:         if ( ! method_exists($method, 'hasReturnType') || ! $method->hasReturnType()) {
Chris@12:             return true;
Chris@0:         }
Chris@0: 
Chris@12:         return 'void' !== strtolower($this->formatType($method->getReturnType(), $method));
Chris@12:     }
Chris@12: 
Chris@12:     /**
Chris@12:      * @param \ReflectionType $type
Chris@12:      * @param \ReflectionMethod $method
Chris@12:      * @param \ReflectionParameter|null $parameter
Chris@12:      *
Chris@12:      * @return string
Chris@12:      */
Chris@12:     private function formatType(
Chris@12:         \ReflectionType $type,
Chris@12:         \ReflectionMethod $method,
Chris@12:         \ReflectionParameter $parameter = null
Chris@12:     ) {
Chris@12:         $name = method_exists($type, 'getName') ? $type->getName() : (string) $type;
Chris@12:         $nameLower = strtolower($name);
Chris@0: 
Chris@0:         if ('self' === $nameLower) {
Chris@12:             $name = $method->getDeclaringClass()->getName();
Chris@0:         }
Chris@0: 
Chris@0:         if ('parent' === $nameLower) {
Chris@12:             $name = $method->getDeclaringClass()->getParentClass()->getName();
Chris@0:         }
Chris@0: 
Chris@12:         if ( ! $type->isBuiltin() && ! class_exists($name) && ! interface_exists($name)) {
Chris@12:             if (null !== $parameter) {
Chris@12:                 throw UnexpectedValueException::invalidParameterTypeHint(
Chris@12:                     $method->getDeclaringClass()->getName(),
Chris@12:                     $method->getName(),
Chris@12:                     $parameter->getName()
Chris@12:                 );
Chris@12:             }
Chris@12: 
Chris@12:             throw UnexpectedValueException::invalidReturnTypeHint(
Chris@12:                 $method->getDeclaringClass()->getName(),
Chris@12:                 $method->getName()
Chris@12:             );
Chris@12:         }
Chris@12: 
Chris@12:         if ( ! $type->isBuiltin()) {
Chris@12:             $name = '\\' . $name;
Chris@12:         }
Chris@12: 
Chris@12:         if ($type->allowsNull()
Chris@12:             && (null === $parameter || ! $parameter->isDefaultValueAvailable() || null !== $parameter->getDefaultValue())
Chris@12:         ) {
Chris@12:             $name = '?' . $name;
Chris@12:         }
Chris@12: 
Chris@12:         return $name;
Chris@0:     }
Chris@0: }