PHP Class Drest\Mapping\Driver\AnnotationDriver

Doesn't require paths / file extensions as entities are pull from the doctrine entity manager

Inheritance: extends AbstractDriver

Protected Properties

Property	Type	Description
$classNames	array	The array of class names.
$extensions	array	Extensions of the files to read

Method	Description
__construct ( AnnotationReader $reader, $paths = [] )
addExtension ( string $extension )	Add an extension to look for classes
create ( array \| string $paths = [] ) : AnnotationDriver	Factory method for the Annotation Driver
getAllClassNames ( ) : array	Get all the metadata class names known to this driver.
isDrestResource ( string $className ) : boolean	Does the class contain a drest resource object
loadMetadataForClass ( object \| string $className ) : Drest\Mapping\ClassMetaData \| null	Load metadata for a class name
register ( )	Driver registration template method.
registerAnnotations ( )	Register out annotation classes with the annotation registry.
removeExtensions ( string $extension = null )	Remove all registered extensions, if an extension name is passed, only remove that entry

Method	Description
processMethods ( ReflectionMethod[] $methods, Drest\Mapping\ClassMetaData $metadata )	Process the method

public __construct ( AnnotationReader $reader, $paths = [] )
$reader	Doctrine\Common\Annotations\AnnotationReader

Add an extension to look for classes

public addExtension ( string $extension )
$extension	string	- can be a string or an array of extensions

Factory method for the Annotation Driver

public static create ( array \| string $paths = [] ) : AnnotationDriver
$paths	array \| string
return	AnnotationDriver

Get all the metadata class names known to this driver.

public getAllClassNames ( ) : array
return	array	$classes

Does the class contain a drest resource object

public isDrestResource ( string $className ) : boolean
$className	string
return	boolean

Load metadata for a class name

public loadMetadataForClass ( object \| string $className ) : Drest\Mapping\ClassMetaData \| null
$className	object \| string	- Pass in either the class name, or an instance of that class
return	Drest\Mapping\ClassMetaData \| null	$metaData - return null if metadata couldn't be populated from annotations

Process the method

protected processMethods ( ReflectionMethod[] $methods, Drest\Mapping\ClassMetaData $metadata )
$methods	ReflectionMethod[]
$metadata	Drest\Mapping\ClassMetaData

Driver registration template method.

public static register ( )

public static registerAnnotations ( )

Remove all registered extensions, if an extension name is passed, only remove that entry

public removeExtensions ( string $extension = null )
$extension	string

The array of class names.

protected array $classNames
return	array

Extensions of the files to read

protected array $extensions
return	array