1 <?php
  2 /* --------------------------------------------------------------
  3    CustomerAddressReader.inc.php 2015-07-06 gm
  4    Gambio GmbH
  5    http://www.gambio.de
  6    Copyright (c) 2015 Gambio GmbH
  7    Released under the GNU General Public License (Version 2)
  8    [http://www.gnu.org/licenses/gpl-2.0.html]
  9    --------------------------------------------------------------
 10 */
 11 
 12 MainFactory::load_class('CustomerAddressReaderInterface');
 13 
 14 /**
 15  * Class CustomerAddressReader
 16  *
 17  * This class is used for reading customer address data from the database
 18  * 
 19  * @category   System
 20  * @package    Customer
 21  * @subpackage Address
 22  * @implements CustomerAddressReaderInterface
 23  */
 24 class CustomerAddressReader implements CustomerAddressReaderInterface
 25 {
 26     /**
 27      * @var CI_DB_query_builder
 28      */
 29     protected $db;
 30     /**
 31      * @var AbstractCustomerFactory
 32      */
 33     protected $customerFactory;
 34     /**
 35      * @var CountryServiceInterface
 36      */
 37     protected $countryService;
 38     /**
 39      * @var StringHelperInterface
 40      */
 41     protected $stringHelper;
 42 
 43 
 44     /**
 45      * Constructor for the class CustomerAddressReader
 46      *
 47      * CrossCuttingLoader dependencies:
 48      * - StringHelper
 49      *
 50      * @param AbstractCustomerFactory $customerFactory
 51      * @param CountryServiceInterface  $countryService
 52      * @param CI_DB_query_builder      $dbQueryBuilder
 53      */
 54     public function __construct(AbstractCustomerFactory $customerFactory, CountryServiceInterface $countryService,
 55                                 CI_DB_query_builder $dbQueryBuilder)
 56     {
 57         $this->customerFactory = $customerFactory;
 58         $this->countryService  = $countryService;
 59         $this->db              = $dbQueryBuilder;
 60 
 61         $this->stringHelper = StaticCrossCuttingLoader::getObject('StringHelper');
 62     }
 63 
 64 
 65     /**
 66      * @param IdType $id
 67      *
 68      * @return CustomerAddress
 69      * @throws InvalidArgumentException
 70      */
 71     public function getById(IdType $id)
 72     {
 73         $address = $this->findById($id);
 74         if($address === null)
 75         {
 76             throw new InvalidArgumentException('No Address found for the given ID.');
 77         }
 78         
 79         return $address;
 80     }
 81 
 82 
 83     /**
 84      * @param IdType $id
 85      * @return CustomerAddress
 86      */
 87     public function findById(IdType $id)
 88     {
 89         $addressDataResult = $this->db->get_where('address_book', array('address_book_id' => (int)(string)$id));
 90         $addressDataArray = $addressDataResult->row_array();
 91         if($addressDataResult->num_rows() == 0)
 92         {
 93             return null;
 94         }
 95         
 96         return $this->_createCustomerAddressByArray($addressDataArray);
 97     }
 98 
 99 
100     /**
101      * This method will return an array of all customer's addresses
102      *
103      * @param CustomerInterface $customer
104      *
105      * @return array containing CustomerAddress objects
106      */
107     public function findAddressesByCustomer(CustomerInterface $customer)
108     {
109         $addressesArray = $this->db->get_where('address_book', array('customers_id' => $customer->getId()))
110                                    ->result_array();
111 
112         foreach($addressesArray as &$address)
113         {
114             $address = $this->_createCustomerAddressByArray($address);
115         }
116 
117         return $addressesArray;
118     }
119 
120 
121     /**
122      * Get all system addresses. 
123      */
124     public function getAllAddresses()
125     {
126         $addressesArray = $this->db->get('address_book')->result_array();
127         
128         foreach($addressesArray as &$address)
129         {
130             $address = $this->_createCustomerAddressByArray($address); 
131         }
132         
133         return $addressesArray; 
134     }
135 
136     
137     /**
138      * Filter existing addresses by keyword. 
139      * 
140      * This method is useful when creating a search mechanism for the registered addresses.
141      * 
142      * @param string $p_keyword The keyword to be used for filtering the records.
143      *                          
144      * @return array Returns an array of CustomerAddress objects.
145      */
146     public function filterAddresses($p_keyword)
147     {       
148         // CodeIgniter DB library will automatically escape the keyword. 
149         
150         $this->db->like('entry_gender', $p_keyword);
151         $this->db->or_like('entry_company', $p_keyword);
152         $this->db->or_like('entry_firstname', $p_keyword);
153         $this->db->or_like('entry_lastname', $p_keyword);
154         $this->db->or_like('entry_street_address', $p_keyword);
155         $this->db->or_like('entry_suburb', $p_keyword);
156         $this->db->or_like('entry_postcode', $p_keyword);
157         $this->db->or_like('entry_city', $p_keyword);
158         $this->db->or_like('entry_state', $p_keyword);
159         
160         $addressesArray = $this->db->get('address_book')->result_array(); 
161         
162         foreach($addressesArray as &$address)
163         {
164             $address = $this->_createCustomerAddressByArray($address); 
165         }
166         
167         return $addressesArray;
168     }
169 
170     /**
171      * @param array $addressDataArray
172      *
173      * @return CustomerAddress
174      */
175     protected function _createCustomerAddressByArray(array $addressDataArray)
176     {
177         $addressDataArray = $this->stringHelper->convertNullValuesToStringInArray($addressDataArray);
178 
179         $customerAddress = $this->customerFactory->createCustomerAddress();
180         $customerAddress->setId(new IdType((int)$addressDataArray['address_book_id']));
181         $customerAddress->setCustomerId(new IdType($addressDataArray['customers_id']));
182         $customerAddress->setGender(MainFactory::create('CustomerGender', $addressDataArray['entry_gender']));
183         $customerAddress->setCompany(MainFactory::create('CustomerCompany', $addressDataArray['entry_company']));
184         $customerAddress->setB2BStatus(MainFactory::create('CustomerB2BStatus', (bool)(int)$addressDataArray['customer_b2b_status']));
185         $customerAddress->setFirstname(MainFactory::create('CustomerFirstname', $addressDataArray['entry_firstname']));
186         $customerAddress->setLastname(MainFactory::create('CustomerLastname', $addressDataArray['entry_lastname']));
187         $customerAddress->setStreet(MainFactory::create('CustomerStreet', $addressDataArray['entry_street_address']));
188         $customerAddress->setSuburb(MainFactory::create('CustomerSuburb', $addressDataArray['entry_suburb']));
189         $customerAddress->setPostcode(MainFactory::create('CustomerPostcode', $addressDataArray['entry_postcode']));
190         $customerAddress->setCity(MainFactory::create('CustomerCity', $addressDataArray['entry_city']));
191 
192         $country = $this->countryService->getCountryById(new IdType(
193                                                                              $addressDataArray['entry_country_id']));
194         $customerAddress->setCountry($country);
195 
196         $state = MainFactory::create('CustomerCountryZoneName', $addressDataArray['entry_state']);
197 
198         if($this->countryService->countryHasCountryZones($country) && (string)$state !== '')
199         {
200             $countryZone = $this->countryService->getCountryZoneByNameAndCountry($state, $country);
201         }
202         else
203         {
204             $countryZone = $this->customerFactory->createCustomerCountryZone(new IdType(0), 
205                                                                              $state,
206                                                                              MainFactory::create('CustomerCountryZoneIsoCode', ''));
207         }
208 
209         $customerAddress->setCountryZone($countryZone);
210 
211         return $customerAddress;
212     }
213 }

API documentation generated by ApiGen