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

  • AbstractCustomerServiceFactory
  • Customer
  • CustomerDeleter
  • CustomerFactory
  • CustomerReader
  • CustomerReadService
  • CustomerRepository
  • CustomerService
  • CustomerServiceFactory
  • CustomerWriter
  • CustomerWriteService

Class CustomerReadService

Class CustomerReadService

This class provides methods for creating and deleting customer data

CustomerReadService implements CustomerReadServiceInterface
Package: Customer
Category: System
Implements: CustomerReadServiceInterface
Located at CoreServices/Customer/CustomerReadService.inc.php

Methods summary

public
# __construct( CustomerRepositoryInterface $customerRepository )

Constructor of the class CustomerService.

Constructor of the class CustomerService.

Parameters

$customerRepository
Customer repository.
public Customer
# getCustomerById( IdType $customerId )

Finds a customer by an entered ID.

Finds a customer by an entered ID.

Parameters

$customerId
Customer ID.

Returns

Customer
Customer.

Implementation of

CustomerReadServiceInterface::getCustomerById()
public boolean
# registreeEmailExists( CustomerEmailInterface $email )

Checks if the email address of the registree already exists.

Checks if the email address of the registree already exists.

Parameters

$email
Customer's E-Mail address.

Returns

boolean
Does the E-Mail address already exist?

Implementation of

CustomerReadServiceInterface::registreeEmailExists()
public boolean
# addressIsDefaultCustomerAddress( CustomerAddressInterface $customerAddress )

Checks if address is the default address of the customer.

Checks if address is the default address of the customer.

Parameters

$customerAddress
Customer's address.

Returns

boolean
Is provided address the customer's default address?

Implementation of

CustomerReadServiceInterface::addressIsDefaultCustomerAddress()
public array
# filterCustomers( array $conditions = array(), integer $limit = null, integer $offset = null )

Filters customer records and returns an array with results.

Filters customer records and returns an array with results.

Example: $service->filterCustomers('customers_id' => 1);

Parameters

$conditions
Associative array containing the desired field and value.
$limit
MySQL limit applied to the records.
$offset
MySQL offset applied to the records.

Returns

array
Returns an array that contains customer objects.

Implementation of

CustomerReadServiceInterface::filterCustomers()

Properties summary

protected CustomerRepositoryInterface $customerRepository

Customer repository.

Customer repository.

#
API documentation generated by ApiGen