phpDocumentor

CustomersOverviewAction
in package
Uses CreateApiMetaDataTrait, ResponseDataTrimmerTrait

Class CustomersOverviewAction

Tags
codeCoverageIgnore

Table of Contents

$additionalInformationRepository  : CustomerAdditionalInformationRepository
$administratorPermissionRepository  : CustomerAdministratorPermissionRepository
$configProvider  : CustomerConfigurationProvider
$countryReadService  : CountryReadService
$currencyFilterService  : CurrencyFilterService
$datetimeFormat  : string
$filterFactory  : CustomerFilterFactory
$languageId  : int
$legacyCustomerGroupReader  : LegacyCustomerGroupReader
$repository  : CustomerRepository
$userConfigurationRepository  : CustomerUserConfigurationRepository
$userId  : int|null
__construct()  : mixed
__invoke()  : Response
trimCollectionData()  : array<string|int, mixed>
createApiCollectionMetaData()  : ApiCollectionMetaData
createApiMetaData()  : ApiMetaData
getFilters()  : CustomerFilters
getResourceUrlFromRequest()  : string
getStoreCountryById()  : array<string|int, mixed>
getSuperAdminStatus()  : array<string|int, mixed>
trimDocumentData()  : void

Properties

Methods

__construct()

public __construct(CustomerFilterFactory $filterFactory, CustomerRepository $repository, LegacyCustomerGroupReader $legacyCustomerGroupReader, CustomerAdministratorPermissionRepository $administratorPermissionRepository, CustomerConfigurationProvider $configProvider, CountryReadService $countryReadService, CurrencyFilterService $currencyFilterService, CustomerUserConfigurationRepository $userConfigurationRepository, CustomerAdditionalInformationRepository $additionalInformationRepository, UserPreferences $userPreferences) : mixed
Parameters
$filterFactory : CustomerFilterFactory
$repository : CustomerRepository
$legacyCustomerGroupReader : LegacyCustomerGroupReader
$administratorPermissionRepository : CustomerAdministratorPermissionRepository
$configProvider : CustomerConfigurationProvider
$countryReadService : CountryReadService
$currencyFilterService : CurrencyFilterService
$userConfigurationRepository : CustomerUserConfigurationRepository
$additionalInformationRepository : CustomerAdditionalInformationRepository
$userPreferences : UserPreferences
Return values
mixed —

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 —

getStoreCountryById()

private getStoreCountryById(int $countryId) : array<string|int, mixed>
Parameters
$countryId : int
Return values
array<string|int, mixed> —

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 = ''
Return values
void —

Search results