1. class
  2. NoreSources
  3. \
  4. Persistence
  5. \
  6. Mapping
  7. \
  8. Driver
  9. \
  10. ReflectionDriver

ReflectionDriver

class ReflectionDriver implements MappingDriver (View source)

A mapping driver that use Reflection and DocComments to generate class metadata

This driver is compatible with Doctrine ORM ClassMetadata with some missing feature support.

Constants

PUBLIC_PROPERTY_AUTO_MAPPING

Map all public properties as fields
LIFECYCLE_METHOD_AUTO_MAPPING

Map method with a name corresponding to a lifecycle event as a lifecycle callback
EMBED_PARENT

Embed parent fields and associations
ASSOCIATION_TARGET_SHORT_NAME

When possible, keep short class names for association target class.

This flag is mostly used for compatibility with other Doctrine drivers.
TAG_ENTITY

TAG_FIELD

TAG_ID

TAG_MANY_TO_MANY

TAG_MANY_TO_ONE

TAG_ONE_TO_MANY

TAG_ONE_TO_ONE

TAG_OPTIONS

Field mapping options.
TAG_EXTRA

Extra field metadata that should be used for other purpose than object mapping (ex.

UI attributes).
MAPPING_FIELDS

MAPPING_ASSOCIATIONS

Properties

$docBlockTagPrefix The PHPDoc tag prefix used in PHP source files

Methods

__construct(string[] $paths, integer $flags = 0)

No description

getInflector()

No description

setInflector(Inflector $inflector)

No description

getAllClassNames()

No description

isTransient($className)

No description

loadMetadataForClass($className, $metadata)

No description

postprocessAssociationMappings($associations, $context = array())

No description

postprocessAssociationMapping($mapping, $mapFunction, $context = array())

No description

getIdentifierMapping($className, $metadata)

No description

cacheMetadataForClass($className, $metadata)

No description

getTableNameFromClassName($className)

No description

getQualifiedClassName($className, $namespace)

No description

ReflectionClass
getEventConstantsClass()

No description

static 
parseIdGeneratorType($v, ClassMetadata $metadata)

No description

setEventConstantClass(string|ReflectionClass $class)

Set the class containing the list of available events

mapFields(ClassMetadata $metadata, $mappings = [])

No description

mapAssociations(ClassMetadata $metadata, $mappings)

No description

processProperties($visited, ClassMetadata $metadata, ReflectionFile $file, ReflectionClass $reflectionClass, $defaultInstance)

No description

static 
stringToBoolean($v)

No description

static 
invertBoolean($v)

No description

static 
getClassMetadataClassConstant($metadataOrmetadataClassName, $prefix, $suffix)

No description

static void|mixed
invokeClassMetadataMethod(ClassMetadata $metadata, string $method, ... ...$arguments)

Invoke class metadata instance method only if it exists.

parseParameters($output, $text, ClassMetadata $metadata, $parametersProperties)

No description

getTargetEntityFromVariableDeclaration($variable, $file, $property, $associationTagName)

No description

static 
setSpecialGenerator(mixed $type, ClassMetadata $metadata, array $mapping)

Call generator type-specific metadata methods.

setAutomaticMapping($mapping, ReflectionFile $file, ReflectionProperty $property, ReflectionDocComment $block, $defaultInstance = null)

No description

retrievePropertyDefaultValue($value, ReflectionProperty $property, $defaultInstance = null)

No description

setDefaultAutomaticMapping($mapping, ReflectionFile $file, ReflectionProperty $property, $defaultInstance = null)

No description

setTypeAutomaticMapping(array $mapping, ReflectionFile $file, ReflectionProperty $property, array $types)

No description

resolveClassname($className, ReflectionFile $file, $namespace)

No description

isInPaths($filename)

No description

getTag(ReflectionDocComment $block, $name, $index = 0)

No description

getTags(ReflectionDocComment $block, $name)

No description

hasTag(ReflectionDocComment $block, $name)

No description

getEventParameters()

No description

static 
getEntityTagParametersDescriptor()

No description

static 
getPropertyTagParametersDescriptor()

No description

static 
getIdTagParametersDescriptor()

No description

static 
getFieldTagParametersDescriptor()

No description

static 
getAssociationTagParametersDescriptor()

No description

static 
getManyToManyTagParametersDescriptor()

No description

static 
getManyToOneTagParametersDescriptor()

No description

static 
getOneToManyTagParametersDescriptor()

No description

static 
getOneToOneTagParametersDescriptor()

No description

Details

at line 108
__construct(string[] $paths, integer $flags = 0)

Parameters

string[] $paths Class paths
integer $flags Driver flags

at line 123
getInflector()

at line 134
setInflector(Inflector $inflector)

Parameters

Inflector $inflector

at line 139
getAllClassNames()

at line 187
isTransient($className)

Parameters

$className

at line 198
loadMetadataForClass($className, $metadata)

Parameters

$className
$metadata

at line 217
protected postprocessAssociationMappings($associations, $context = array())

Parameters

$associations
$context

at line 227
protected postprocessAssociationMapping($mapping, $mapFunction, $context = array())

Parameters

$mapping
$mapFunction
$context

at line 318
protected getIdentifierMapping($className, $metadata)

Parameters

$className
$metadata

at line 337
protected cacheMetadataForClass($className, $metadata)

Parameters

$className
$metadata

at line 527
protected getTableNameFromClassName($className)

Parameters

$className

at line 533
protected getQualifiedClassName($className, $namespace)

Parameters

$className
$namespace

at line 547
protected ReflectionClass getEventConstantsClass()

Return Value

ReflectionClass

at line 557
static protected parseIdGeneratorType($v, ClassMetadata $metadata)

Parameters

$v
ClassMetadata $metadata

at line 574
protected setEventConstantClass(string|ReflectionClass $class)

Set the class containing the list of available events

Parameters

string|ReflectionClass $class

at line 579
protected mapFields(ClassMetadata $metadata, $mappings = [])

Parameters

ClassMetadata $metadata
$mappings

at line 611
protected mapAssociations(ClassMetadata $metadata, $mappings)

Parameters

ClassMetadata $metadata
$mappings

at line 624
protected processProperties($visited, ClassMetadata $metadata, ReflectionFile $file, ReflectionClass $reflectionClass, $defaultInstance)

Parameters

$visited
ClassMetadata $metadata
ReflectionFile $file
ReflectionClass $reflectionClass
$defaultInstance

at line 789
static stringToBoolean($v)

Parameters

$v

at line 794
static invertBoolean($v)

Parameters

$v

at line 799
static getClassMetadataClassConstant($metadataOrmetadataClassName, $prefix, $suffix)

Parameters

$metadataOrmetadataClassName
$prefix
$suffix

at line 827
static void|mixed invokeClassMetadataMethod(ClassMetadata $metadata, string $method, ... ...$arguments)

Invoke class metadata instance method only if it exists.

Parameters

ClassMetadata $metadata Class metadata
string $method Class metadata method name
... ...$arguments Method arguments

Return Value

void|mixed

at line 834
protected parseParameters($output, $text, ClassMetadata $metadata, $parametersProperties)

Parameters

$output
$text
ClassMetadata $metadata
$parametersProperties

at line 881
protected getTargetEntityFromVariableDeclaration($variable, $file, $property, $associationTagName)

Parameters

$variable
$file
$property
$associationTagName

at line 943
static protected setSpecialGenerator(mixed $type, ClassMetadata $metadata, array $mapping)

Call generator type-specific metadata methods.

Mostly for Doctrine ORM ClassMetadata.

Parameters

mixed $type Generator type
ClassMetadata $metadata Class metadata
array $mapping Current mapping

at line 970
protected setAutomaticMapping($mapping, ReflectionFile $file, ReflectionProperty $property, ReflectionDocComment $block, $defaultInstance = null)

Parameters

$mapping
ReflectionFile $file
ReflectionProperty $property
ReflectionDocComment $block
$defaultInstance

at line 1003
protected retrievePropertyDefaultValue($value, ReflectionProperty $property, $defaultInstance = null)

Parameters

$value
ReflectionProperty $property
$defaultInstance

at line 1027
protected setDefaultAutomaticMapping($mapping, ReflectionFile $file, ReflectionProperty $property, $defaultInstance = null)

Parameters

$mapping
ReflectionFile $file
ReflectionProperty $property
$defaultInstance

at line 1079
protected setTypeAutomaticMapping(array $mapping, ReflectionFile $file, ReflectionProperty $property, array $types)

Parameters

array $mapping Property mapping
ReflectionFile $file Class file
ReflectionProperty $property Class property
array $types List of type names from @var tag

at line 1139
protected resolveClassname($className, ReflectionFile $file, $namespace)

Parameters

$className
ReflectionFile $file
$namespace

at line 1153
protected isInPaths($filename)

Parameters

$filename

at line 1164
protected getTag(ReflectionDocComment $block, $name, $index = 0)

Parameters

ReflectionDocComment $block
$name
$index

at line 1171
protected getTags(ReflectionDocComment $block, $name)

Parameters

ReflectionDocComment $block
$name

at line 1177
protected hasTag(ReflectionDocComment $block, $name)

Parameters

ReflectionDocComment $block
$name

at line 1183
protected getEventParameters()

at line 1209
static getEntityTagParametersDescriptor()

at line 1225
static getPropertyTagParametersDescriptor()

at line 1261
static getIdTagParametersDescriptor()

at line 1278
static getFieldTagParametersDescriptor()

at line 1339
static getAssociationTagParametersDescriptor()

at line 1376
static getManyToManyTagParametersDescriptor()

at line 1381
static getManyToOneTagParametersDescriptor()

at line 1394
static getOneToManyTagParametersDescriptor()

at line 1407
static getOneToOneTagParametersDescriptor()