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

  • CountryService
  • CustomerCountry
  • CustomerCountryReader
  • CustomerCountryRepository

Class CountryService

Class CountryService

This class is used for finding country data

CountryService implements CountryServiceInterface
Package: Customer\Country
Category: System
Implements: CountryServiceInterface
Located at CoreServices/Country/CountryService.inc.php

Methods summary

public
# __construct( CustomerCountryRepositoryInterface $customerCountryRepo, CustomerCountryZoneRepositoryInterface $customerCountryZoneRepo )

Constructor of the class CountryService

Constructor of the class CountryService

Parameters

$customerCountryRepo
$customerCountryZoneRepo
public CustomerCountryInterface
# getCountryById( IdType $id )

Getter method for the country ID

Getter method for the country ID

Parameters

$id

Returns

CustomerCountryInterface

Implementation of

CountryServiceInterface::getCountryById()
public CustomerCountryZoneInterface
# getCountryZoneByNameAndCountry( $p_zoneName, CustomerCountryInterface $customerCountry )

Getter method for the country zone

Getter method for the country zone

Parameters

$p_zoneName
$customerCountry

Returns

CustomerCountryZoneInterface

Implementation of

CountryServiceInterface::getCountryZoneByNameAndCountry()
public CustomerCountryZoneInterface
# getCountryZoneById( IdType $id )

Parameters

$id

Returns

CustomerCountryZoneInterface
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

Implementation of

CountryServiceInterface::getUnknownCountryZoneByName()
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

Implementation of

CountryServiceInterface::findCountryZonesByCountryId()
public boolean
# countryZoneExistsInCountry( CustomerCountryZoneInterface $customerCountryZone, CustomerCountryInterface $customerCountry )

Checks if there is a country zone in a country

Checks if there is a country zone in a country

Parameters

$customerCountryZone
$customerCountry

Returns

boolean
true|false if country zone exists|not exists

Implementation of

CountryServiceInterface::countryZoneExistsInCountry()
public boolean
# countryHasCountryZones( CustomerCountryInterface $customerCountry )

Checks if country has country zones

Checks if country has country zones

Parameters

$customerCountry

Returns

boolean
true|false if there are|are not country zones

Implementation of

CountryServiceInterface::countryHasCountryZones()
public CustomerCountry
# getCountryByName( string $p_countryName )

Get customer by country name.

Get customer by country name.

Parameters

$p_countryName

Returns

CustomerCountry

Implementation of

CountryServiceInterface::getCountryByName()

Properties summary

protected CustomerCountryRepositoryInterface $customerCountryRepo
#
protected CustomerCountryZoneRepositoryInterface $customerCountryZoneRepo
#
API documentation generated by ApiGen