CustomerMemoRepository
in
Interface CustomerMemoRepository
Table of Contents
- createCustomerMemo() : CustomerMemoId
- Creates a new customer memo and returns its ID.
- createMultipleCustomerMemos() : CustomerMemoIds
- Creates multiple customer memos and returns their IDs.
- deleteCustomerMemosByCustomerIds() : void
- Deletes customer memos based on the given customer IDs.
- deleteCustomerMemosByMemoIds() : void
- Deletes customer memos based on the given customer memo IDs.
- filterCustomerMemos() : CustomerMemos
- Returns a filtered and paginated collection of customer memos based on the given filter and sorting arguments.
- getCustomerMemoById() : CustomerMemo
- Returns a specific customer memo based on the given ID.
- getCustomerMemos() : CustomerMemos
- Returns all available customer memos.
- getCustomerMemosTotalCount() : int
- Returns total count of customer memos based on the given filter arguments.
- storeCustomerMemos() : void
- Stores multiple customer memos.
Methods
createCustomerMemo()
Creates a new customer memo and returns its ID.
public
createCustomerMemo(CustomerId $customerId, CreatorId $creatorId, string $content) : CustomerMemoId
Parameters
- $customerId : CustomerId
- $creatorId : CreatorId
- $content : string
Tags
Return values
CustomerMemoId —createMultipleCustomerMemos()
Creates multiple customer memos and returns their IDs.
public
createMultipleCustomerMemos(array<string|int, mixed> ...$creationArguments) : CustomerMemoIds
Parameters
- $creationArguments : array<string|int, mixed>
-
Provided array must contain arguments like they are used in the single creation method. Provide multiple arrays for multi creation.
Tags
Return values
CustomerMemoIds —deleteCustomerMemosByCustomerIds()
Deletes customer memos based on the given customer IDs.
public
deleteCustomerMemosByCustomerIds(CustomerId ...$ids) : void
Parameters
- $ids : CustomerId
Tags
Return values
void —deleteCustomerMemosByMemoIds()
Deletes customer memos based on the given customer memo IDs.
public
deleteCustomerMemosByMemoIds(CustomerMemoId ...$ids) : void
Parameters
- $ids : CustomerMemoId
Tags
Return values
void —filterCustomerMemos()
Returns a filtered and paginated collection of customer memos based on the given filter and sorting arguments.
public
filterCustomerMemos(CustomerId $customerId, CustomerMemoFilters $filters, CustomerMemoSorting $sorting, Pagination $pagination) : CustomerMemos
Parameters
- $customerId : CustomerId
- $filters : CustomerMemoFilters
- $sorting : CustomerMemoSorting
- $pagination : Pagination
Return values
CustomerMemos —getCustomerMemoById()
Returns a specific customer memo based on the given ID.
public
getCustomerMemoById(CustomerMemoId $memoId) : CustomerMemo
Parameters
- $memoId : CustomerMemoId
Tags
Return values
CustomerMemo —getCustomerMemos()
Returns all available customer memos.
public
getCustomerMemos(CustomerId $customerId) : CustomerMemos
Parameters
- $customerId : CustomerId
Return values
CustomerMemos —getCustomerMemosTotalCount()
Returns total count of customer memos based on the given filter arguments.
public
getCustomerMemosTotalCount(CustomerId $customerId, CustomerMemoFilters $filters) : int
Parameters
- $customerId : CustomerId
- $filters : CustomerMemoFilters
Return values
int —storeCustomerMemos()
Stores multiple customer memos.
public
storeCustomerMemos(CustomerMemo ...$customerMemos) : void
Parameters
- $customerMemos : CustomerMemo