PHP Трейт Dingo\Api\Routing\Helpers

Показать файл Открыть проект

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

Свойство Тип Описание
$authenticationProviders array Controller authentication providers.
$rateLimit array Controller rate limit and expiration.
$scopes array Controller scopes.
$throttles array Controller rate limit throttles.

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

Метод Описание
__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.

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

Метод Описание
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.

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

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

Magically handle calls to certain methods on the response factory.
public __call ( string $method, array $parameters ) : Response
$method string
$parameters array
Результат Dingo\Api\Http\Response

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

Magically handle calls to certain properties.
public __get ( string $key ) : mixed
$key string
Результат mixed

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

Get the internal dispatcher instance.
public api ( ) : Dispatcher
Результат Dingo\Api\Dispatcher

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

Get the auth instance.
protected auth ( ) : Dingo\Api\Auth\Auth
Результат Dingo\Api\Auth\Auth

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

Authenticate with certain providers on controller methods.
protected authenticateWith ( string | array $providers, array $options = [] ) : void
$providers string | array
$options array
Результат void

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

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

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

Prepare a property value.
protected getPropertyValue ( string | array $value ) : array
$value string | array
Результат array

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

Get the controllers rate limit and expiration.
public getRateLimit ( ) : array
Результат array

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

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

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

Get the controllers rate limiting throttles.
public getThrottles ( ) : array
Результат array

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

Rate limit controller methods.
protected rateLimit ( integer $limit, integer $expires, array $options = [] ) : void
$limit integer
$expires integer
$options array
Результат void

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

Get the response factory instance.
protected response ( ) : Factory
Результат Dingo\Api\Http\Response\Factory

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

Add scopes to controller methods.
protected scopes ( string | array $scopes, array $options = [] ) : void
$scopes string | array
$options array
Результат void

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

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
Результат void

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

Get the authenticated user.
protected user ( ) : mixed
Результат mixed

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

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

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

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

Controller rate limit and expiration.
protected array $rateLimit
Результат array

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

Controller scopes.
protected array $scopes
Результат array

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

Controller rate limit throttles.
protected array $throttles
Результат array