PHP Class Collective\Annotations\Routing\Annotations\Scanner

Inheritance: extends Collective\Annotations\AnnotationScanner
Show file Open project: laravelcollective/annotations Class Usage Examples

Public Methods

Method Description
__construct ( array $scan ) : void Create a new scanner instance.
getRouteDefinitions ( ) : string Convert the scanned annotations into route definitions.

Protected Methods

Method Description
addEndpoint ( EndpointCollection $endpoints, ReflectionClass $class, string $method, array $annotations ) : void Create a new endpoint in the collection.
getEndpointsInClass ( ReflectionClass $class, AnnotationSet $annotations ) : EndpointCollection Build the Endpoints for the given class.
getEndpointsInClasses ( Doctrine\Common\Annotations\SimpleAnnotationReader $reader ) : EndpointCollection Scan the directory and generate the route manifest.

Method Details

__construct() public method

Create a new scanner instance.
public __construct ( array $scan ) : void
$scan array
return void

addEndpoint() protected method

Create a new endpoint in the collection.
protected addEndpoint ( EndpointCollection $endpoints, ReflectionClass $class, string $method, array $annotations ) : void
$endpoints EndpointCollection
$class ReflectionClass
$method string
$annotations array
return void

getEndpointsInClass() protected method

Build the Endpoints for the given class.
protected getEndpointsInClass ( ReflectionClass $class, AnnotationSet $annotations ) : EndpointCollection
$class ReflectionClass
$annotations AnnotationSet
return EndpointCollection

getEndpointsInClasses() protected method

Scan the directory and generate the route manifest.
protected getEndpointsInClasses ( Doctrine\Common\Annotations\SimpleAnnotationReader $reader ) : EndpointCollection
$reader Doctrine\Common\Annotations\SimpleAnnotationReader
return EndpointCollection

getRouteDefinitions() public method

Convert the scanned annotations into route definitions.
public getRouteDefinitions ( ) : string
return string