Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • ApiV2Controllers
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • AddressBookService
  • CustomerAddress
  • CustomerAddressDeleter
  • CustomerAddressInputValidator
  • CustomerAddressReader
  • CustomerAddressRepository
  • CustomerAddressWriter

Class CustomerAddressRepository

Class CustomerAddressRepository

This class contains basic methods for finding, creating and deleting customer addresses

CustomerAddressRepository implements CustomerAddressRepositoryInterface
Package: Customer\Address
Category: System
Implements: CustomerAddressRepositoryInterface
Located at CoreServices/Address/CustomerAddressRepository.inc.php

Methods summary

public
# __construct( CustomerAddressWriterInterface $customerAddressWriter, CustomerAddressDeleterInterface $customerAddressDeleter, CustomerAddressReaderInterface $customerAddressReader, AbstractCustomerFactory $customerFactory )

Constructor of the class CustomerAddressRepository

Constructor of the class CustomerAddressRepository

Parameters

$customerAddressWriter
$customerAddressDeleter
$customerAddressReader
$customerFactory
public CustomerAddress
# getNewAddress( )

Returns

CustomerAddress
public CustomerAddressInterface
# store( CustomerAddressInterface $address )

Stores the customer address

Stores the customer address

Parameters

$address

Returns

CustomerAddressInterface

Implementation of

CustomerAddressRepositoryInterface::store()
public
# deleteCustomerAddressesByCustomer( CustomerInterface $customer )

Deletes the customer address

Deletes the customer address

Parameters

$customer

Implementation of

CustomerAddressRepositoryInterface::deleteCustomerAddressesByCustomer()
public
# deleteCustomerAddress( CustomerAddressInterface $address )

Method to delete a customer address

Method to delete a customer address

Parameters

$address

Implementation of

CustomerAddressRepositoryInterface::deleteCustomerAddress()
public array
# getAllAddresses( )

Get all registered address records.

Get all registered address records.

Returns

array
Returns an array of CustomerAddress objects.
public array
# filterAddresses( string $p_keyword )

Filter existing address records by provided string.

Filter existing address records by provided string.

Parameters

$p_keyword

Returns

array
Returns an array of CustomerAddress objects.
public array
# getCustomerAddresses( CustomerInterface $customer )

Gets all customer addresses

Gets all customer addresses

Parameters

$customer

Returns

array
of CustomerAddress objects

Implementation of

CustomerAddressRepositoryInterface::getCustomerAddresses()
public CustomerAddress
# getById( IdType $addressBookId )

Parameters

$addressBookId

Returns

CustomerAddress

Implementation of

CustomerAddressRepositoryInterface::getById()
public CustomerAddress
# findById( IdType $addressBookId )

Parameters

$addressBookId

Returns

CustomerAddress

Implementation of

CustomerAddressRepositoryInterface::findById()

Properties summary

protected CustomerAddressWriterInterface $customerAddressWriter
#
protected CustomerAddressDeleterInterface $customerAddressDeleter
#
protected CustomerAddressReaderInterface $customerAddressReader
#
protected AbstractCustomerFactory $customerFactory
#
API documentation generated by ApiGen