• Accueil
• Dingo
• Api
• Http
• Response

PHP Class Dingo\Api\Http\Response

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

Méthodes publiques

Свойство	Type	Description
$exception	Exception	The exception that triggered the error response.

Protected Properties

Свойство	Type	Description
$binding	Dingo\Api\Transformer\Binding	Transformer binding instance.
$events	Illuminate\Events\Dispatcher	Event dispatcher instance.
$formatters	array	Array of registered formatters.
$transformer	Dingo\Api\Transformer\TransformerFactory	Transformer factory instance.

Méthodes publiques

Méthode	Description
__construct ( mixed $content, integer $status = 200, array $headers = [], Dingo\Api\Transformer\Binding $binding = null ) : void	Create a new response instance.
addFormatter ( string $key, Dingo\Api\Http\Response\Format\Format $formatter ) : void	Add a response formatter.
addMeta ( string $key, mixed $value ) : Response	Add a meta key and value pair.
cookie ( Cookie | mixed $cookie ) : Response	Add a cookie to the response.
getFormatter ( string $format ) : Dingo\Api\Http\Response\Format\Format	Get the formatter based on the requested format type.
getMeta ( ) : array	Get the meta data for the response.
getTransformer ( ) : Dingo\Api\Transformer\Factory	Get the transformer instance.
hasFormatter ( string $format ) : boolean	Determine if a response formatter has been registered.
makeFromExisting ( Illuminate\Http\Response $old ) : Response	Make an API response from an existing Illuminate response.
makeFromJson ( Illuminate\Http\JsonResponse $json ) : Response	Make an API response from an existing JSON response.
meta ( string $key, mixed $value ) : Response	Add a meta key and value pair.
morph ( string $format = 'json' ) : Response	Morph the API response to the appropriate format.
setContent ( $content )
setEventDispatcher ( Illuminate\Events\Dispatcher $events ) : void	Set the event dispatcher instance.
setFormatters ( array $formatters ) : void	Set the response formatters.
setMeta ( array $meta ) : Response	Set the meta data for the response.
setTransformer ( Dingo\Api\Transformer\Factory $transformer ) : void	Set the transformer factory instance.
statusCode ( integer $statusCode ) : Response	Set the response status code.
withHeader ( string $key, string $value, boolean $replace = true ) : Response	Add a header to the response.

Méthodes protégées

Méthode	Description
fireMorphedEvent ( ) : void	Fire the morphed event.
fireMorphingEvent ( ) : void	Fire the morphing event.

Method Details

Property Details