CustomerAddonValueRepository
in
Interface CustomerAddonValueRepository
Table of Contents
- createCustomerAddonValue() : CustomerAddonValueId
- Creates a new customer addon value and returns its ID.
- createMultipleCustomerAddonValues() : CustomerAddonValueIds
- Creates multiple customer addon values and returns their IDs.
- deleteCustomerAddonValuesByCustomerIds() : void
- Deletes all customer addon values based on the given customer IDs.
- deleteCustomerAddonValuesByIds() : void
- Deletes customer addon values based on the given customer addon value IDs.
- deleteCustomerAddonValuesByKeys() : void
- Deletes all customer addon values based on the given addon value keys.
- filterCustomerAddonValues() : CustomerAddonValues
- Returns a filtered and paginated collection of customer addon values based on the given filter and sorting arguments. The filters must be a map, that assigns an attribute its filtering pattern. The sorting must be a comma-separated list of attributes. A `-` can be used to change the order to descend.
- getCustomerAddonValue() : CustomerAddonValue
- Returns a specific customer addon value.
- getCustomerAddonValues() : CustomerAddonValues
- Returns all available customers addon values of a specific customer.
- getCustomerAddonValuesTotalCount() : int
- Returns total count of customer addon values based on the given filter arguments.
- storeCustomerAddonValues() : void
- Stores multiple customer addon values.
Methods
createCustomerAddonValue()
Creates a new customer addon value and returns its ID.
public
createCustomerAddonValue(CustomerId $customerId, CustomerAddonValueKey $key, string $value) : CustomerAddonValueId
Parameters
- $customerId : CustomerId
- $key : CustomerAddonValueKey
- $value : string
Tags
Return values
CustomerAddonValueId —createMultipleCustomerAddonValues()
Creates multiple customer addon values and returns their IDs.
public
createMultipleCustomerAddonValues(array<string|int, mixed> ...$creationArguments) : CustomerAddonValueIds
Parameters
- $creationArguments : array<string|int, mixed>
Tags
Return values
CustomerAddonValueIds —deleteCustomerAddonValuesByCustomerIds()
Deletes all customer addon values based on the given customer IDs.
public
deleteCustomerAddonValuesByCustomerIds(CustomerId ...$customerIds) : void
Parameters
- $customerIds : CustomerId
Tags
Return values
void —deleteCustomerAddonValuesByIds()
Deletes customer addon values based on the given customer addon value IDs.
public
deleteCustomerAddonValuesByIds(CustomerAddonValueId ...$customerAddonValueIds) : void
Parameters
- $customerAddonValueIds : CustomerAddonValueId
Tags
Return values
void —deleteCustomerAddonValuesByKeys()
Deletes all customer addon values based on the given addon value keys.
public
deleteCustomerAddonValuesByKeys(CustomerAddonValueKey ...$keys) : void
Parameters
- $keys : CustomerAddonValueKey
Tags
Return values
void —filterCustomerAddonValues()
Returns a filtered and paginated collection of customer addon values based on the given filter and sorting arguments. The filters must be a map, that assigns an attribute its filtering pattern. The sorting must be a comma-separated list of attributes. A `-` can be used to change the order to descend.
public
filterCustomerAddonValues(CustomerId $customerId, CustomerAddonValueFilters $filters, CustomerAddonValueSorting $sorting, Pagination $pagination) : CustomerAddonValues
Parameters
- $customerId : CustomerId
- $filters : CustomerAddonValueFilters
- $sorting : CustomerAddonValueSorting
- $pagination : Pagination
Return values
CustomerAddonValues —getCustomerAddonValue()
Returns a specific customer addon value.
public
getCustomerAddonValue(CustomerId $customerId, CustomerAddonValueKey $key) : CustomerAddonValue
Parameters
- $customerId : CustomerId
- $key : CustomerAddonValueKey
Tags
Return values
CustomerAddonValue —getCustomerAddonValues()
Returns all available customers addon values of a specific customer.
public
getCustomerAddonValues(CustomerId $customerId) : CustomerAddonValues
Parameters
- $customerId : CustomerId
Return values
CustomerAddonValues —getCustomerAddonValuesTotalCount()
Returns total count of customer addon values based on the given filter arguments.
public
getCustomerAddonValuesTotalCount(CustomerId $customerId, CustomerAddonValueFilters $filters) : int
The filters must be a map, that assigns an attribute it's filtering pattern.
Parameters
- $customerId : CustomerId
- $filters : CustomerAddonValueFilters
Return values
int —storeCustomerAddonValues()
Stores multiple customer addon values.
public
storeCustomerAddonValues(CustomerAddonValue ...$customerAddonValues) : void
Parameters
- $customerAddonValues : CustomerAddonValue