SearchCustomerAction
in package
Uses
CreateApiMetaDataTrait
Class SearchCustomerAction
Tags
Table of Contents
- $additionalInformationRepository : CustomerAdditionalInformationRepository
- $datetimeFormat : string
- $service : CustomerSearchService
- __construct() : mixed
- __invoke() : Response
- createApiCollectionMetaData() : ApiCollectionMetaData
- createApiMetaData() : ApiMetaData
- getPage() : int
- getPerPage() : int
- getResourceUrlFromRequest() : string
- getSearchTerm() : string
- getSorting() : string|null
Properties
$additionalInformationRepository
private
CustomerAdditionalInformationRepository
$additionalInformationRepository
$datetimeFormat
private
string
$datetimeFormat
$service
private
CustomerSearchService
$service
Methods
__construct()
public
__construct(CustomerSearchService $service, CustomerAdditionalInformationRepository $additionalInformationRepository) : mixed
Parameters
- $service : CustomerSearchService
- $additionalInformationRepository : CustomerAdditionalInformationRepository
Return values
mixed —__invoke()
public
__invoke(Request $request, Response $response, array<string|int, mixed> $args) : Response
Parameters
Return values
Response —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 —getPage()
private
getPage(Request $request) : int
Parameters
- $request : Request
Return values
int —getPerPage()
private
getPerPage(Request $request) : int
Parameters
- $request : Request
Return values
int —getResourceUrlFromRequest()
private
getResourceUrlFromRequest(Request $request) : string
Parameters
- $request : Request
Return values
string —getSearchTerm()
private
getSearchTerm(Request $request) : string
Parameters
- $request : Request
Return values
string —getSorting()
private
getSorting(Request $request) : string|null
Parameters
- $request : Request