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 AddressBookService

Class AddressBookService

This class is used to manage addresses

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

Methods summary

public
# __construct( CustomerAddressRepositoryInterface $addressRepository )

Constructor of the class AddressBookService

Constructor of the class AddressBookService

Parameters

$addressRepository
public CustomerAddressInterface
# createNewAddress( AddressBlockInterface $addressBlock, CustomerInterface $customer )

Method to add a new address in the address book

Method to add a new address in the address book

Parameters

$addressBlock
$customer

Returns

CustomerAddressInterface

Implementation of

AddressBookServiceInterface::createNewAddress()
public CustomerAddressInterface
# updateAddress( AddressBlockInterface $addressBlock, CustomerAddressInterface $address )

Method to update an address in the address book

Method to update an address in the address book

Parameters

$addressBlock
$address

Returns

CustomerAddressInterface

Implementation of

AddressBookServiceInterface::updateAddress()
public
# deleteAddress( CustomerAddressInterface $address )

Parameters

$address

Implementation of

AddressBookServiceInterface::deleteAddress()
public CustomerAddress
# findAddressById( IdType $addressId )

Parameters

$addressId

Returns

CustomerAddress
public
# updateCustomerAddress( CustomerAddressInterface $customerAddress )

Parameters

$customerAddress
public array
# getCustomerAddresses( CustomerInterface $customer )

Get customer addresses.

Get customer addresses.

Parameters

$customer
Contains the customer data.

Returns

array
Returns an array of CustomerAddress objects.
public array
# getAllAddresses( )

Get all registered addresses.

Get all registered addresses.

Returns

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

Filter registered addresses by string.

Filter registered addresses by string.

Parameters

$p_keyword
Used to filter the address records.

Returns

array
Returns an array of CustomerAddress objects.

Properties summary

protected CustomerAddressRepositoryInterface $customerAddressRepository
#
API documentation generated by ApiGen