class BreadcrumbAnnotation extends AbstractAnnotationDriver

Constants

BREADCRUMB

Annotation to identify field as one which holds the breadcrumb together with breadcrumb options

HANDLER

BreadcrumbHandler extension annotation

HANDLER_OPTION

BreadcrumbHandler option annotation

Properties

protected object $reader Annotation reader instance from AbstractAnnotationDriver
protected $_originalDriver Original driver if it is available from AbstractAnnotationDriver
protected array $validTypes List of types which are valid for breadcrumb fields

Methods

setAnnotationReader(object $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])

setOriginalDriver(object $driver)

Passes in the mapping read by original driver

validateFullMetadata(ClassMetadata $meta, array $config)

No description

string
getRelatedClassName(ClassMetadata $metadata, string $name)

Try to find out related class name out of mapping

boolean
isValidField(object $meta, string $field)

Checks if $field type is valid

readExtendedMetadata($meta, array $config)

{@inheritDoc}

Details

setAnnotationReader(object $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

object $reader
  • annotation reader class

setOriginalDriver(object $driver)

Passes in the mapping read by original driver

Parameters

object $driver

ReflectionClass getMetaReflectionClass(object $meta)

Parameters

object $meta

Return Value

ReflectionClass

Exceptions

ReflectionException

validateFullMetadata(ClassMetadata $meta, array $config)

Parameters

ClassMetadata $meta
array $config

protected string getRelatedClassName(ClassMetadata $metadata, string $name)

Try to find out related class name out of mapping

Parameters

ClassMetadata $metadata
  • the mapped class metadata
string $name
  • the related object class name

Return Value

string
  • related class name or empty string if does not exist

protected boolean isValidField(object $meta, string $field)

Checks if $field type is valid

Parameters

object $meta
string $field

Return Value

boolean

at line 54
readExtendedMetadata($meta, array $config)

{@inheritDoc}

Parameters

$meta
array $config