• Home
• Neos
• Flow
• Reflection
• ReflectionService

PHP Class Neos\Flow\Reflection\ReflectionService

Reflection of classes of all active packages is triggered through the bootstrap's initializeReflectionService() method. In a development context, single classes may be re-reflected once files are modified whereas in a production context reflection is done once and successive requests read from the frozen caches for performance reasons. The list of available classes is determined by the CompiletimeObjectManager which also triggers the initial build of reflection data in this service. The invalidation of reflection cache entries is done by the CacheManager which in turn is triggered by signals sent by the file monitor. The internal representation of cache data is optimized for memory consumption and speed by using constants which have an integer value. Show file Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property	Type	Description
$annotatedClasses	array	Array of annotation classnames and the names of classes which are annotated with them
$annotationReader	Doctrine\Common\Annotations\Reader
$availableClassNames	array
$classLoader	Neos\Flow\Core\ClassLoader
$classReflectionData	array	Array with reflection information indexed by class name
$classSchemata	array<\Neos\Flow\Reflection\ClassSchema>	Schemata of all classes which can be persisted
$classSchemataRuntimeCache	Neos\Cache\Frontend\VariableFrontend
$classesByMethodAnnotations	array	Array of method annotations and the classes and methods which are annotated with them
$classesCurrentlyBeingForgotten	array	An array of class names which are currently being forgotten by forgetClass(). Acts as a safeguard against infinite loops.
$context	Neos\Flow\Core\ApplicationContext
$doctrinePhpParser	Doctrine\Common\Annotations\PhpParser	Note: Don't refer to this member directly but use getDoctrinePhpParser() to obtain an instance
$environment	Neos\Flow\Utility\Environment
$initialized	boolean
$loadFromClassSchemaRuntimeCache	boolean	In Production context, with frozen caches, this flag will be TRUE
$packageManager	Neos\Flow\Package\PackageManagerInterface
$reflectionDataCompiletimeCache	Neos\Cache\Frontend\VariableFrontend
$reflectionDataRuntimeCache	Neos\Cache\Frontend\VariableFrontend
$settings	array
$statusCache	Neos\Cache\Frontend\StringFrontend
$systemLogger	Neos\Flow\Log\SystemLoggerInterface
$updatedReflectionData	array	Array with updated reflection information (e.g. in Development context after classes have changed)
$useStatementsForClassCache	array	a cache which stores the use statements reflected for a particular class (only relevant for un-expanded "var" and "param" annotations)

Public Methods

Method	Description
buildReflectionData ( array $availableClassNames ) : void	Builds the reflection data cache during compile time.
freezePackageReflection ( string $packageKey ) : void	Stores the current reflection data related to classes of the specified package in the PrecompiledReflectionData directory for the current context.
getAllClassNames ( ) : array	Returns the names of all classes known to this reflection service.
getAllImplementationClassNamesForInterface ( string $interfaceName ) : array	Searches for and returns all class names of implementations of the given object type (interface name). If no class implementing the interface was found, an empty array is returned.
getAllSubClassNamesForClass ( string $className ) : array	Searches for and returns all names of classes inheriting the specified class.
getClassAnnotation ( string $className, string $annotationClassName ) : object	Returns the specified class annotation or NULL.
getClassAnnotations ( string $className, string $annotationClassName = null ) : array	Returns the specified class annotations or an empty array
getClassNameByObject ( object $object ) : string	Returns the class name of the given object. This is a convenience method that returns the expected class names even for proxy classes.
getClassNamesByAnnotation ( string $annotationClassName ) : array	Searches for and returns all names of classes which are tagged by the specified annotation. If no classes were found, an empty array is returned.
getClassPropertyNames ( string $className ) : array	Returns the names of all properties of the specified class
getClassSchema ( mixed $classNameOrObject ) : ClassSchema	Returns the class schema for the given class
getClassesContainingMethodsAnnotatedWith ( string $annotationClassName ) : array	Returns all class names of classes containing at least one method annotated with the given annotation class
getDefaultImplementationClassNameForInterface ( string $interfaceName ) : mixed	Searches for and returns the class name of the default implementation of the given interface name. If no class implementing the interface was found or more than one implementation was found in the package defining the interface, FALSE is returned.
getMethodAnnotation ( string $className, string $methodName, string $annotationClassName ) : object	Returns the specified method annotation or NULL.
getMethodAnnotations ( string $className, string $methodName, string $annotationClassName = null ) : array	Returns the specified method annotations or an empty array
getMethodDeclaredReturnType ( string $className, string $methodName ) : string	Returns the declared return type of a method (for PHP < 7.0 this will always return null)
getMethodParameters ( string $className, string $methodName ) : array	Returns an array of parameters of the given method. Each entry contains additional information about the parameter position, type hint etc.
getMethodTagsValues ( string $className, string $methodName ) : array	Returns all tags and their values the specified method is tagged with
getMethodsAnnotatedWith ( string $className, string $annotationClassName ) : array	Returns all names of methods of the given class that are annotated with the given annotation class
getPropertyAnnotation ( string $className, string $propertyName, string $annotationClassName ) : object	Returns the specified property annotation or NULL.
getPropertyAnnotations ( string $className, string $propertyName, string $annotationClassName = null ) : array	Returns the specified property annotations or an empty array
getPropertyNamesByAnnotation ( string $className, string $annotationClassName ) : array	Searches for and returns all names of class properties which are marked by the specified annotation. If no properties were found, an empty array is returned.
getPropertyNamesByTag ( string $className, string $tag ) : array	Searches for and returns all names of class properties which are tagged by the specified tag.
getPropertyTagValues ( string $className, string $propertyName, string $tag ) : array	Returns the values of the specified class property tag
getPropertyTagsValues ( string $className, string $propertyName ) : array	Returns all tags and their values the specified class property is tagged with
hasMethod ( string $className, string $methodName ) : boolean	Wrapper for method_exists() which tells if the given method exists.
injectClassLoader ( ClassLoader $classLoader ) : void
injectEnvironment ( Environment $environment ) : void
injectPackageManager ( Neos\Flow\Package\PackageManagerInterface $packageManager ) : void
injectSettings ( array $settings ) : void
injectSystemLogger ( Neos\Flow\Log\SystemLoggerInterface $systemLogger ) : void
isClassAbstract ( string $className ) : boolean	Tells if the specified class is abstract or not
isClassAnnotatedWith ( string $className, string $annotationClassName ) : boolean	Tells if the specified class has the given annotation
isClassFinal ( string $className ) : boolean	Tells if the specified class is final or not
isClassImplementationOf ( string $className, string $interfaceName ) : boolean	Tells if the specified class implements the given interface
isClassReflected ( string $className ) : boolean	Tells if the specified class is known to this reflection service and reflection information is available.
isClassUnconfigurable ( string $className ) : boolean	Tells if the class is unconfigurable or not
isMethodAnnotatedWith ( string $className, string $methodName, string $annotationClassName ) : boolean	Tells if the specified method has the given annotation
isMethodFinal ( string $className, string $methodName ) : boolean	Tells if the specified method is final or not
isMethodPrivate ( string $className, string $methodName ) : boolean	Tells if the specified method is private
isMethodProtected ( string $className, string $methodName ) : boolean	Tells if the specified method is protected
isMethodPublic ( string $className, string $methodName ) : boolean	Tells if the specified method is public
isMethodStatic ( string $className, string $methodName ) : boolean	Tells if the specified method is declared as static or not
isMethodTaggedWith ( string $className, string $methodName, string $tag ) : boolean	Tells if the specified method is tagged with the given tag
isPropertyAnnotatedWith ( string $className, string $propertyName, string $annotationClassName ) : boolean	Tells if the specified property has the given annotation
isPropertyPrivate ( string $className, string $propertyName ) : boolean	Tells if the specified property is private
isPropertyTaggedWith ( string $className, string $propertyName, string $tag ) : boolean	Tells if the specified class property is tagged with the given tag
reflectClassProperty ( string $className, PropertyReflection $property ) : integer
saveToCache ( ) : void	Exports the internal reflection data into the ReflectionData cache
setClassSchemataRuntimeCache ( Neos\Cache\Frontend\VariableFrontend $cache ) : void	Sets the dedicated class schema cache for runtime purposes
setReflectionDataCompiletimeCache ( Neos\Cache\Frontend\VariableFrontend $cache ) : void	Sets the compile-time data cache
setReflectionDataRuntimeCache ( Neos\Cache\Frontend\VariableFrontend $cache ) : void	Sets the runtime data cache
setStatusCache ( StringFrontend $cache ) : void	Sets the status cache
unfreezePackageReflection ( string $packageKey ) : void	Removes the precompiled reflection data of a frozen package

Protected Methods

Method	Description
addImplementedInterface ( string $className, ClassReflection $interface )
addParentClass ( string $className, ClassReflection $parentClass ) : void
addPropertiesToClassSchema ( ClassSchema $classSchema ) : void	Adds properties of the class at hand to the class schema.
buildClassSchema ( string $className ) : ClassSchema	Builds a class schema for the given class name.
buildClassSchemata ( array $classNames ) : void	Builds class schemata from classes annotated as entities or value objects
checkValueObjectRequirements ( string $className ) : void	Checks if the given class meets the requirements for a value object, i.e.
cleanClassName ( string $className ) : string	Clean a given class name from possibly prefixed backslash
completeRepositoryAssignments ( ) : void	Complete repository-to-entity assignments.
convertParameterDataToArray ( array $parametersInformation ) : array	Converts the internal, optimized data structure of parameter information into a human-friendly array with speaking indexes.
convertParameterReflectionToArray ( ParameterReflection $parameter, MethodReflection $method = null ) : array	Converts the given parameter reflection into an information array
ensureAggregateRootInheritanceChainConsistency ( ) : void	Checks whether all aggregate roots having superclasses have a repository assigned up to the tip of their hierarchy.
evaluateClassPropertyAnnotationsForSchema ( ClassSchema $classSchema, string $propertyName ) : boolean
expandType ( ClassReflection $class, string $type ) : string	Expand shortened class names in "var" and "param" annotations, taking use statements into account.
filterArrayByClassesInNamespace ( array $array, string $packageNamespace ) : array	Filter an array of entries were keys are class names by being in the given package namespace.
forgetChangedClasses ( ) : void	Checks which classes lack a cache entry and removes their reflection data accordingly.
forgetClass ( string $className ) : void	Forgets all reflection data related to the specified class
getDoctrinePhpParser ( ) : Doctrine\Common\Annotations\PhpParser	Retrieves a singleton instance of the Doctrine PhpParser
getParentClasses ( ClassReflection $class, array $parentClasses = [] ) : array	Finds all parent classes of the given class
getPrecompiledReflectionStoragePath ( ) : string	Determines the path to the precompiled reflection data.
hasFrozenCacheInProduction ( ) : boolean
initialize ( ) : void	Initialize the reflection service lazily
isTagIgnored ( string $tagName ) : boolean	Check if a specific annotation tag is configured to be ignored.
loadClassReflectionCompiletimeCache ( ) : boolean	Tries to load the reflection data from the compile time cache.
loadOrReflectClassIfNecessary ( string $className ) : void	Loads reflection data from the cache or reflects the class if needed.
log ( string $message, integer $severity = LOG_INFO, mixed $additionalData = null ) : void	Writes the given message along with the additional information into the log.
makeChildClassesAggregateRoot ( ClassSchema $classSchema ) : void	Assigns the repository of any aggregate root to all it's subclasses, unless they are aggregate root already.
prepareClassReflectionForUsage ( string $className ) : string	Initializes the ReflectionService, cleans the given class name and finally reflects the class if necessary.
produceCacheIdentifierFromClassName ( string $className ) : string	Transform backslashes to underscores to provide an valid cache identifier.
reflectClass ( string $className ) : void	Reflects the given class and stores the results in this service's properties.
reflectClassMethod ( string $className, MethodReflection $method ) : void
reflectClassMethodParameter ( string $className, MethodReflection $method, ParameterReflection $parameter ) : void
reflectEmergedClasses ( ) : void	Checks if the given class names match those which already have been reflected. If the given array contains class names not yet known to this service, these classes will be reflected.
reflectPropertyTag ( string $className, PropertyReflection $property, string $tagName, array $tagValues ) : array
saveDevelopmentData ( )	Save reflection data to cache in Development context.
saveProductionData ( )	Save reflection data to cache in Production context.
updateReflectionData ( )	Set updated reflection data to caches.

Method Details

Property Details