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

  • AbstractCustomerFactory

Interfaces

  • AddressBlockInterface
  • AddressBookServiceInterface
  • AddressClassInterface
  • CountryServiceInterface
  • CustomerAccountInputValidatorInterface
  • CustomerAdditionalAddressInfoInterface
  • CustomerAddressDeleterInterface
  • CustomerAddressInputValidatorInterface
  • CustomerAddressInterface
  • CustomerAddressReaderInterface
  • CustomerAddressRepositoryInterface
  • CustomerAddressWriterInterface
  • CustomerB2BStatusInterface
  • CustomerCallNumberInterface
  • CustomerCityInterface
  • CustomerCompanyInterface
  • CustomerCountryInterface
  • CustomerCountryIso2Interface
  • CustomerCountryIso3Interface
  • CustomerCountryNameInterface
  • CustomerCountryReaderInterface
  • CustomerCountryRepositoryInterface
  • CustomerCountryZoneInterface
  • CustomerCountryZoneIsoCodeInterface
  • CustomerCountryZoneNameInterface
  • CustomerCountryZoneReaderInterface
  • CustomerCountryZoneRepositoryInterface
  • CustomerDeleterInterface
  • CustomerEmailInterface
  • CustomerFirstnameInterface
  • CustomerGenderInterface
  • CustomerHouseNumberInterface
  • CustomerInputValidatorInterface
  • CustomerInputValidatorSettingsInterface
  • CustomerInterface
  • CustomerLastnameInterface
  • CustomerNumberInterface
  • CustomerPasswordInterface
  • CustomerPostcodeInterface
  • CustomerReaderInterface
  • CustomerReadServiceInterface
  • CustomerRegistrationInputValidatorServiceInterface
  • CustomerRepositoryInterface
  • CustomerServiceInterface
  • CustomerServiceSettingsInterface
  • CustomerStreetInterface
  • CustomerSuburbInterface
  • CustomerVatNumberInterface
  • CustomerWriterInterface
  • CustomerWriteServiceInterface
  • VatNumberValidatorInterface

Interface CountryServiceInterface

Interface CountryServiceInterface

Direct known implementers

CountryService

Package: Customer\Interfaces
Category: System
Located at Services/Core/Country/Interfaces/CountryServiceInterface.inc.php

Methods summary

public CustomerCountryInterface
# getCountryById( IdType $id )

Method to get a country with a given id

Method to get a country with a given id

Parameters

$id

Returns

CustomerCountryInterface
public CustomerCountryZoneInterface
# getCountryZoneByNameAndCountry( CustomerCountryZoneNameInterface|string $p_zoneName, CustomerCountryInterface $customerCountry )

Method to get a country with a given name and country

Method to get a country with a given name and country

Parameters

$p_zoneName
$customerCountry

Returns

CustomerCountryZoneInterface
public CustomerCountryZoneInterface|null
# findCountryZoneByNameAndCountry( CustomerCountryZoneNameInterface|string $p_zoneName, CustomerCountryInterface $customerCountry )

This method returns a CustomerCountryZone object if found. Otherwise null will be returned.

This method returns a CustomerCountryZone object if found. Otherwise null will be returned.

Parameters

$p_zoneName
$customerCountry

Returns

CustomerCountryZoneInterface|null
public boolean
# countryZoneExistsInCountry( CustomerCountryZoneInterface $customerCountryZone, CustomerCountryInterface $customerCountry )

Method to check if a country zone exists in a country

Method to check if a country zone exists in a country

Parameters

$customerCountryZone
$customerCountry

Returns

boolean
public boolean
# countryHasCountryZones( CustomerCountryInterface $customerCountry )

Method to check if a country has country zones

Method to check if a country has country zones

Parameters

$customerCountry

Returns

boolean
public CustomerCountryZone
# getUnknownCountryZoneByName( string $p_zoneName )

This method will return a new CustomerCountryZone object representing an unknown country zone.

This method will return a new CustomerCountryZone object representing an unknown country zone.

Parameters

$p_zoneName

Returns

CustomerCountryZone
public array
# findCountryZonesByCountryId( IdType $countryId )

This method will return an array of CustomerCountryZone objects found by the country ID. If the country has no zones, an empty array will be returned

This method will return an array of CustomerCountryZone objects found by the country ID. If the country has no zones, an empty array will be returned

Parameters

$countryId

Returns

array
of CustomerCountryZone objects
public CustomerCountryInterface
# getCountryByName( string $p_countryName )

Get country by name.

Get country by name.

Parameters

$p_countryName

Returns

CustomerCountryInterface
public CustomerCountryInterface
# findCountryByName( string $p_countryName )

Find country by name.

Find country by name.

Parameters

$p_countryName

Returns

CustomerCountryInterface
public CustomerCountryInterface
# getCountryByIso2( string $p_countryIso2 )

Get country by iso2 code.

Get country by iso2 code.

Parameters

$p_countryIso2

Returns

CustomerCountryInterface
public CustomerCountryInterface
# findCountryByIso2( string $p_countryIso2 )

Find country by iso2 code.

Find country by iso2 code.

Parameters

$p_countryIso2

Returns

CustomerCountryInterface
API documentation generated by ApiGen