• Home
• Dingo
• Api
• Routing
• Route

PHP Class Dingo\Api\Routing\Route

Show file Open project: dingo/api Class Usage Examples

Protected Properties

Property	Type	Description
$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.

Public Methods

Method	Description
__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.

Protected Methods

Method	Description
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.

Method Details

Property Details