Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Authentication
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Strategies
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Helpers
    • Invoices
    • Orders
    • Serializers
    • Templates
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Precheck
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Slider
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

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

Class CustomerAddressReader

Class CustomerAddressReader

This class is used for reading customer address data from the database

CustomerAddressReader implements CustomerAddressReaderInterface
Package: Customer\Address
Category: System
Implements: CustomerAddressReaderInterface
Located at Services/Core/Address/CustomerAddressReader.inc.php

Methods summary

public
# __construct( AbstractCustomerFactory $customerFactory, CountryServiceInterface $countryService, CI_DB_query_builder $dbQueryBuilder )

Constructor for the class CustomerAddressReader

Constructor for the class CustomerAddressReader

CrossCuttingLoader dependencies: - StringHelper

Parameters

$customerFactory
$countryService
$dbQueryBuilder
public CustomerAddress
# getById( IdType $id )

Parameters

$id

Returns

CustomerAddress

Throws

InvalidArgumentException
public CustomerAddress
# findById( IdType $id )

Parameters

$id

Returns

CustomerAddress

Throws

InvalidArgumentException

Implementation of

CustomerAddressReaderInterface::findById()
public array
# findAddressesByCustomer( CustomerInterface $customer )

This method will return an array of all customer's addresses

This method will return an array of all customer's addresses

Parameters

$customer

Returns

array
containing CustomerAddress objects

Implementation of

CustomerAddressReaderInterface::findAddressesByCustomer()
public
# getAllAddresses( )

Get all system addresses.

Get all system addresses.

public array
# filterAddresses( string $p_keyword )

Filter existing addresses by keyword.

Filter existing addresses by keyword.

This method is useful when creating a search mechanism for the registered addresses.

Parameters

$p_keyword
The keyword to be used for filtering the records.

Returns

array
Returns an array of CustomerAddress objects.
protected CustomerAddress
# _createCustomerAddressByArray( array $addressDataArray )

Parameters

$addressDataArray

Returns

CustomerAddress

Properties summary

protected CI_DB_query_builder $db
#
protected AbstractCustomerFactory $customerFactory
#
protected CountryServiceInterface $countryService
#
protected StringHelperInterface $stringHelper
#
API documentation generated by ApiGen