/lib/Doctrine/ODM/MongoDB/Proxy/ProxyFactory.php
PHP | 283 lines | 199 code | 22 blank | 62 comment | 11 complexity | 70b9a9b8db0a87df57ba2589abbc67a3 MD5 | raw file
- <?php
- /*
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * This software consists of voluntary contributions made by many individuals
- * and is licensed under the LGPL. For more information, see
- * <http://www.doctrine-project.org>.
- */
- namespace Doctrine\ODM\MongoDB\Proxy;
- use Doctrine\ODM\MongoDB\DocumentManager,
- Doctrine\ODM\MongoDB\Mapping\ClassMetadata,
- Doctrine\ODM\MongoDB\Mapping\AssociationMapping;
- /**
- * This factory is used to create proxy objects for documents at runtime.
- *
- * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
- * @since 1.0
- * @author Jonathan H. Wage <jonwage@gmail.com>
- * @author Roman Borschel <roman@code-factory.org>
- * @author Giorgio Sironi <piccoloprincipeazzurro@gmail.com>
- */
- class ProxyFactory
- {
- /** The DocumentManager this factory is bound to. */
- private $dm;
- /** Whether to automatically (re)generate proxy classes. */
- private $autoGenerate;
- /** The namespace that contains all proxy classes. */
- private $proxyNamespace;
- /** The directory that contains all proxy classes. */
- private $proxyDir;
- /**
- * Initializes a new instance of the <tt>ProxyFactory</tt> class that is
- * connected to the given <tt>DocumentManager</tt>.
- *
- * @param DocumentManager $dm The DocumentManager the new factory works for.
- * @param string $proxyDir The directory to use for the proxy classes. It must exist.
- * @param string $proxyNs The namespace to use for the proxy classes.
- * @param boolean $autoGenerate Whether to automatically generate proxy classes.
- */
- public function __construct(DocumentManager $dm, $proxyDir, $proxyNs, $autoGenerate = false)
- {
- if ( ! $proxyDir) {
- throw ProxyException::proxyDirectoryRequired();
- }
- if ( ! $proxyNs) {
- throw ProxyException::proxyNamespaceRequired();
- }
- $this->dm = $dm;
- $this->proxyDir = $proxyDir;
- $this->autoGenerate = $autoGenerate;
- $this->proxyNamespace = $proxyNs;
- }
- /**
- * Gets a reference proxy instance for the document of the given type and identified by
- * the given identifier.
- *
- * @param string $className
- * @param mixed $identifier
- * @return object
- */
- public function getProxy($className, $identifier)
- {
- $proxyClassName = str_replace('\\', '', $className) . 'Proxy';
- $fqn = $this->proxyNamespace . '\\' . $proxyClassName;
- if ($this->autoGenerate && ! class_exists($fqn, false)) {
- $fileName = $this->proxyDir . DIRECTORY_SEPARATOR . $proxyClassName . '.php';
- $this->generateProxyClass($this->dm->getClassMetadata($className), $proxyClassName, $fileName, self::$_proxyClassTemplate);
- require $fileName;
- }
- if ( ! $this->dm->getMetadataFactory()->hasMetadataFor($fqn)) {
- $this->dm->getMetadataFactory()->setMetadataFor($fqn, $this->dm->getClassMetadata($className));
- }
- return new $fqn($this->dm, $identifier);
- }
- /**
- * Generates proxy classes for all given classes.
- *
- * @param array $classes The classes (ClassMetadata instances) for which to generate proxies.
- * @param string $toDir The target directory of the proxy classes. If not specified, the
- * directory configured on the Configuration of the DocumentManager used
- * by this factory is used.
- */
- public function generateProxyClasses(array $classes, $toDir = null)
- {
- $proxyDir = $toDir ?: $this->proxyDir;
- $proxyDir = rtrim($proxyDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
- foreach ($classes as $class) {
- $proxyClassName = str_replace('\\', '', $class->name) . 'Proxy';
- $proxyFileName = $proxyDir . $proxyClassName . '.php';
- $this->generateProxyClass($class, $proxyClassName, $proxyFileName, self::$_proxyClassTemplate);
- }
- }
- /**
- * Generates a proxy class file.
- *
- * @param $class
- * @param $originalClassName
- * @param $proxyClassName
- * @param $file The path of the file to write to.
- */
- private function generateProxyClass($class, $proxyClassName, $fileName, $file)
- {
- $methods = $this->generateMethods($class);
- $sleepImpl = $this->generateSleep($class);
- $placeholders = array(
- '<namespace>',
- '<proxyClassName>', '<className>',
- '<methods>', '<sleepImpl>'
- );
- if(substr($class->name, 0, 1) == "\\") {
- $className = substr($class->name, 1);
- } else {
- $className = $class->name;
- }
- $replacements = array(
- $this->proxyNamespace,
- $proxyClassName, $className,
- $methods, $sleepImpl
- );
- $file = str_replace($placeholders, $replacements, $file);
- file_put_contents($fileName, $file);
- }
- /**
- * Generates the methods of a proxy class.
- *
- * @param ClassMetadata $class
- * @return string The code of the generated methods.
- */
- private function generateMethods(ClassMetadata $class)
- {
- $methods = '';
- foreach ($class->reflClass->getMethods() as $method) {
- /* @var $method ReflectionMethod */
- if ($method->isConstructor() || strtolower($method->getName()) == "__sleep") {
- continue;
- }
- if ($method->isPublic() && ! $method->isFinal() && ! $method->isStatic()) {
- $methods .= PHP_EOL . ' public function ' . $method->getName() . '(';
- $firstParam = true;
- $parameterString = $argumentString = '';
- foreach ($method->getParameters() as $param) {
- if ($firstParam) {
- $firstParam = false;
- } else {
- $parameterString .= ', ';
- $argumentString .= ', ';
- }
- // We need to pick the type hint class too
- if (($paramClass = $param->getClass()) !== null) {
- $parameterString .= '\\' . $paramClass->getName() . ' ';
- } elseif ($param->isArray()) {
- $parameterString .= 'array ';
- }
- if ($param->isPassedByReference()) {
- $parameterString .= '&';
- }
- $parameterString .= '$' . $param->getName();
- $argumentString .= '$' . $param->getName();
- if ($param->isDefaultValueAvailable()) {
- $parameterString .= ' = ' . var_export($param->getDefaultValue(), true);
- }
- }
- $methods .= $parameterString . ')';
- $methods .= PHP_EOL . ' {' . PHP_EOL;
- $methods .= ' $this->load();' . PHP_EOL;
- $methods .= ' return parent::' . $method->getName() . '(' . $argumentString . ');';
- $methods .= PHP_EOL . ' }' . PHP_EOL;
- }
- }
- return $methods;
- }
- /**
- * Generates the code for the __sleep method for a proxy class.
- *
- * @param $class
- * @return string
- */
- private function generateSleep(ClassMetadata $class)
- {
- $sleepImpl = '';
- if ($class->reflClass->hasMethod('__sleep')) {
- $sleepImpl .= 'return parent::__sleep();';
- } else {
- $sleepImpl .= 'return array(';
- $first = true;
- foreach ($class->getReflectionProperties() as $name => $prop) {
- if ($first) {
- $first = false;
- } else {
- $sleepImpl .= ', ';
- }
- $sleepImpl .= "'" . $name . "'";
- }
- $sleepImpl .= ');';
- }
- return $sleepImpl;
- }
- /** Proxy class code template */
- private static $_proxyClassTemplate =
- '<?php
- namespace <namespace>;
- /**
- * THIS CLASS WAS GENERATED BY THE DOCTRINE ODM. DO NOT EDIT THIS FILE.
- */
- class <proxyClassName> extends \<className> implements \Doctrine\ODM\MongoDB\Proxy\Proxy
- {
- public $__dm;
- public $__identifier;
- public $__isInitialized__ = false;
- public function __construct($dm, $identifier)
- {
- $this->__dm = $dm;
- $this->__identifier = $identifier;
- $this->__dm->getClassMetadata(__CLASS__)->setIdentifierValue($this, $this->__identifier);
- }
- private function load()
- {
- if ( ! $this->__isInitialized__ && $this->__dm) {
- $this->__isInitialized__ = true;
- if ($this->__dm->loadByID(get_class($this), $this->__identifier) === null) {
- throw \Doctrine\ODM\MongoDB\MongoDBException::documentNotFound(get_class($this), $this->__identifier);
- }
- unset($this->__dm);
- unset($this->__identifier);
- }
- }
- <methods>
- public function __sleep()
- {
- <sleepImpl>
- }
- }';
- }