class BreadcrumbListener extends MappedEventSubscriber

Class BreadcrumbListener is injected as empire_breadcrumb.listener service. BreadcrumbListener is listener class for handling a logic for creating breadcrumb

Properties

static protected array $configurations Static List of cached object configurations leaving it static for reasons to look into other listener configuration from MappedEventSubscriber
protected string $name Listener name, etc: breadcrumable from MappedEventSubscriber

Methods

__construct()

Constructor

array
getConfiguration(ObjectManager $objectManager, string $class)

Get the configuration for specific object class if cache driver is present it scans it also

getExtensionMetadataFactory(ObjectManager $objectManager)

Get extended metadata mapping reader

setAnnotationReader(Reader $reader)

Set annotation reader class since older doctrine versions do not provide an interface it must provide these methods: getClassAnnotations([reflectionClass]) getClassAnnotation([reflectionClass], [name]) getPropertyAnnotations([reflectionProperty]) getPropertyAnnotation([reflectionProperty], [name])

void
loadMetadataForObjectClass(ObjectManager $objectManager, object $metadata)

Scans the objects for extended annotations event subscribers must subscribe to loadClassMetadata event

string
getNamespace()

Get the namespace of extension event subscriber.

ORM
getEventAdapter(EventArgs $args)

Get an event adapter to handle event specific methods

array
getSubscribedEvents()

Specifies the list of events to listen

void
prePersist(EventArgs $args)

Allows identifier fields to be breadcrumbed as usual

void
onFlush(EventArgs $args)

Generate breadcrumb on objects being updated during flush if they require changing

void
loadClassMetadata(EventArgs $eventArgs)

Mapps additional metadata

Details

in MappedEventSubscriber at line 69
__construct()

Constructor

in MappedEventSubscriber at line 85
array getConfiguration(ObjectManager $objectManager, string $class)

Get the configuration for specific object class if cache driver is present it scans it also

Parameters

ObjectManager $objectManager
string $class

Return Value

array

Exceptions

AnnotationException

in MappedEventSubscriber at line 125
ExtensionMetadataFactory getExtensionMetadataFactory(ObjectManager $objectManager)

Get extended metadata mapping reader

Parameters

ObjectManager $objectManager

Return Value

ExtensionMetadataFactory

Exceptions

AnnotationException

in MappedEventSubscriber at line 154
setAnnotationReader(Reader $reader)

Set annotation reader class since older doctrine versions do not provide an interface it must provide these methods: getClassAnnotations([reflectionClass]) getClassAnnotation([reflectionClass], [name]) getPropertyAnnotations([reflectionProperty]) getPropertyAnnotation([reflectionProperty], [name])

Parameters

Reader $reader
  • annotation reader class

in MappedEventSubscriber at line 169
void loadMetadataForObjectClass(ObjectManager $objectManager, object $metadata)

Scans the objects for extended annotations event subscribers must subscribe to loadClassMetadata event

Parameters

ObjectManager $objectManager
object $metadata

Return Value

void

Exceptions

AnnotationException

at line 150
protected string getNamespace()

Get the namespace of extension event subscriber.

used for cache id of extensions also to know where to find Mapping drivers and event adapters

Return Value

string

in MappedEventSubscriber at line 200
protected ORM getEventAdapter(EventArgs $args)

Get an event adapter to handle event specific methods

Parameters

EventArgs $args

Return Value

ORM

at line 52
array getSubscribedEvents()

Specifies the list of events to listen

Return Value

array

at line 68
void prePersist(EventArgs $args)

Allows identifier fields to be breadcrumbed as usual

Parameters

EventArgs $args

Return Value

void

at line 95
void onFlush(EventArgs $args)

Generate breadcrumb on objects being updated during flush if they require changing

Parameters

EventArgs $args

Return Value

void

Exceptions

MappingException
AnnotationException

at line 137
void loadClassMetadata(EventArgs $eventArgs)

Mapps additional metadata

Parameters

EventArgs $eventArgs

Return Value

void