FetchAllProductVariantsAction
in package
Uses
CreateApiMetaDataTrait, ResponseDataTrimmerTrait
Class FetchAllProductVariantsAction
Table of Contents
- $parser : ProductVariantApiRequestParser
- $service : ProductVariantsFilterService
- __construct() : mixed
- FetchAllProductVariantsAction constructor.
- __invoke() : Response
- trimCollectionData() : array<string|int, mixed>
- createApiCollectionMetaData() : ApiCollectionMetaData
- createApiMetaData() : ApiMetaData
- trimDocumentData() : void
Properties
$parser
private
ProductVariantApiRequestParser
$parser
$service
private
ProductVariantsFilterService
$service
Methods
__construct()
FetchAllProductVariantsAction constructor.
public
__construct(ProductVariantApiRequestParser $parser, ProductVariantsFilterService $service) : mixed
Parameters
- $parser : ProductVariantApiRequestParser
- $service : ProductVariantsFilterService
Return values
mixed —__invoke()
public
__invoke(Request $request, Response $response, array<string|int, mixed> $args) : Response
Parameters
Return values
Response —trimCollectionData()
public
trimCollectionData(array<string|int, mixed> $collectionData, array<string|int, mixed> $wantedFields) : array<string|int, mixed>
Parameters
- $collectionData : array<string|int, mixed>
- $wantedFields : array<string|int, mixed>
Return values
array<string|int, mixed> —createApiCollectionMetaData()
private
createApiCollectionMetaData(int $page, int $perPage, int $totalItems[, string|null $resourcesUrl = null ][, array<string|int, mixed>|null $queryParams = null ]) : ApiCollectionMetaData
Parameters
- $page : int
- $perPage : int
- $totalItems : int
- $resourcesUrl : string|null = null
- $queryParams : array<string|int, mixed>|null = null
Return values
ApiCollectionMetaData —createApiMetaData()
private
createApiMetaData([array<string|int, mixed> $links = [] ]) : ApiMetaData
Parameters
- $links : array<string|int, mixed> = []
Return values
ApiMetaData —trimDocumentData()
private
trimDocumentData(array<string|int, mixed> &$document, array<string|int, mixed> $wantedFields[, string $indexBase = '' ]) : void
Parameters
- $document : array<string|int, mixed>
- $wantedFields : array<string|int, mixed>
- $indexBase : string = ''