‪TYPO3CMS  10.4
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
TYPO3\CMS\Extbase\Reflection\ClassSchema Class Reference

Public Member Functions

 __construct (string $className)
 
string getClassName ()
 
Property getProperty (string $propertyName)
 
array Property[] getProperties ()
 
bool isAggregateRoot ()
 
bool hasProperty (string $propertyName)
 
bool hasConstructor ()
 
Method getMethod (string $methodName)
 
array Method[] getMethods ()
 
bool isModel ()
 
bool isEntity ()
 
bool isValueObject ()
 
bool isSingleton ()
 
bool hasMethod (string $methodName)
 
bool hasInjectProperties ()
 
bool hasInjectMethods ()
 
array Method[] getInjectMethods ()
 
array Property[] getInjectProperties ()
 

Protected Member Functions

 reflectProperties (\ReflectionClass $reflectionClass)
 
 reflectMethods (\ReflectionClass $reflectionClass)
 
bool hasInjectMethodName (\ReflectionMethod $reflectionMethod)
 

Protected Attributes

string $className
 
array $properties = array( )
 

Private Member Functions

array Property[] buildPropertyObjects ()
 
array Method[] buildMethodObjects ()
 

Private Attributes

const BIT_CLASS_IS_ENTITY = 1 << 0
 
const BIT_CLASS_IS_VALUE_OBJECT = 1 << 1
 
const BIT_CLASS_IS_AGGREGATE_ROOT = 1 << 2
 
const BIT_CLASS_IS_CONTROLLER = 1 << 3
 
const BIT_CLASS_IS_SINGLETON = 1 << 4
 
const BIT_CLASS_HAS_CONSTRUCTOR = 1 << 5
 
const BIT_CLASS_HAS_INJECT_METHODS = 1 << 6
 
const BIT_CLASS_HAS_INJECT_PROPERTIES = 1 << 7
 
BitSet $bitSet
 
array $methods = array( )
 
array $injectMethods = array( )
 

Static Private Attributes

static array $propertyObjects = array( )
 
static array $methodObjects = array( )
 
static PropertyInfoExtractor $propertyInfoExtractor
 
static DocBlockFactory $docBlockFactory
 

Detailed Description

A class schema

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 54 of file ClassSchema.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Extbase\Reflection\ClassSchema::__construct ( string  $className)

Constructs this class schema

Parameters
string$className‪Name of the class this schema is referring to
Exceptions
InvalidTypeHintException
InvalidValidationConfigurationException

Definition at line 113 of file ClassSchema.php.

References TYPO3\CMS\Extbase\Reflection\ClassSchema\$className, TYPO3\CMS\Extbase\Reflection\ClassSchema\$docBlockFactory, TYPO3\CMS\Extbase\Reflection\ClassSchema\reflectMethods(), TYPO3\CMS\Extbase\Reflection\ClassSchema\reflectProperties(), and TYPO3\CMS\Core\Utility\ClassNamingUtility\translateModelNameToRepositoryName().

Member Function Documentation

◆ buildMethodObjects()

array Method [] TYPO3\CMS\Extbase\Reflection\ClassSchema::buildMethodObjects ( )
private
Returns
‪array|Method[]

Definition at line 680 of file ClassSchema.php.

References TYPO3\CMS\Extbase\Reflection\ClassSchema\$className.

Referenced by TYPO3\CMS\Extbase\Reflection\ClassSchema\getInjectMethods(), TYPO3\CMS\Extbase\Reflection\ClassSchema\getMethod(), and TYPO3\CMS\Extbase\Reflection\ClassSchema\getMethods().

◆ buildPropertyObjects()

array Property [] TYPO3\CMS\Extbase\Reflection\ClassSchema::buildPropertyObjects ( )
private
Returns
‪array|Property[]

Definition at line 665 of file ClassSchema.php.

References TYPO3\CMS\Extbase\Reflection\ClassSchema\$className.

Referenced by TYPO3\CMS\Extbase\Reflection\ClassSchema\getInjectProperties(), TYPO3\CMS\Extbase\Reflection\ClassSchema\getProperties(), and TYPO3\CMS\Extbase\Reflection\ClassSchema\getProperty().

◆ getClassName()

string TYPO3\CMS\Extbase\Reflection\ClassSchema::getClassName ( )

Returns the class name this schema is referring to

Returns
‪string The class name

Definition at line 475 of file ClassSchema.php.

References TYPO3\CMS\Extbase\Reflection\ClassSchema\$className.

Referenced by TYPO3\CMS\Extbase\Object\Container\Container\getConstructorArguments(), TYPO3\CMS\Extbase\Object\Container\Container\injectDependencies(), and TYPO3\CMS\Extbase\Object\Container\Container\instanciateObject().

◆ getInjectMethods()

array Method [] TYPO3\CMS\Extbase\Reflection\ClassSchema::getInjectMethods ( )
Returns
‪array|Method[]

Definition at line 643 of file ClassSchema.php.

References TYPO3\CMS\Extbase\Reflection\ClassSchema\buildMethodObjects(), and TYPO3\CMS\Extbase\Reflection\ClassSchema\Method\isInjectMethod().

Referenced by TYPO3\CMS\Extbase\Object\Container\Container\injectDependencies().

◆ getInjectProperties()

array Property [] TYPO3\CMS\Extbase\Reflection\ClassSchema::getInjectProperties ( )
Returns
‪array|Property[]

Definition at line 654 of file ClassSchema.php.

References TYPO3\CMS\Extbase\Reflection\ClassSchema\buildPropertyObjects(), and TYPO3\CMS\Extbase\Reflection\ClassSchema\Property\isInjectProperty().

◆ getMethod()

Method TYPO3\CMS\Extbase\Reflection\ClassSchema::getMethod ( string  $methodName)
Exceptions
NoSuchMethodException
Parameters
string$methodName
Returns
‪Method

Definition at line 541 of file ClassSchema.php.

References TYPO3\CMS\Extbase\Reflection\ClassSchema\$methods, TYPO3\CMS\Extbase\Reflection\ClassSchema\buildMethodObjects(), and TYPO3\CMS\Extbase\Reflection\ClassSchema\Exception\NoSuchMethodException\create().

Referenced by TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\MethodParameterTest\classSchemaDetectsDefaultValueParams(), TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\MethodParameterTest\classSchemaDetectsIgnoreValidationAnnotation(), TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\MethodParameterTest\classSchemaDetectsMandatoryParams(), TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\MethodParameterTest\classSchemaDetectsNullableParams(), TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\MethodParameterTest\classSchemaDetectsParamTypeFromTypeHint(), TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\MethodTest\classSchemaDetectsStaticMethods(), and TYPO3\CMS\Extbase\Object\Container\Container\getConstructorArguments().

◆ getMethods()

array Method [] TYPO3\CMS\Extbase\Reflection\ClassSchema::getMethods ( )
Returns
‪array|Method[]

Definition at line 555 of file ClassSchema.php.

References TYPO3\CMS\Extbase\Reflection\ClassSchema\buildMethodObjects().

◆ getProperties()

array Property [] TYPO3\CMS\Extbase\Reflection\ClassSchema::getProperties ( )
Returns
‪array|Property[]

Definition at line 500 of file ClassSchema.php.

References TYPO3\CMS\Extbase\Reflection\ClassSchema\buildPropertyObjects().

◆ getProperty()

Property TYPO3\CMS\Extbase\Reflection\ClassSchema::getProperty ( string  $propertyName)
Exceptions
NoSuchPropertyException
Parameters
string$propertyName
Returns
‪Property

Definition at line 486 of file ClassSchema.php.

References TYPO3\CMS\Extbase\Reflection\ClassSchema\$properties, TYPO3\CMS\Extbase\Reflection\ClassSchema\buildPropertyObjects(), and TYPO3\CMS\Extbase\Reflection\ClassSchema\Exception\NoSuchPropertyException\create().

Referenced by TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\PropertyTest\classSchemaDetectsCascadeProperty(), TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\PropertyTest\classSchemaDetectsCascadePropertyOnlyWithVarAnnotation(), TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\PropertyTest\classSchemaDetectsInjectProperty(), TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\PropertyTest\classSchemaDetectsTransientProperty(), TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\PropertyTest\classSchemaDetectsTypeAndElementType(), TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\PropertyTest\classSchemaDetectsTypeAndElementTypeWithoutFQCN(), and TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\PropertyTest\classSchemaDetectsValidateAnnotationsModelProperties().

◆ hasConstructor()

bool TYPO3\CMS\Extbase\Reflection\ClassSchema::hasConstructor ( )
Returns
‪bool

Definition at line 530 of file ClassSchema.php.

Referenced by TYPO3\CMS\Extbase\Object\Container\Container\getConstructorArguments().

◆ hasInjectMethodName()

bool TYPO3\CMS\Extbase\Reflection\ClassSchema::hasInjectMethodName ( \ReflectionMethod  $reflectionMethod)
protected
Parameters
\ReflectionMethod$reflectionMethod
Returns
‪bool

Definition at line 564 of file ClassSchema.php.

Referenced by TYPO3\CMS\Extbase\Reflection\ClassSchema\reflectMethods().

◆ hasInjectMethods()

bool TYPO3\CMS\Extbase\Reflection\ClassSchema::hasInjectMethods ( )
Returns
‪bool

Definition at line 635 of file ClassSchema.php.

Referenced by TYPO3\CMS\Extbase\Object\Container\Container\injectDependencies().

◆ hasInjectProperties()

bool TYPO3\CMS\Extbase\Reflection\ClassSchema::hasInjectProperties ( )
Returns
‪bool

Definition at line 627 of file ClassSchema.php.

Referenced by TYPO3\CMS\Extbase\Object\Container\Container\injectDependencies().

◆ hasMethod()

bool TYPO3\CMS\Extbase\Reflection\ClassSchema::hasMethod ( string  $methodName)
Parameters
string$methodName
Returns
‪bool

Definition at line 619 of file ClassSchema.php.

◆ hasProperty()

bool TYPO3\CMS\Extbase\Reflection\ClassSchema::hasProperty ( string  $propertyName)

If the class schema has a certain property.

Parameters
string$propertyName‪Name of the property
Returns
‪bool

Definition at line 522 of file ClassSchema.php.

◆ isAggregateRoot()

bool TYPO3\CMS\Extbase\Reflection\ClassSchema::isAggregateRoot ( )

Whether the class is an aggregate root and therefore accessible through a repository.

Returns
‪bool TRUE if it is managed

Definition at line 511 of file ClassSchema.php.

◆ isEntity()

bool TYPO3\CMS\Extbase\Reflection\ClassSchema::isEntity ( )
Returns
‪bool

Definition at line 593 of file ClassSchema.php.

Referenced by TYPO3\CMS\Extbase\Reflection\ClassSchema\isModel().

◆ isModel()

bool TYPO3\CMS\Extbase\Reflection\ClassSchema::isModel ( )
Returns
‪bool

Definition at line 584 of file ClassSchema.php.

References TYPO3\CMS\Extbase\Reflection\ClassSchema\isEntity(), and TYPO3\CMS\Extbase\Reflection\ClassSchema\isValueObject().

◆ isSingleton()

bool TYPO3\CMS\Extbase\Reflection\ClassSchema::isSingleton ( )
Returns
‪bool

Definition at line 610 of file ClassSchema.php.

Referenced by TYPO3\CMS\Extbase\Object\Container\Container\getConstructorArguments(), TYPO3\CMS\Extbase\Object\Container\Container\getInstanceInternal(), TYPO3\CMS\Extbase\Object\Container\Container\injectDependencies(), and TYPO3\CMS\Extbase\Object\Container\Container\instanciateObject().

◆ isValueObject()

bool TYPO3\CMS\Extbase\Reflection\ClassSchema::isValueObject ( )
Returns
‪bool

Definition at line 602 of file ClassSchema.php.

Referenced by TYPO3\CMS\Extbase\Reflection\ClassSchema\isModel().

◆ reflectMethods()

TYPO3\CMS\Extbase\Reflection\ClassSchema::reflectMethods ( \ReflectionClass  $reflectionClass)
protected
Parameters
\ReflectionClass$reflectionClass
Exceptions
InvalidTypeHintException
InvalidValidationConfigurationException

Definition at line 289 of file ClassSchema.php.

References TYPO3\CMS\Core\Utility\StringUtility\endsWith(), TYPO3\CMS\Extbase\Reflection\ClassSchema\hasInjectMethodName(), and TYPO3\CMS\Extbase\Validation\ValidatorClassNameResolver\resolve().

Referenced by TYPO3\CMS\Extbase\Reflection\ClassSchema\__construct().

◆ reflectProperties()

TYPO3\CMS\Extbase\Reflection\ClassSchema::reflectProperties ( \ReflectionClass  $reflectionClass)
protected
Parameters
\ReflectionClass$reflectionClass
Exceptions

Definition at line 184 of file ClassSchema.php.

References TYPO3\CMS\Extbase\Reflection\ClassSchema\PropertyCharacteristics\ANNOTATED_INJECT, TYPO3\CMS\Extbase\Reflection\ClassSchema\PropertyCharacteristics\ANNOTATED_LAZY, TYPO3\CMS\Extbase\Reflection\ClassSchema\PropertyCharacteristics\ANNOTATED_TRANSIENT, TYPO3\CMS\Extbase\Reflection\ClassSchema\PropertyCharacteristics\IS_STATIC, TYPO3\CMS\Extbase\Validation\ValidatorClassNameResolver\resolve(), TYPO3\CMS\Extbase\Reflection\ClassSchema\PropertyCharacteristics\VISIBILITY_PRIVATE, TYPO3\CMS\Extbase\Reflection\ClassSchema\PropertyCharacteristics\VISIBILITY_PROTECTED, and TYPO3\CMS\Extbase\Reflection\ClassSchema\PropertyCharacteristics\VISIBILITY_PUBLIC.

Referenced by TYPO3\CMS\Extbase\Reflection\ClassSchema\__construct().

Member Data Documentation

◆ $bitSet

BitSet TYPO3\CMS\Extbase\Reflection\ClassSchema::$bitSet
private

Definition at line 67 of file ClassSchema.php.

◆ $className

string TYPO3\CMS\Extbase\Reflection\ClassSchema::$className
protected

Name of the class this schema is referring to

Definition at line 81 of file ClassSchema.php.

Referenced by TYPO3\CMS\Extbase\Reflection\ClassSchema\__construct(), TYPO3\CMS\Extbase\Reflection\ClassSchema\buildMethodObjects(), TYPO3\CMS\Extbase\Reflection\ClassSchema\buildPropertyObjects(), TYPO3\CMS\Extbase\Reflection\ClassSchema\Exception\NoSuchPropertyException\create(), TYPO3\CMS\Extbase\Reflection\ClassSchema\Exception\NoSuchMethodException\create(), TYPO3\CMS\Extbase\Reflection\ClassSchema\Exception\NoSuchMethodParameterException\createForParameterName(), TYPO3\CMS\Extbase\Reflection\ClassSchema\Exception\NoSuchMethodParameterException\createForParameterPosition(), and TYPO3\CMS\Extbase\Reflection\ClassSchema\getClassName().

◆ $docBlockFactory

DocBlockFactory TYPO3\CMS\Extbase\Reflection\ClassSchema::$docBlockFactory
staticprivate

Definition at line 103 of file ClassSchema.php.

Referenced by TYPO3\CMS\Extbase\Reflection\ClassSchema\__construct().

◆ $injectMethods

array TYPO3\CMS\Extbase\Reflection\ClassSchema::$injectMethods = array( )
private

Definition at line 95 of file ClassSchema.php.

Referenced by TYPO3\CMS\Extbase\Tests\Unit\Reflection\ClassSchema\MethodTest\classSchemaDetectsInjectMethods().

◆ $methodObjects

array TYPO3\CMS\Extbase\Reflection\ClassSchema::$methodObjects = array( )
staticprivate

Definition at line 75 of file ClassSchema.php.

◆ $methods

array TYPO3\CMS\Extbase\Reflection\ClassSchema::$methods = array( )
private

Definition at line 91 of file ClassSchema.php.

Referenced by TYPO3\CMS\Extbase\Reflection\ClassSchema\getMethod().

◆ $properties

array TYPO3\CMS\Extbase\Reflection\ClassSchema::$properties = array( )
protected

Properties of the class which need to be persisted

Definition at line 87 of file ClassSchema.php.

Referenced by TYPO3\CMS\Extbase\Reflection\ClassSchema\getProperty().

◆ $propertyInfoExtractor

PropertyInfoExtractor TYPO3\CMS\Extbase\Reflection\ClassSchema::$propertyInfoExtractor
staticprivate

Definition at line 99 of file ClassSchema.php.

◆ $propertyObjects

array TYPO3\CMS\Extbase\Reflection\ClassSchema::$propertyObjects = array( )
staticprivate

Definition at line 71 of file ClassSchema.php.

◆ BIT_CLASS_HAS_CONSTRUCTOR

const TYPO3\CMS\Extbase\Reflection\ClassSchema::BIT_CLASS_HAS_CONSTRUCTOR = 1 << 5
private

Definition at line 61 of file ClassSchema.php.

◆ BIT_CLASS_HAS_INJECT_METHODS

const TYPO3\CMS\Extbase\Reflection\ClassSchema::BIT_CLASS_HAS_INJECT_METHODS = 1 << 6
private

Definition at line 62 of file ClassSchema.php.

◆ BIT_CLASS_HAS_INJECT_PROPERTIES

const TYPO3\CMS\Extbase\Reflection\ClassSchema::BIT_CLASS_HAS_INJECT_PROPERTIES = 1 << 7
private

Definition at line 63 of file ClassSchema.php.

◆ BIT_CLASS_IS_AGGREGATE_ROOT

const TYPO3\CMS\Extbase\Reflection\ClassSchema::BIT_CLASS_IS_AGGREGATE_ROOT = 1 << 2
private

Definition at line 58 of file ClassSchema.php.

◆ BIT_CLASS_IS_CONTROLLER

const TYPO3\CMS\Extbase\Reflection\ClassSchema::BIT_CLASS_IS_CONTROLLER = 1 << 3
private

Definition at line 59 of file ClassSchema.php.

◆ BIT_CLASS_IS_ENTITY

const TYPO3\CMS\Extbase\Reflection\ClassSchema::BIT_CLASS_IS_ENTITY = 1 << 0
private

Definition at line 56 of file ClassSchema.php.

◆ BIT_CLASS_IS_SINGLETON

const TYPO3\CMS\Extbase\Reflection\ClassSchema::BIT_CLASS_IS_SINGLETON = 1 << 4
private

Definition at line 60 of file ClassSchema.php.

◆ BIT_CLASS_IS_VALUE_OBJECT

const TYPO3\CMS\Extbase\Reflection\ClassSchema::BIT_CLASS_IS_VALUE_OBJECT = 1 << 1
private

Definition at line 57 of file ClassSchema.php.