PHP Interface Adamgoose\Routing\Annotations\EndpointInterface

Show file Open project: adamgoose/laravel-annotations

Public Methods

Method Description
addPath ( AbstractPath $path ) : void Add the given path definition to the endpoint.
getMethodForPath ( AbstractPath $path ) : string Get the controller method for the given endpoint path.
getPaths ( ) : array Get all of the path definitions for an endpoint.
hasPaths ( ) Determine if the endpoint has any paths.
toRouteDefinition ( ) : string Transform the endpoint into a route definition.

Method Details

addPath() public method

Add the given path definition to the endpoint.
public addPath ( AbstractPath $path ) : void
$path AbstractPath
return void

getMethodForPath() public method

Get the controller method for the given endpoint path.
public getMethodForPath ( AbstractPath $path ) : string
$path AbstractPath
return string

getPaths() public method

Get all of the path definitions for an endpoint.
public getPaths ( ) : array
return array

hasPaths() public method

Determine if the endpoint has any paths.
public hasPaths ( )

toRouteDefinition() public method

Transform the endpoint into a route definition.
public toRouteDefinition ( ) : string
return string