Class Doctrine\Common\Proxy\ProxyGenerator

This factory is used to generate proxy classes. It builds proxies from given parameters, a template and class metadata.

Methods


					
	public

__construct(string $proxyDirectory, string $proxyNamespace)

Initializes a new instance of the <tt>ProxyFactory</tt> class that is connected to the given <tt>EntityManager</tt>.

Initializes a new instance of the ProxyFactory class that is connected to the given EntityManager.

Parameters

`$proxyDirectory`	The directory to use for the proxy classes. It must exist.
`$proxyNamespace`	The namespace to use for the proxy classes.

Throws

Doctrine\Common\Proxy\Exception\InvalidArgumentException


					
	public

setPlaceholder(string $name, string|callable $placeholder)

Sets a placeholder to be replaced in the template.

Throws

Doctrine\Common\Proxy\Exception\InvalidArgumentException


					
	public

setProxyClassTemplate(string $proxyClassTemplate)

Sets the base template used to create proxy classes.


					
	public

generateProxyClass(ClassMetadata $class, string|bool $fileName = false)

Generates a proxy class file.

Parameters

`$class`	Metadata for the original class.
`$fileName`	Filename (full path) for the generated class. If none is given, eval() is used.

Throws

`Doctrine\Common\Proxy\Exception\InvalidArgumentException`
`Doctrine\Common\Proxy\Exception\UnexpectedValueException`


					
	private

verifyClassCanBeProxied(ClassMetadata $class)

Throws

Doctrine\Common\Proxy\Exception\InvalidArgumentException


					
	private

generateProxyShortClassName(ClassMetadata $class): string

Generates the proxy short class name to be used in the template.


					
	private

generateNamespace(ClassMetadata $class): string

Generates the proxy namespace.


					
	public

generateEnumUseStatements(ClassMetadata $class): string

Enums must have a use statement when used as public property defaults.


					
	private

generateClassName(ClassMetadata $class): string

Generates the original class name.


					
	private

generateLazyPropertiesNames(ClassMetadata $class): string

Generates the array representation of lazy loaded public properties and their default values.


					
	private

generateLazyPropertiesDefaults(ClassMetadata $class): string

Generates the array representation of lazy loaded public properties names.


					
	private

generateConstructorImpl(ClassMetadata $class): string

Generates the constructor code (un-setting public lazy loaded properties, setting identifier field values).


					
	private

generateMagicGet(ClassMetadata $class): string

Generates the magic getter invoked when lazy loaded public properties are requested.


					
	private

generateMagicSet(ClassMetadata $class): string

Generates the magic setter (currently unused).


					
	private

generateMagicIsset(ClassMetadata $class): string

Generates the magic issetter invoked when lazy loaded public properties are checked against isset().


					
	private

generateSleepImpl(ClassMetadata $class): string

Generates implementation for the `__sleep` method of proxies.

Generates implementation for the __sleep method of proxies.


					
	private

generateWakeupImpl(ClassMetadata $class): string

Generates implementation for the `__wakeup` method of proxies.

Generates implementation for the __wakeup method of proxies.


					
	private

generateCloneImpl(ClassMetadata $class): string

Generates implementation for the `__clone` method of proxies.

Generates implementation for the __clone method of proxies.


					
	private

generateMethods(ClassMetadata $class): string

Generates decorated methods by picking those available in the parent class.


					
	public

getProxyFileName(class-string $className, string $baseDirectory = null): string

Generates the Proxy file name.

Parameters

$baseDirectory

Optional base directory for proxy file name generation. If not specified, the directory configured on the Configuration of the EntityManager will be used by this factory.


					
	private

isShortIdentifierGetter(ReflectionMethod $method, ClassMetadata $class): bool

Checks if the method is a short identifier getter.

What does this mean? For proxy objects the identifier is already known, however accessing the getter for this identifier usually triggers the lazy loading, leading to a query that may not be necessary if only the ID is interesting for the userland code (for example in views that generate links to the entity, but do not display anything else).


					
	private

getLazyLoadedPublicPropertiesNames(ClassMetadata $class): array<int, string>

Generates the list of public properties to be lazy loaded.


					
	private

getLazyLoadedPublicProperties(ClassMetadata $class): mixed[]

Generates the list of default values of public properties.


					
	private

buildParametersString(ReflectionParameter[] $parameters, string[] $renameParameters = []): string


					
	private

getParameterType(ReflectionParameter $parameter): string|null


					
	private

getParameterDefaultValue(ReflectionParameter $parameter): string


					
	private

getParameterNamesForInvoke(ReflectionParameter[] $parameters): string[]


					
	private

getParameterNamesForParentCall(ReflectionParameter[] $parameters): string[]


					
	private

getMethodReturnType(ReflectionMethod $method): string


					
	private

shouldProxiedMethodReturn(ReflectionMethod $method): bool


					
	private

formatType(ReflectionType $type, ReflectionMethod $method, ?ReflectionParameter $parameter = null): string

Constants
`public`	`PATTERN_MATCH_ID_METHOD = "((?(DEFINE)\n (?<type>\\\\?[a-z_\\x7f-\\xff][\\w\\x7f-\\xff](?:\\\\[a-z_\\x7f-\\xff][\\w\\x7f-\\xff]))\n (?<intersection_type>(?&type)\\s&\\s(?&type))\n (?<union_type>(?:(?:\$\\s(?&intersection_type)\\s\$)\|(?&type))(?:\\s\\\|\\s(?:(?:\$\\s(?&intersection_type)\\s\$)\|(?&type)))+)\n)(?:public\\s+)?(?:function\\s+%s\\s\$\$\\s)\\s(?::\\s(?:(?&union_type)\|(?&intersection_type)\|(?:\\??(?&type)))\\s)?{\\sreturn\\s\\$this->%s;\\s*})i"` Used to match very simple id methods that don't need to be decorated since the identifier is known. Used to match very simple id methods that don't need to be decorated since the identifier is known.	#

Properties
`private`	`string`	`$proxyNamespace`	#
`private`	`string`	`$proxyDirectory`	#
`protected`	`string[]\|callable[]`	`$placeholders = ['baseProxyInterface' => Proxy::class, 'additionalProperties' => '']`	#
`protected`	`string`	$proxyClassTemplate = '<?php namespace <namespace>; <enumUseStatements> /** * DO NOT EDIT THIS FILE - IT WAS CREATED BY DOCTRINE\'S PROXY GENERATOR / class <proxyShortClassName> extends \<className> implements \<baseProxyInterface> { /* * @var \Closure the callback responsible for loading properties in the proxy object. This callback is called with * three parameters, being respectively the proxy object to be initialized, the method that triggered the * initialization process and an array of ordered parameters that were passed to that method. * * @see \Doctrine\Common\Proxy\Proxy::__setInitializer / public $__initializer__; /* * @var \Closure the callback responsible of loading properties that need to be copied in the cloned object * * @see \Doctrine\Common\Proxy\Proxy::__setCloner / public $__cloner__; /* * @var boolean flag indicating if this object was already initialized * * @see \Doctrine\Persistence\Proxy::__isInitialized / public $__isInitialized__ = false; /* * @var array<string, null> properties to be lazy loaded, indexed by property name / public static $lazyPropertiesNames = <lazyPropertiesNames>; /* * @var array<string, mixed> default values of properties to be lazy loaded, with keys being the property names * * @see \Doctrine\Common\Proxy\Proxy::__getLazyProperties / public static $lazyPropertiesDefaults = <lazyPropertiesDefaults>; <additionalProperties> <constructorImpl> <magicGet> <magicSet> <magicIsset> <sleepImpl> <wakeupImpl> <cloneImpl> /* * Forces initialization of the proxy / public function __load(): void { $this->__initializer__ && $this->__initializer__->__invoke($this, \'__load\', []); } /* * {@inheritDoc} * @internal generated method: use only when explicitly handling proxy specific loading logic / public function __isInitialized(): bool { return $this->__isInitialized__; } /* * {@inheritDoc} * @internal generated method: use only when explicitly handling proxy specific loading logic / public function __setInitialized($initialized): void { $this->__isInitialized__ = $initialized; } /* * {@inheritDoc} * @internal generated method: use only when explicitly handling proxy specific loading logic / public function __setInitializer(\Closure $initializer = null): void { $this->__initializer__ = $initializer; } /* * {@inheritDoc} * @internal generated method: use only when explicitly handling proxy specific loading logic / public function __getInitializer(): ?\Closure { return $this->__initializer__; } /* * {@inheritDoc} * @internal generated method: use only when explicitly handling proxy specific loading logic / public function __setCloner(\Closure $cloner = null): void { $this->__cloner__ = $cloner; } /* * {@inheritDoc} * @internal generated method: use only when explicitly handling proxy specific cloning logic / public function __getCloner(): ?\Closure { return $this->__cloner__; } /* * {@inheritDoc} * @internal generated method: use only when explicitly handling proxy specific loading logic * @deprecated no longer in use - generated code now relies on internal components rather than generated public API * @static */ public function __getLazyProperties(): array { return self::$lazyPropertiesDefaults; } <methods> } '	#

Namespaces

Classes

Interfaces

Class Doctrine\Common\Proxy\ProxyGenerator

Parameters

Throws

Throws

Parameters

Throws

Throws

Parameters