PHP 클래스 Dingo\Api\Routing\Route

파일 보기 프로젝트 열기: dingo/api 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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