Compiler
class Compiler (View source)
Builder for proxy classes which are used to implement Dependency Injection and Aspect-Oriented Programming
Constants
| ORIGINAL_CLASSNAME_SUFFIX |
|
Properties
| protected CompileTimeObjectManager | $objectManager | ||
| protected PhpFrontend | $classesCache | ||
| protected ReflectionService | $reflectionService | ||
| protected array | $proxyClasses | ||
| protected array | $excludedSubPackages | Hardcoded list of Flow sub packages which must be immune proxying for security, technical or conceptual reasons. |
|
| protected int | $excludedSubPackagesLength | Length of the prefix that will be checked for exclusion of proxy building. |
|
| protected array | $storedProxyClasses | The final map of proxy classes that end up in the cache. |
Methods
Compiler constructor.
Injects the cache for storing the renamed original classes and proxy classes
Returns a proxy class object for the specified original class.
Checks if the specified class still exists in the code cache. If that is the case, it means that obviously the proxy class doesn't have to be rebuilt because otherwise the cache would have been flushed by the file monitor or some other mechanism.
Compiles the configured proxy classes and methods as static PHP code and stores it in the proxy class code cache.
No description
No description
Reads the specified class file, appends ORIGINAL_CLASSNAME_SUFFIX to its class name and stores the result in the proxy classes cache.
Removes the first opening php tag ("<?php") from the given $classCode if there is any
Render the source (string) form of a PHP Attribute.
Render the source (string) form of an Annotation instance.
Render an array value as string for an annotation.
Appends ORIGINAL_CLASSNAME_SUFFIX to the original class name
If a constructor exists, and it is private, this method will change its visibility to public in the given class code. This is only necessary in order to allow the proxy class to call its parent constructor.
No description
Replace occurrences of "self" with "static" for instantiation with new self() and function return declarations like "public function foo(): self".
Details
__construct()
Compiler constructor.
void
injectObjectManager(CompileTimeObjectManager $objectManager)
No description
void
injectClassesCache(PhpFrontend $classesCache)
Injects the cache for storing the renamed original classes and proxy classes
void
injectReflectionService(ReflectionService $reflectionService)
No description
ProxyClass|false
getProxyClass(string $fullClassName)
Returns a proxy class object for the specified original class.
If no such proxy class has been created yet by this renderer, this function will create one and register it for later use.
If the class is not proxyable, or is not a real class at all, false will be returned
bool
hasCacheEntryForClass(string $fullClassName)
Checks if the specified class still exists in the code cache. If that is the case, it means that obviously the proxy class doesn't have to be rebuilt because otherwise the cache would have been flushed by the file monitor or some other mechanism.
int
compile()
Compiles the configured proxy classes and methods as static PHP code and stores it in the proxy class code cache.
Also builds the static object container which acts as a registry for non-prototype objects during runtime.
void
emitCompiledClasses(array $classNames)
No description
string
getStoredProxyClassMap()
No description
protected void
cacheOriginalClassFileAndProxyCode(string $className, string $pathAndFilename, string $proxyClassCode)
Reads the specified class file, appends ORIGINAL_CLASSNAME_SUFFIX to its class name and stores the result in the proxy classes cache.
protected string
stripOpeningPhpTag(string $classCode)
Removes the first opening php tag ("<?php") from the given $classCode if there is any
static string
renderAttribute(ReflectionAttribute $attribute)
Render the source (string) form of a PHP Attribute.
static string
renderAnnotation(object $annotation)
Render the source (string) form of an Annotation instance.
static protected string
renderOptionArrayValueAsString(array $optionValue)
Render an array value as string for an annotation.
protected string
replaceClassName(string $classCode, string $pathAndFilename)
Appends ORIGINAL_CLASSNAME_SUFFIX to the original class name
protected string
makePrivateConstructorPublic(string $classCode, string $pathAndFilename)
If a constructor exists, and it is private, this method will change its visibility to public in the given class code. This is only necessary in order to allow the proxy class to call its parent constructor.
protected string
commentOutFinalKeywordForMethods(string $classCode, string $proxyClassCode)
No description
protected string
replaceSelfWithStatic(string $classCode)
Replace occurrences of "self" with "static" for instantiation with new self() and function return declarations like "public function foo(): self".
References to constants like "self::FOO" are not replaced.