PHP Класс Dingo\Api\Routing\Route

Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$action array Array of route action attributes.
$adapter Dingo\Api\Contract\Routing\Adapter Routing adapter instance.
$authenticationProviders array Array of authentication providers.
$conditionalRequest boolean Indicates if the request is conditional.
$container Illuminate\Container\Container Container instance.
$controller object Controller instance.
$controllerClass string Controller class name.
$controllerMethod string Controller method name.
$methods array Array of HTTP methods.
$middleware array Middleware applied to route.
$rateExpiration integer The expiration time for any rate limit set on this rate.
$rateLimit integer The rate limit for this route.
$route
$scopes array Array of scopes for OAuth 2.0 authentication.
$throttle The throttle used by the route, takes precedence over rate limits.
$uri string Route URI.
$versions array Array of versions this route will respond to.

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

Метод Описание
__construct ( Dingo\Api\Contract\Routing\Adapter $adapter, Illuminate\Container\Container $container, Illuminate\Http\Request $request, array | Illuminate\Routing\Route $route ) : void Create a new route instance.
authenticationProviders ( ) : array Get the route authentication providers.
domain ( ) : string | null Get the domain defined for the route.
getAction ( ) : array Get the route action.
getActionName ( ) : string Get the action name for the route.
getAuthenticationProviders ( ) : array Get the route authentication providers.
getControllerInstance ( ) : null | Illuminate\Routing\Controller | Laravel\Lumen\Routing\Controller Get the routes controller instance.
getMethods ( ) : array Get the HTTP verbs the route responds to.
getMiddleware ( ) : array Get the middleware for this route.
getName ( ) : string Get the name of the route.
getOriginalRoute ( ) : array | Illuminate\Routing\Route Get the original route.
getPath ( ) : string Get the URI associated with the route.
getRateLimit ( ) : integer Get the rate limit for this route.
getRateLimitExpiration ( ) : integer Get the rate limit expiration time for this route.
getScopes ( ) : array Get the route scopes.
getThrottle ( ) : string | Dingo\Api\Http\RateLimit\Throttle\Throttle Get the route throttle.
getVersions ( ) : array Get the versions for the route.
hasThrottle ( ) : boolean Determine if the route has a throttle.
httpOnly ( ) : boolean Determine if the route only responds to HTTP requests.
httpsOnly ( ) : boolean Determine if the route only responds to HTTPS requests.
isProtected ( ) : boolean Determine if the route is protected.
methods ( ) : array Get the HTTP verbs the route responds to.
middleware ( ) : array Get the middleware for this route.
rateLimit ( ) : integer Get the rate limit for this route.
rateLimitExpiration ( ) : integer Get the rate limit expiration time for this route.
requestIsConditional ( ) : boolean Determine if the request is conditional.
scopeStrict ( ) : boolean Check if route requires all scopes or any scope to be valid.
scopes ( ) : array Get the route scopes.
secure ( ) : boolean Determine if the route only responds to HTTPS requests.
throttle ( ) : string | Dingo\Api\Http\RateLimit\Throttle\Throttle Get the route throttle.
uri ( ) : string Get the URI associated with the route.
versions ( ) : array Get the versions for the route.

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

Метод Описание
controllerUsesHelpersTrait ( ) : boolean Determine if the controller instance uses the helpers trait.
explodeOnPipes ( string | array $value ) : array Explode a value on a pipe delimiter.
findControllerPropertyOptions ( string $name ) : array Find the controller options and whether or not it will apply to this routes controller method.
makeControllerInstance ( ) : Illuminate\Routing\Controller | Laravel\Lumen\Routing\Controller Make a new controller instance through the container.
mergeControllerProperties ( ) Merge the controller properties onto the route properties.
optionsApplyToControllerMethod ( array $options ) : boolean Determine if a controller method is in an array of options.
setupRouteProperties ( Illuminate\Http\Request $request, $route ) Setup the route properties.

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

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

Create a new route instance.
public __construct ( Dingo\Api\Contract\Routing\Adapter $adapter, Illuminate\Container\Container $container, Illuminate\Http\Request $request, array | Illuminate\Routing\Route $route ) : void
$adapter Dingo\Api\Contract\Routing\Adapter
$container Illuminate\Container\Container
$request Illuminate\Http\Request
$route array | Illuminate\Routing\Route
Результат void

authenticationProviders() публичный Метод

Get the route authentication providers.
public authenticationProviders ( ) : array
Результат array

controllerUsesHelpersTrait() защищенный Метод

Determine if the controller instance uses the helpers trait.
protected controllerUsesHelpersTrait ( ) : boolean
Результат boolean

domain() публичный Метод

Get the domain defined for the route.
public domain ( ) : string | null
Результат string | null

explodeOnPipes() защищенный Метод

Explode a value on a pipe delimiter.
protected explodeOnPipes ( string | array $value ) : array
$value string | array
Результат array

findControllerPropertyOptions() защищенный Метод

Find the controller options and whether or not it will apply to this routes controller method.
protected findControllerPropertyOptions ( string $name ) : array
$name string
Результат array

getAction() публичный Метод

Get the route action.
public getAction ( ) : array
Результат array

getActionName() публичный Метод

Get the action name for the route.
public getActionName ( ) : string
Результат string

getAuthenticationProviders() публичный Метод

Get the route authentication providers.
public getAuthenticationProviders ( ) : array
Результат array

getControllerInstance() публичный Метод

Get the routes controller instance.
public getControllerInstance ( ) : null | Illuminate\Routing\Controller | Laravel\Lumen\Routing\Controller
Результат null | Illuminate\Routing\Controller | Laravel\Lumen\Routing\Controller

getMethods() публичный Метод

Get the HTTP verbs the route responds to.
public getMethods ( ) : array
Результат array

getMiddleware() публичный Метод

Get the middleware for this route.
public getMiddleware ( ) : array
Результат array

getName() публичный Метод

Get the name of the route.
public getName ( ) : string
Результат string

getOriginalRoute() публичный Метод

Get the original route.
public getOriginalRoute ( ) : array | Illuminate\Routing\Route
Результат array | Illuminate\Routing\Route

getPath() публичный Метод

Get the URI associated with the route.
public getPath ( ) : string
Результат string

getRateLimit() публичный Метод

Get the rate limit for this route.
public getRateLimit ( ) : integer
Результат integer

getRateLimitExpiration() публичный Метод

Get the rate limit expiration time for this route.
public getRateLimitExpiration ( ) : integer
Результат integer

getScopes() публичный Метод

Get the route scopes.
public getScopes ( ) : array
Результат array

getThrottle() публичный Метод

Get the route throttle.
public getThrottle ( ) : string | Dingo\Api\Http\RateLimit\Throttle\Throttle
Результат string | Dingo\Api\Http\RateLimit\Throttle\Throttle

getVersions() публичный Метод

Get the versions for the route.
public getVersions ( ) : array
Результат array

hasThrottle() публичный Метод

Determine if the route has a throttle.
public hasThrottle ( ) : boolean
Результат boolean

httpOnly() публичный Метод

Determine if the route only responds to HTTP requests.
public httpOnly ( ) : boolean
Результат boolean

httpsOnly() публичный Метод

Determine if the route only responds to HTTPS requests.
public httpsOnly ( ) : boolean
Результат boolean

isProtected() публичный Метод

Determine if the route is protected.
public isProtected ( ) : boolean
Результат boolean

makeControllerInstance() защищенный Метод

Make a new controller instance through the container.
protected makeControllerInstance ( ) : Illuminate\Routing\Controller | Laravel\Lumen\Routing\Controller
Результат Illuminate\Routing\Controller | Laravel\Lumen\Routing\Controller

mergeControllerProperties() защищенный Метод

Merge the controller properties onto the route properties.

methods() публичный Метод

Get the HTTP verbs the route responds to.
public methods ( ) : array
Результат array

middleware() публичный Метод

Get the middleware for this route.
public middleware ( ) : array
Результат array

optionsApplyToControllerMethod() защищенный Метод

Determine if a controller method is in an array of options.
protected optionsApplyToControllerMethod ( array $options ) : boolean
$options array
Результат boolean

rateLimit() публичный Метод

Get the rate limit for this route.
public rateLimit ( ) : integer
Результат integer

rateLimitExpiration() публичный Метод

Get the rate limit expiration time for this route.
public rateLimitExpiration ( ) : integer
Результат integer

requestIsConditional() публичный Метод

Determine if the request is conditional.
public requestIsConditional ( ) : boolean
Результат boolean

scopeStrict() публичный Метод

Check if route requires all scopes or any scope to be valid.
public scopeStrict ( ) : boolean
Результат boolean

scopes() публичный Метод

Get the route scopes.
public scopes ( ) : array
Результат array

secure() публичный Метод

Determine if the route only responds to HTTPS requests.
public secure ( ) : boolean
Результат boolean

setupRouteProperties() защищенный Метод

Setup the route properties.
protected setupRouteProperties ( Illuminate\Http\Request $request, $route )
$request Illuminate\Http\Request

throttle() публичный Метод

Get the route throttle.
public throttle ( ) : string | Dingo\Api\Http\RateLimit\Throttle\Throttle
Результат string | Dingo\Api\Http\RateLimit\Throttle\Throttle

uri() публичный Метод

Get the URI associated with the route.
public uri ( ) : string
Результат string

versions() публичный Метод

Get the versions for the route.
public versions ( ) : array
Результат array

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

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

Array of route action attributes.
protected array $action
Результат array

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

Routing adapter instance.
protected Adapter,Dingo\Api\Contract\Routing $adapter
Результат Dingo\Api\Contract\Routing\Adapter

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

Array of authentication providers.
protected array $authenticationProviders
Результат array

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

Indicates if the request is conditional.
protected bool $conditionalRequest
Результат boolean

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

Container instance.
protected Container,Illuminate\Container $container
Результат Illuminate\Container\Container

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

Controller instance.
protected object $controller
Результат object

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

Controller class name.
protected string $controllerClass
Результат string

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

Controller method name.
protected string $controllerMethod
Результат string

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

Array of HTTP methods.
protected array $methods
Результат array

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

Middleware applied to route.
protected array $middleware
Результат array

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

The expiration time for any rate limit set on this rate.
protected int $rateExpiration
Результат integer

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

The rate limit for this route.
protected int $rateLimit
Результат integer

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

protected $route

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

Array of scopes for OAuth 2.0 authentication.
protected array $scopes
Результат array

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

The throttle used by the route, takes precedence over rate limits.
protected $throttle

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

Route URI.
protected string $uri
Результат string

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

Array of versions this route will respond to.
protected array $versions
Результат array