PHP Класс Adamgoose\Routing\Annotations\ResourceEndpoint

Наследование: implements Adamgoose\Routing\Annotations\EndpointInterface, use trait EndpointTrait
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$classMiddleware array The class level "inherited" middleware that apply to the resource.
$except array The methods that should not be included.
$middleware array This array is keyed by resource method name (index, create, etc).
$name string The name of the resource.
$names array The array of route names for the resource.
$only array The only methods that should be included.
$paths array[ResourcePath] This corresponds to a path for each applicable resource method.
$reflection ReflectionClass The ReflectionClass instance for the controller class.

Защищенные свойства (Protected)

Свойство Тип Описание
$methods array All of the resource controller methods.

Открытые методы

Метод Описание
__construct ( array $attributes = [] ) : void Create a new route definition instance.
getPaths ( ) : array[AbstractPath] Get all of the path definitions for an endpoint.
hasPaths ( ) : boolean Determine if the endpoint has any paths.
toRouteDefinition ( ) : string Transform the endpoint into a route definition.

Защищенные методы

Метод Описание
buildPaths ( ) : void Build all of the paths for the resource endpoint.
getClassMiddlewareForPath ( ResourcePath $path ) : array Get the class middleware for the given path.
getIncludedMethods ( ) : array Get the methods to be included in the resource.
getMiddleware ( ResourcePath $path ) : array Get all of the middleware for the given path.
getNames ( ResourcePath $path ) : array Get the names for the given path.
getTemplate ( ) : string Get the template for the endpoint.

Описание методов

__construct() публичный метод

Create a new route definition instance.
public __construct ( array $attributes = [] ) : void
$attributes array
Результат void

buildPaths() защищенный метод

Build all of the paths for the resource endpoint.
protected buildPaths ( ) : void
Результат void

getClassMiddlewareForPath() защищенный метод

Get the class middleware for the given path.
protected getClassMiddlewareForPath ( ResourcePath $path ) : array
$path ResourcePath
Результат array

getIncludedMethods() защищенный метод

Get the methods to be included in the resource.
protected getIncludedMethods ( ) : array
Результат array

getMiddleware() защищенный метод

This will also merge in any of the middleware applied at the route level.
protected getMiddleware ( ResourcePath $path ) : array
$path ResourcePath
Результат array

getNames() защищенный метод

Get the names for the given path.
protected getNames ( ResourcePath $path ) : array
$path ResourcePath
Результат array

getPaths() публичный метод

Get all of the path definitions for an endpoint.
public getPaths ( ) : array[AbstractPath]
Результат array[AbstractPath]

getTemplate() защищенный метод

Get the template for the endpoint.
protected getTemplate ( ) : string
Результат string

hasPaths() публичный метод

Determine if the endpoint has any paths.
public hasPaths ( ) : boolean
Результат boolean

toRouteDefinition() публичный метод

Transform the endpoint into a route definition.
public toRouteDefinition ( ) : string
Результат string

Описание свойств

$classMiddleware публичное свойство

The class level "inherited" middleware that apply to the resource.
public array $classMiddleware
Результат array

$except публичное свойство

The methods that should not be included.
public array $except
Результат array

$methods защищенное свойство

All of the resource controller methods.
protected array $methods
Результат array

$middleware публичное свойство

This array is keyed by resource method name (index, create, etc).
public array $middleware
Результат array

$name публичное свойство

The name of the resource.
public string $name
Результат string

$names публичное свойство

The array of route names for the resource.
public array $names
Результат array

$only публичное свойство

The only methods that should be included.
public array $only
Результат array

$paths публичное свойство

This corresponds to a path for each applicable resource method.
public array[ResourcePath] $paths
Результат array[ResourcePath]

$reflection публичное свойство

The ReflectionClass instance for the controller class.
public ReflectionClass $reflection
Результат ReflectionClass