PHP 클래스 Dingo\Api\Transformer\Adapter\Fractal

상속: implements Dingo\Api\Contract\Transformer\Adapter
파일 보기 프로젝트 열기: dingo/api

보호된 프로퍼티들

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