PHP Класс Dingo\Api\Transformer\Adapter\Fractal

Наследование: implements Dingo\Api\Contract\Transformer\Adapter
Показать файл Открыть проект

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

Свойство Тип Описание
$eagerLoading boolean Indicates if eager loading is enabled.
$fractal League\Fractal\Manager Fractal manager instance.
$includeKey string The include query string key.
$includeSeparator string The include separator.

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

Метод Описание
__construct ( League\Fractal\Manager $fractal, string $includeKey = 'include', string $includeSeparator = ',', boolean $eagerLoading = true ) : void Create a new fractal transformer instance.
disableEagerLoading ( ) : Fractal Disable eager loading.
enableEagerLoading ( ) : Fractal Enable eager loading.
getFractal ( ) : League\Fractal\Manager Get the underlying Fractal instance.
parseFractalIncludes ( Dingo\Api\Http\Request $request ) : void Parse the includes.
transform ( mixed $response, object $transformer, Dingo\Api\Transformer\Binding $binding, Dingo\Api\Http\Request $request ) : array Transform a response with a transformer.

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

Метод Описание
createPaginatorAdapter ( Illuminate\Contracts\Pagination\Paginator $paginator ) : League\Fractal\Pagination\IlluminatePaginatorAdapter Create the Fractal paginator adapter.
createResource ( mixed $response, League\Fractal\TransformerAbstract $transformer, array $parameters ) : League\Fractal\Resource\Item | League\Fractal\Resource\Collection Create a Fractal resource instance.
mergeEagerLoads ( League\Fractal\TransformerAbstract $transformer, string | array $requestedIncludes ) : array Get includes as their array keys for eager loading.
shouldEagerLoad ( mixed $response ) : boolean Eager loading is only performed when the response is or contains an Eloquent collection and eager loading is enabled.

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

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

Create a new fractal transformer instance.
public __construct ( League\Fractal\Manager $fractal, string $includeKey = 'include', string $includeSeparator = ',', boolean $eagerLoading = true ) : void
$fractal League\Fractal\Manager
$includeKey string
$includeSeparator string
$eagerLoading boolean
Результат void

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

Create the Fractal paginator adapter.
protected createPaginatorAdapter ( Illuminate\Contracts\Pagination\Paginator $paginator ) : League\Fractal\Pagination\IlluminatePaginatorAdapter
$paginator Illuminate\Contracts\Pagination\Paginator
Результат League\Fractal\Pagination\IlluminatePaginatorAdapter

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

Create a Fractal resource instance.
protected createResource ( mixed $response, League\Fractal\TransformerAbstract $transformer, array $parameters ) : League\Fractal\Resource\Item | League\Fractal\Resource\Collection
$response mixed
$transformer League\Fractal\TransformerAbstract
$parameters array
Результат League\Fractal\Resource\Item | League\Fractal\Resource\Collection

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

Disable eager loading.
public disableEagerLoading ( ) : Fractal
Результат Fractal

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

Enable eager loading.
public enableEagerLoading ( ) : Fractal
Результат Fractal

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

Get the underlying Fractal instance.
public getFractal ( ) : League\Fractal\Manager
Результат League\Fractal\Manager

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

Get includes as their array keys for eager loading.
protected mergeEagerLoads ( League\Fractal\TransformerAbstract $transformer, string | array $requestedIncludes ) : array
$transformer League\Fractal\TransformerAbstract
$requestedIncludes string | array
Результат array

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

Parse the includes.
public parseFractalIncludes ( Dingo\Api\Http\Request $request ) : void
$request Dingo\Api\Http\Request
Результат void

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

Eager loading is only performed when the response is or contains an Eloquent collection and eager loading is enabled.
protected shouldEagerLoad ( mixed $response ) : boolean
$response mixed
Результат boolean

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

Transform a response with a transformer.
public transform ( mixed $response, object $transformer, Dingo\Api\Transformer\Binding $binding, Dingo\Api\Http\Request $request ) : array
$response mixed
$transformer object
$binding Dingo\Api\Transformer\Binding
$request Dingo\Api\Http\Request
Результат array

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

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

Indicates if eager loading is enabled.
protected bool $eagerLoading
Результат boolean

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

Fractal manager instance.
protected Manager,League\Fractal $fractal
Результат League\Fractal\Manager

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

The include query string key.
protected string $includeKey
Результат string

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

The include separator.
protected string $includeSeparator
Результат string