PHP Trait Dingo\Api\Routing\Helpers

Afficher le fichier Open project: dingo/api

Protected Properties

Свойство Type Description
$authenticationProviders array Controller authentication providers.
$rateLimit array Controller rate limit and expiration.
$scopes array Controller scopes.
$throttles array Controller rate limit throttles.

Méthodes publiques

Méthode Description
__call ( string $method, array $parameters ) : Response Magically handle calls to certain methods on the response factory.
__get ( string $key ) : mixed Magically handle calls to certain properties.
api ( ) : Dispatcher Get the internal dispatcher instance.
getAuthenticationProviders ( ) : array Get the controllers authentication providers.
getRateLimit ( ) : array Get the controllers rate limit and expiration.
getScopes ( ) : array Get the controllers scopes.
getThrottles ( ) : array Get the controllers rate limiting throttles.

Méthodes protégées

Méthode Description
auth ( ) : Dingo\Api\Auth\Auth Get the auth instance.
authenticateWith ( string | array $providers, array $options = [] ) : void Authenticate with certain providers on controller methods.
getPropertyValue ( string | array $value ) : array Prepare a property value.
rateLimit ( integer $limit, integer $expires, array $options = [] ) : void Rate limit controller methods.
response ( ) : Factory Get the response factory instance.
scopes ( string | array $scopes, array $options = [] ) : void Add scopes to controller methods.
throttle ( string | Dingo\Api\Contract\Http\RateLimit\Throttle $class, array $options = [] ) : void Throttles for controller methods.
user ( ) : mixed Get the authenticated user.

Method Details

__call() public méthode

Magically handle calls to certain methods on the response factory.
public __call ( string $method, array $parameters ) : Response
$method string
$parameters array
Résultat Dingo\Api\Http\Response

__get() public méthode

Magically handle calls to certain properties.
public __get ( string $key ) : mixed
$key string
Résultat mixed

api() public méthode

Get the internal dispatcher instance.
public api ( ) : Dispatcher
Résultat Dingo\Api\Dispatcher

auth() protected méthode

Get the auth instance.
protected auth ( ) : Dingo\Api\Auth\Auth
Résultat Dingo\Api\Auth\Auth

authenticateWith() protected méthode

Authenticate with certain providers on controller methods.
protected authenticateWith ( string | array $providers, array $options = [] ) : void
$providers string | array
$options array
Résultat void

getAuthenticationProviders() public méthode

Get the controllers authentication providers.
public getAuthenticationProviders ( ) : array
Résultat array

getPropertyValue() protected méthode

Prepare a property value.
protected getPropertyValue ( string | array $value ) : array
$value string | array
Résultat array

getRateLimit() public méthode

Get the controllers rate limit and expiration.
public getRateLimit ( ) : array
Résultat array

getScopes() public méthode

Get the controllers scopes.
public getScopes ( ) : array
Résultat array

getThrottles() public méthode

Get the controllers rate limiting throttles.
public getThrottles ( ) : array
Résultat array

rateLimit() protected méthode

Rate limit controller methods.
protected rateLimit ( integer $limit, integer $expires, array $options = [] ) : void
$limit integer
$expires integer
$options array
Résultat void

response() protected méthode

Get the response factory instance.
protected response ( ) : Factory
Résultat Dingo\Api\Http\Response\Factory

scopes() protected méthode

Add scopes to controller methods.
protected scopes ( string | array $scopes, array $options = [] ) : void
$scopes string | array
$options array
Résultat void

throttle() protected méthode

Throttles for controller methods.
protected throttle ( string | Dingo\Api\Contract\Http\RateLimit\Throttle $class, array $options = [] ) : void
$class string | Dingo\Api\Contract\Http\RateLimit\Throttle
$options array
Résultat void

user() protected méthode

Get the authenticated user.
protected user ( ) : mixed
Résultat mixed

Property Details

$authenticationProviders protected_oe property

Controller authentication providers.
protected array $authenticationProviders
Résultat array

$rateLimit protected_oe property

Controller rate limit and expiration.
protected array $rateLimit
Résultat array

$scopes protected_oe property

Controller scopes.
protected array $scopes
Résultat array

$throttles protected_oe property

Controller rate limit throttles.
protected array $throttles
Résultat array