PHP 트레잇 Dingo\Api\Routing\Helpers

파일 보기 프로젝트 열기: dingo/api

보호된 프로퍼티들

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