RetailCRM-Mirror/doctrine2
1
0
Fork 0
mirror of synced 2025-04-03 13:23:37 +03:00
Code Issues Projects Releases Wiki Activity

Fixed documentation for ORM\Proxy

Browse source
This commit is contained in:
Benjamin Morel 2012-12-13 10:28:55 +00:00
parent 43b301f22b
commit 42e83a2716
4 changed files with 93 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
lib/Doctrine/ORM/Proxy/Autoloader.php
View file

@ -27,7 +27,7 @@ namespace Doctrine\ORM\Proxy;
class Autoloader class Autoloader
{ {
/** /**
* Resolve proxy class name to a filename based on the following pattern. * Resolves proxy class name to a filename based on the following pattern.
* *
* 1. Remove Proxy namespace from class name * 1. Remove Proxy namespace from class name
* 2. Remove namespace seperators from remaining class name. * 2. Remove namespace seperators from remaining class name.
@ -36,7 +36,10 @@ class Autoloader
* @param string $proxyDir * @param string $proxyDir
* @param string $proxyNamespace * @param string $proxyNamespace
* @param string $className * @param string $className
*
* @return string * @return string
*
* @throws ProxyException
*/ */
static public function resolveFile($proxyDir, $proxyNamespace, $className) static public function resolveFile($proxyDir, $proxyNamespace, $className)
{ {
@ -49,13 +52,14 @@ class Autoloader
} }
/** /**
* Register and return autoloader callback for the given proxy dir and * Registers and returns autoloader callback for the given proxy dir and
* namespace. * namespace.
* *
* @param string $proxyDir * @param string $proxyDir
* @param string $proxyNamespace * @param string $proxyNamespace
* @param Closure $notFoundCallback Invoked when the proxy file is not found. * @param \Closure $notFoundCallback Invoked when the proxy file is not found.
* @return Closure *
* @return \Closure
*/ */
static public function register($proxyDir, $proxyNamespace, \Closure $notFoundCallback = null) static public function register($proxyDir, $proxyNamespace, \Closure $notFoundCallback = null)
{ {
@ -75,4 +79,3 @@ class Autoloader
return $autoloader; return $autoloader;
} }
} }

4
lib/Doctrine/ORM/Proxy/Proxy.php
View file

@ -27,4 +27,6 @@ use Doctrine\Common\Persistence\Proxy as BaseProxy;
* @author Roman Borschel <roman@code-factory.org> * @author Roman Borschel <roman@code-factory.org>
* @since 2.0 * @since 2.0
*/ */
interface Proxy extends BaseProxy {} interface Proxy extends BaseProxy
{
}

31
lib/Doctrine/ORM/Proxy/ProxyException.php
View file

@ -20,27 +20,45 @@
namespace Doctrine\ORM\Proxy; namespace Doctrine\ORM\Proxy;
/** /**
* ORM Proxy Exception * ORM Proxy Exception.
* *
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.doctrine-project.com * @link www.doctrine-project.com
* @since 1.0 * @since 1.0
* @author Benjamin Eberlei <kontakt@beberlei.de> * @author Benjamin Eberlei <kontakt@beberlei.de>
*/ */
class ProxyException extends \Doctrine\ORM\ORMException { class ProxyException extends \Doctrine\ORM\ORMException
{
public static function proxyDirectoryRequired() { /**
* @return ProxyException
*/
public static function proxyDirectoryRequired()
{
return new self("You must configure a proxy directory. See docs for details"); return new self("You must configure a proxy directory. See docs for details");
} }
public static function proxyDirectoryNotWritable() { /**
* @return ProxyException
*/
public static function proxyDirectoryNotWritable()
{
return new self("Your proxy directory must be writable."); return new self("Your proxy directory must be writable.");
} }
public static function proxyNamespaceRequired() { /**
* @return ProxyException
*/
public static function proxyNamespaceRequired()
{
return new self("You must configure a proxy namespace. See docs for details"); return new self("You must configure a proxy namespace. See docs for details");
} }
/**
* @param $className
* @param $proxyNamespace
*
* @return ProxyException
*/
public static function notProxyClass($className, $proxyNamespace) public static function notProxyClass($className, $proxyNamespace)
{ {
return new self(sprintf( return new self(sprintf(
@ -48,5 +66,4 @@ class ProxyException extends \Doctrine\ORM\ORMException {
$className, $proxyNamespace $className, $proxyNamespace
)); ));
} }
} }

82
lib/Doctrine/ORM/Proxy/ProxyFactory.php
View file

@ -32,13 +32,32 @@ use Doctrine\Common\Util\ClassUtils;
*/ */
class ProxyFactory class ProxyFactory
{ {
/** The EntityManager this factory is bound to. */ /**
* The EntityManager this factory is bound to.
*
* @var \Doctrine\ORM\EntityManager
*/
private $_em; private $_em;
/** Whether to automatically (re)generate proxy classes. */
/**
* Whether to automatically (re)generate proxy classes.
*
* @var bool
*/
private $_autoGenerate; private $_autoGenerate;
/** The namespace that contains all proxy classes. */
/**
* The namespace that contains all proxy classes.
*
* @var string
*/
private $_proxyNamespace; private $_proxyNamespace;
/** The directory that contains all proxy classes. */
/**
* The directory that contains all proxy classes.
*
* @var string
*/
private $_proxyDir; private $_proxyDir;
/** /**
@ -53,10 +72,12 @@ class ProxyFactory
* Initializes a new instance of the <tt>ProxyFactory</tt> class that is * Initializes a new instance of the <tt>ProxyFactory</tt> class that is
* connected to the given <tt>EntityManager</tt>. * connected to the given <tt>EntityManager</tt>.
* *
* @param EntityManager $em The EntityManager the new factory works for. * @param EntityManager $em The EntityManager the new factory works for.
* @param string $proxyDir The directory to use for the proxy classes. It must exist. * @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 string $proxyNs The namespace to use for the proxy classes.
* @param boolean $autoGenerate Whether to automatically generate proxy classes. * @param boolean $autoGenerate Whether to automatically generate proxy classes.
*
* @throws ProxyException
*/ */
public function __construct(EntityManager $em, $proxyDir, $proxyNs, $autoGenerate = false) public function __construct(EntityManager $em, $proxyDir, $proxyNs, $autoGenerate = false)
{ {
@ -77,7 +98,8 @@ class ProxyFactory
* the given identifier. * the given identifier.
* *
* @param string $className * @param string $className
* @param mixed $identifier * @param mixed $identifier
*
* @return object * @return object
*/ */
public function getProxy($className, $identifier) public function getProxy($className, $identifier)
@ -98,12 +120,12 @@ class ProxyFactory
} }
/** /**
* Generate the Proxy file name * Generates the Proxy file name.
* *
* @param string $className * @param string $className
* @param string $baseDir Optional base directory for proxy file name generation. * @param string|null $baseDir Optional base directory for proxy file name generation.
* If not specified, the directory configured on the Configuration of the * If not specified, the directory configured on the Configuration of the
* EntityManager will be used by this factory. * EntityManager will be used by this factory.
* @return string * @return string
*/ */
private function getProxyFileName($className, $baseDir = null) private function getProxyFileName($className, $baseDir = null)
@ -116,10 +138,11 @@ class ProxyFactory
/** /**
* Generates proxy classes for all given classes. * Generates proxy classes for all given classes.
* *
* @param array $classes The classes (ClassMetadata instances) for which to generate proxies. * @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 * @param string|null $toDir The target directory of the proxy classes. If not specified, the
* directory configured on the Configuration of the EntityManager used * directory configured on the Configuration of the EntityManager used
* by this factory is used. * by this factory is used.
*
* @return int Number of generated proxies. * @return int Number of generated proxies.
*/ */
public function generateProxyClasses(array $classes, $toDir = null) public function generateProxyClasses(array $classes, $toDir = null)
@ -146,9 +169,13 @@ class ProxyFactory
/** /**
* Generates a proxy class file. * Generates a proxy class file.
* *
* @param ClassMetadata $class Metadata for the original class * @param ClassMetadata $class Metadata for the original class.
* @param string $fileName Filename (full path) for the generated class * @param string $fileName Filename (full path) for the generated class.
* @param string $file The proxy class template data * @param string $file The proxy class template data.
*
* @return void
*
* @throws ProxyException
*/ */
private function _generateProxyClass(ClassMetadata $class, $fileName, $file) private function _generateProxyClass(ClassMetadata $class, $fileName, $file)
{ {
@ -198,6 +225,7 @@ class ProxyFactory
* Generates the methods of a proxy class. * Generates the methods of a proxy class.
* *
* @param ClassMetadata $class * @param ClassMetadata $class
*
* @return string The code of the generated methods. * @return string The code of the generated methods.
*/ */
private function _generateMethods(ClassMetadata $class) private function _generateMethods(ClassMetadata $class)
@ -206,7 +234,7 @@ class ProxyFactory
$methodNames = array(); $methodNames = array();
foreach ($class->reflClass->getMethods() as $method) { foreach ($class->reflClass->getMethods() as $method) {
/* @var $method ReflectionMethod */ /* @var $method \ReflectionMethod */
if ($method->isConstructor() || in_array(strtolower($method->getName()), array("__sleep", "__clone")) || isset($methodNames[$method->getName()])) { if ($method->isConstructor() || in_array(strtolower($method->getName()), array("__sleep", "__clone")) || isset($methodNames[$method->getName()])) {
continue; continue;
} }
@ -269,7 +297,7 @@ class ProxyFactory
} }
/** /**
* Check if the method is a short identifier getter. * Checks if the method is a short identifier getter.
* *
* What does this mean? For proxy objects the identifier is already known, * What does this mean? For proxy objects the identifier is already known,
* however accessing the getter for this identifier usually triggers the * however accessing the getter for this identifier usually triggers the
@ -277,8 +305,9 @@ class ProxyFactory
* ID is interesting for the userland code (for example in views that * ID is interesting for the userland code (for example in views that
* generate links to the entity, but do not display anything else). * generate links to the entity, but do not display anything else).
* *
* @param ReflectionMethod $method * @param \ReflectionMethod $method
* @param ClassMetadata $class * @param ClassMetadata $class
*
* @return bool * @return bool
*/ */
private function isShortIdentifierGetter($method, ClassMetadata $class) private function isShortIdentifierGetter($method, ClassMetadata $class)
@ -309,7 +338,8 @@ class ProxyFactory
/** /**
* Generates the code for the __sleep method for a proxy class. * Generates the code for the __sleep method for a proxy class.
* *
* @param $class * @param ClassMetadata $class
*
* @return string * @return string
*/ */
private function _generateSleep(ClassMetadata $class) private function _generateSleep(ClassMetadata $class)