1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 

<?php
/* --------------------------------------------------------------
   CustomerCountryZoneRepository.inc.php 2017-03-20 gm
   Gambio GmbH
   http://www.gambio.de
   Copyright (c) 2017 Gambio GmbH
   Released under the GNU General Public License (Version 2)
   [http://www.gnu.org/licenses/gpl-2.0.html]
   --------------------------------------------------------------
*/

MainFactory::load_class('CustomerCountryZoneRepositoryInterface');

/**
 * Class CustomerCountryZoneRepository
 *
 * This class provides basic methods for finding customer country zone data
 *
 * @category   System
 * @package    Customer
 * @subpackage CountryZone
 * @implements CustomerCountryZoneRepositoryInterface
 */
class CustomerCountryZoneRepository implements CustomerCountryZoneRepositoryInterface
{
    /**
     * @var CustomerCountryZoneReaderInterface
     */
    protected $customerCountryZoneReader;
    
    /**
     * @var AbstractCustomerFactory
     */
    protected $customerFactory;
    
    
    /**
     * Constructor of the class CustomerCountryZoneRepository
     *
     * @param CustomerCountryZoneReaderInterface $customerCountryZoneReader
     * @param AbstractCustomerFactory            $customerFactory
     */
    public function __construct(CustomerCountryZoneReaderInterface $customerCountryZoneReader,
                                AbstractCustomerFactory $customerFactory)
    {
        $this->customerCountryZoneReader = $customerCountryZoneReader;
        $this->customerFactory           = $customerFactory;
    }
    
    
    /**
     * @param IdType $countryZoneId
     *
     * @throws Exception if country zone not found
     *
     * @return CustomerCountryZoneInterface
     */
    public function getById(IdType $countryZoneId)
    {
        $countryZone = $this->customerCountryZoneReader->findById($countryZoneId);
        
        if($countryZone === null)
        {
            throw new Exception('country zone not found');
        }
        
        return $countryZone;
    }
    
    
    /**
     * @param CustomerCountryZoneNameInterface $countryZoneName
     * @param CustomerCountryInterface         $country
     *
     * @throws Exception if country zone not found
     *
     * @return CustomerCountryZoneInterface
     */
    public function getByNameAndCountry(CustomerCountryZoneNameInterface $countryZoneName,
                                        CustomerCountryInterface $country)
    {
        $countryZone = $this->customerCountryZoneReader->findByNameAndCountry($countryZoneName, $country);
        
        if($countryZone === null)
        {
            throw new Exception('country zone not found');
        }
        
        return $countryZone;
    }
    
    
    /**
     * This method will return a new CustomerCountryZone object representing an unknown country zone.
     * ID is 0 and ISO code is empty.
     *
     * @param CustomerCountryZoneNameInterface $countryZoneName
     *
     * @return CustomerCountryZone
     */
    public function getUnknownCountryZoneByName(CustomerCountryZoneNameInterface $countryZoneName)
    {
        return $this->customerFactory->createCustomerCountryZone(new IdType(0), $countryZoneName,
                                                                 MainFactory::create('CustomerCountryZoneIsoCode', ''));
    }
    
    
    /**
     * This method will get the country zone by its name and country if it exists, if not it will return null.
     *
     * @param CustomerCountryZoneNameInterface $countryZoneName
     * @param CustomerCountryInterface         $country
     *
     * @return CustomerCountryZone|null
     */
    public function findByNameAndCountry(CustomerCountryZoneNameInterface $countryZoneName,
                                         CustomerCountryInterface $country)
    {
        $countryZone = $this->customerCountryZoneReader->findByNameAndCountry($countryZoneName, $country);
        
        return $countryZone;
    }
    
    
    /**
     * This method will get the country zone by its ID if it exists, if not it will return null.
     *
     * @param IdType $countryZoneId
     *
     * @return CustomerCountryZone|null
     */
    public function findById(IdType $countryZoneId)
    {
        $countryZone = $this->customerCountryZoneReader->findById($countryZoneId);
        
        return $countryZone;
    }
    
    
    /**
     * This method will return an array of country zones found by the country ID.
     *
     * @param IdType $countryId
     *
     * @return array
     */
    public function findCountryZonesByCountryId(IdType $countryId)
    {
        $countryZones = $this->customerCountryZoneReader->findCountryZonesByCountryId($countryId);
        
        return $countryZones;
    }
    
    
    /**
     * This method returns whether the specified country, necessary, needs a state.
     *
     * @param IdType $countryId
     *
     * @return bool
     */
    public function isStateMandatory(IdType $countryId)
    {
        return $this->customerCountryReader->isStateMandatory($countryId);
    }
    
    
    /**
     * Finds the country zone by the given zone code and country.
     * Null will be returned if no results are found.
     *
     * @param \CustomerCountryZoneIsoCodeInterface $zoneCode Zone code of expected country zone.
     * @param \CustomerCountryInterface            $country  Country of zone.
     *
     * @return \CustomerCountryZoneInterface|null
     */
    public function findCountryZoneByZoneCodeAndCountry(CustomerCountryZoneIsoCodeInterface $zoneCode,
                                                        CustomerCountryInterface $country)
    {
        return $this->customerCountryZoneReader->findCountryZoneByZoneCodeAndCountry($zoneCode, $country);
    }
    
    
    /**
     * Returns the country zone by the given zone code and country id.
     * Null will be returned if no results are found.
     *
     * @param \CustomerCountryZoneIsoCodeInterface $zoneCode  Zone code of expected country zone.
     * @param \IdType                              $countryId Country id of zone.
     *
     * @return \CustomerCountryZoneInterface
     */
    public function findCountryZoneByZoneCodeAndCountryId(CustomerCountryZoneIsoCodeInterface $zoneCode,
                                                          IdType $countryId)
    {
        return $this->customerCountryZoneReader->findCountryZoneByZoneCodeAndCountryId($zoneCode, $countryId);
    }
}