• Accueil
• Dingo
• Api
• Dispatcher

PHP Class Dingo\Api\Dispatcher

Afficher le fichier Open project: dingo/api Class Usage Examples

Protected Properties

Свойство	Type	Description
$auth	Dingo\Api\Auth\Auth	Auth instance.
$container	Illuminate\Container\Container	Illuminate container instance.
$content	string	Request raw content.
$cookies	array	Request cookies.
$defaultDomain	string	Default domain.
$defaultFormat	string	Default format.
$defaultVersion	string	Default version.
$domain	string	Domain for the request.
$files	Illuminate\Filesystem\Filesystem	Illuminate filesystem instance.
$headers	array	Request headers.
$parameters	array	Request parameters.
$persistAuthentication	boolean	Indicates whether authentication is persisted.
$prefix	string	API prefix.
$raw	boolean	Indicates whether the returned response is the raw response object.
$requestStack	array	Internal request stack.
$routeStack	array	Internal route stack.
$router	Dingo\Api\Routing\Router	Router instance.
$standardsTree	string	API standards tree.
$subtype	string	API subtype.
$uploads	array	Request uploaded files.
$version	string	Version for the request.

Méthodes publiques

Méthode	Description
__construct ( Illuminate\Container\Container $container, Illuminate\Filesystem\Filesystem $files, Router $router, Dingo\Api\Auth\Auth $auth ) : void	Create a new dispatcher instance.
attach ( array $files ) : Dispatcher	Attach files to be uploaded.
be ( mixed $user ) : Dispatcher	Internal request will be authenticated as the given user.
cookie ( Cookie $cookie ) : Dispatcher	Set a cookie to be sent on the next API request.
delete ( string $uri, string | array $parameters = [], string $content = '' ) : mixed	Perform API DELETE request.
get ( string $uri, string | array $parameters = [] ) : mixed	Perform API GET request.
getDomain ( ) : string	Get the domain.
getFormat ( ) : string	Get the format.
getStandardsTree ( ) : string	Get the standards tree.
getSubtype ( ) : string	Get the subtype.
getVersion ( ) : string	Get the version.
header ( string $key, string $value ) : Dispatcher	Set a header to be sent on the next API request.
json ( string | array $content ) : Dispatcher	Send a JSON payload in the request body.
on ( string $domain ) : Dispatcher	Sets the domain to be used for the request.
once ( ) : Dispatcher	Only authenticate with the given user for a single request.
patch ( string $uri, string | array $parameters = [], string $content = '' ) : mixed	Perform API PATCH request.
post ( string $uri, string | array $parameters = [], string $content = '' ) : mixed	Perform API POST request.
put ( string $uri, string | array $parameters = [], string $content = '' ) : mixed	Perform API PUT request.
raw ( ) : Dispatcher	Return the raw response object once request is dispatched.
setDefaultDomain ( string $domain ) : void	Set the default domain.
setDefaultFormat ( string $format ) : void	Set the defult format.
setDefaultVersion ( string $version ) : void	Set the default version.
setPrefix ( string $prefix ) : void	Set the prefix.
setStandardsTree ( string $standardsTree ) : void	Set the standards tree.
setSubtype ( string $subtype ) : void	Set the subtype.
version ( string $version ) : Dispatcher	Set the version of the API for the next request.
with ( string | array $parameters ) : Dispatcher	Set the parameters to be sent on the next API request.

Méthodes protégées

Méthode	Description
addPrefixToUri ( string $uri ) : string	Add the prefix to the URI.
clearCachedFacadeInstance ( ) : void	Clear the cached facade instance.
createRequest ( string $verb, string $uri, string | array $parameters ) : Dingo\Api\Http\InternalRequest	Create a new internal request from an HTTP verb and URI.
dispatch ( Dingo\Api\Http\InternalRequest $request ) : mixed	Attempt to dispatch an internal request.
getAcceptHeader ( ) : string	Build the "Accept" header.
getRootRequest ( ) : Illuminate\Http\Request	Get the root request instance.
queueRequest ( string $verb, string $uri, string | array $parameters, string $content = '' ) : mixed	Queue up and dispatch a new request.
refreshRequestStack ( ) : void	Refresh the request stack.
replaceRequestInstance ( ) : void	Replace the request instance with the previous request instance.
setupRequestStack ( ) : void	Setup the request stack by grabbing the initial request.

Method Details

Property Details