PHP Class Flugg\Responder\Http\SuccessResponseBuilder

Author: Alexander Tømmerås ([email protected])
Inheritance: extends ResponseBuilder
Afficher le fichier Open project: flugger/laravel-responder Class Usage Examples

Protected Properties

Свойство Type Description
$manager League\Fractal\Manager The manager responsible for transforming and serializing data.
$meta array The meta data appended to the serialized data.
$relations array The included relations.
$resource League\Fractal\Resource\ResourceInterface The Fractal resource instance containing the data and transformer.
$resourceFactory Flugg\Responder\ResourceFactory The resource factory used to generate resource instances.
$statusCode integer The HTTP status code for the response.

Méthodes publiques

Méthode Description
__construct ( Illuminate\Contracts\Routing\ResponseFactory | ResponseFactory $responseFactory, ResourceFactory $resourceFactory, League\Fractal\Manager $manager ) SuccessResponseBuilder constructor.
addMeta ( array $data ) : SuccessResponseBuilder Add data to the meta data appended to the response data.
getManager ( ) : League\Fractal\Manager Get the Fractal manager responsible for transforming and serializing the data.
getResource ( ) : League\Fractal\Resource\ResourceInterface Get the Fractal resource instance.
include ( array | string $relations ) : SuccessResponseBuilder Set the serializer used to serialize the resource data.
serializer ( League\Fractal\Serializer\SerializerAbstract | string $serializer ) : SuccessResponseBuilder Set the serializer used to serialize the resource data.
setStatus ( integer $statusCode ) : ResponseBuilder Set the HTTP status code for the response.
toArray ( ) : array Convert the response to an array.
transform ( mixed | null $data = null, callable | string | null $transformer = null, string $resourceKey = null ) : SuccessResponseBuilder Set the transformation data. This will set a new resource instance on the response builder depending on what type of data is provided.

Méthodes protégées

Méthode Description
parseTransformer ( Transformer | callable $transformer, Model $model ) : Transformer | callable Parse a transformer class and set relations.
resolveModel ( Model | array $data ) : Model Resolve a model instance from the data.
resolveNestedRelations ( Collection | Model $data ) : array Resolve eager loaded relations from the model including any nested relations.
resolveRelations ( Model $model ) : array Resolve eager loaded relations from the model.
resolveResourceKey ( Model $model, string $resourceKey = null ) : string Resolve the resource key from the model.
resolveSerializer ( League\Fractal\Serializer\SerializerAbstract | string $serializer ) : League\Fractal\Serializer\SerializerAbstract Resolve a serializer instance from the value.
resolveTransformer ( Model $model, Transformer | callable | null $transformer = null ) : Transformer | callable Resolve a transformer.
resolveTransformerFromModel ( Model $model ) : Transformer | callable Resolve a transformer from the model. If the model is not transformable, a closure based transformer will be created instead, from the model's fillable attributes.
serialize ( League\Fractal\Resource\ResourceInterface $resource ) : array Serialize the transformation data.

Method Details

__construct() public méthode

SuccessResponseBuilder constructor.
public __construct ( Illuminate\Contracts\Routing\ResponseFactory | ResponseFactory $responseFactory, ResourceFactory $resourceFactory, League\Fractal\Manager $manager )
$responseFactory Illuminate\Contracts\Routing\ResponseFactory | Laravel\Lumen\Http\ResponseFactory
$resourceFactory Flugg\Responder\ResourceFactory
$manager League\Fractal\Manager

addMeta() public méthode

Add data to the meta data appended to the response data.
public addMeta ( array $data ) : SuccessResponseBuilder
$data array
Résultat SuccessResponseBuilder

getManager() public méthode

Get the Fractal manager responsible for transforming and serializing the data.
public getManager ( ) : League\Fractal\Manager
Résultat League\Fractal\Manager

getResource() public méthode

Get the Fractal resource instance.
public getResource ( ) : League\Fractal\Resource\ResourceInterface
Résultat League\Fractal\Resource\ResourceInterface

include() public méthode

Set the serializer used to serialize the resource data.
public include ( array | string $relations ) : SuccessResponseBuilder
$relations array | string
Résultat SuccessResponseBuilder

parseTransformer() protected méthode

Parse a transformer class and set relations.
protected parseTransformer ( Transformer | callable $transformer, Model $model ) : Transformer | callable
$transformer Flugg\Responder\Transformer | callable
$model Illuminate\Database\Eloquent\Model
Résultat Flugg\Responder\Transformer | callable

resolveModel() protected méthode

Resolve a model instance from the data.
protected resolveModel ( Model | array $data ) : Model
$data Illuminate\Database\Eloquent\Model | array
Résultat Illuminate\Database\Eloquent\Model

resolveNestedRelations() protected méthode

Resolve eager loaded relations from the model including any nested relations.
protected resolveNestedRelations ( Collection | Model $data ) : array
$data Illuminate\Support\Collection | Illuminate\Database\Eloquent\Model
Résultat array

resolveRelations() protected méthode

Resolve eager loaded relations from the model.
protected resolveRelations ( Model $model ) : array
$model Illuminate\Database\Eloquent\Model
Résultat array

resolveResourceKey() protected méthode

Resolve the resource key from the model.
protected resolveResourceKey ( Model $model, string $resourceKey = null ) : string
$model Illuminate\Database\Eloquent\Model
$resourceKey string
Résultat string

resolveSerializer() protected méthode

Resolve a serializer instance from the value.
protected resolveSerializer ( League\Fractal\Serializer\SerializerAbstract | string $serializer ) : League\Fractal\Serializer\SerializerAbstract
$serializer League\Fractal\Serializer\SerializerAbstract | string
Résultat League\Fractal\Serializer\SerializerAbstract

resolveTransformer() protected méthode

Resolve a transformer.
protected resolveTransformer ( Model $model, Transformer | callable | null $transformer = null ) : Transformer | callable
$model Illuminate\Database\Eloquent\Model
$transformer Flugg\Responder\Transformer | callable | null
Résultat Flugg\Responder\Transformer | callable

resolveTransformerFromModel() protected méthode

Resolve a transformer from the model. If the model is not transformable, a closure based transformer will be created instead, from the model's fillable attributes.
protected resolveTransformerFromModel ( Model $model ) : Transformer | callable
$model Illuminate\Database\Eloquent\Model
Résultat Flugg\Responder\Transformer | callable

serialize() protected méthode

Serialize the transformation data.
protected serialize ( League\Fractal\Resource\ResourceInterface $resource ) : array
$resource League\Fractal\Resource\ResourceInterface
Résultat array

serializer() public méthode

Set the serializer used to serialize the resource data.
public serializer ( League\Fractal\Serializer\SerializerAbstract | string $serializer ) : SuccessResponseBuilder
$serializer League\Fractal\Serializer\SerializerAbstract | string
Résultat SuccessResponseBuilder

setStatus() public méthode

Set the HTTP status code for the response.
public setStatus ( integer $statusCode ) : ResponseBuilder
$statusCode integer
Résultat ResponseBuilder

toArray() public méthode

Convert the response to an array.
public toArray ( ) : array
Résultat array

transform() public méthode

Set the transformation data. This will set a new resource instance on the response builder depending on what type of data is provided.
public transform ( mixed | null $data = null, callable | string | null $transformer = null, string $resourceKey = null ) : SuccessResponseBuilder
$data mixed | null
$transformer callable | string | null
$resourceKey string
Résultat SuccessResponseBuilder

Property Details

$manager protected_oe property

The manager responsible for transforming and serializing data.
protected Manager,League\Fractal $manager
Résultat League\Fractal\Manager

$meta protected_oe property

The meta data appended to the serialized data.
protected array $meta
Résultat array

$relations protected_oe property

The included relations.
protected array $relations
Résultat array

$resource protected_oe property

The Fractal resource instance containing the data and transformer.
protected ResourceInterface,League\Fractal\Resource $resource
Résultat League\Fractal\Resource\ResourceInterface

$resourceFactory protected_oe property

The resource factory used to generate resource instances.
protected ResourceFactory,Flugg\Responder $resourceFactory
Résultat Flugg\Responder\ResourceFactory

$statusCode protected_oe property

The HTTP status code for the response.
protected int $statusCode
Résultat integer