1: <?php
  2: 
  3: /*
  4: 
  5:  *
  6:  * NOTICE OF LICENSE
  7:  *
  8:  * This source file is subject to the Open Software License (OSL 3.0)
  9:  * or OpenGPL v3 license (GNU Public License V3.0)
 10:  * that is bundled with this package in the file LICENSE.txt.
 11:  * It is also available through the world-wide-web at this URL:
 12:  * http://opensource.org/licenses/osl-3.0.php
 13:  * or
 14:  * http://www.gnu.org/licenses/gpl-3.0.txt
 15:  * If you did not receive a copy of the license and are unable to
 16:  * obtain it through the world-wide-web, please send an email
 17:  * to info@e-abi.ee so we can send you a copy immediately.
 18:  *
 19:  * DISCLAIMER
 20:  *
 21:  * Do not edit or add to this file if you wish to upgrade this module to newer
 22:  * versions in the future.
 23:  *
 24:  * @category   Eabi
 25:  * @package    Eabi_Dpd
 26:  * @copyright  Copyright (c) 2014 Aktsiamaailm LLC (http://en.e-abi.ee/)
 27:  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 28:  * @license    http://www.gnu.org/licenses/gpl-3.0.txt  GNU Public License V3.0
 29:  * @author     Matis Halmann
 30:  * 
 31:  
 32:  */
 33: 
 34: /**
 35:  * <p>Helper class for DPD shipping method related actions</p>
 36:  *
 37:  * @author Matis Halmann
 38:  */
 39: class Eabi_DpdEE_Helper_Data extends Mage_Core_Helper_Abstract {
 40:     protected $_apis = array();
 41: 
 42:     /**
 43:      * <p>Gets cached DPD API instance for specified Magento store id and shipping method code.</p>
 44:      * @param string $storeId store id to fetch the api for
 45:      * @param string $code shipping method code to fetch the api for
 46:      * @return Eabi_DpdEE_Model_Api
 47:      */
 48:     public function getApi($storeId = null, $code = 'eabidpdee') {
 49:         if ($storeId === null) {
 50:             $storeId = Mage::app()->getStore($storeId)->getId();
 51:         }
 52:         if (isset($this->_apis[$code]) && isset($this->_apis[$code][$storeId])) {
 53:             return $this->_apis[$code][$storeId];
 54:         }
 55:         if (!isset($this->_apis[$code])) {
 56:             $this->_apis[$code] = array();
 57:         }
 58:         $api = Mage::getModel('eabi_dpdee/api');
 59:         $api->setStore($storeId);
 60:         $api->setCode($code);
 61:         $this->_apis[$code][$storeId] = $api;
 62:         return $this->_apis[$code][$storeId];
 63:     }
 64:     
 65:     
 66:     /**
 67:      * Returns true if shipping method used in the order belongs to DPD carrier
 68:      * @param Mage_Sales_Model_Order $order
 69:      */
 70:     public function isShippingMethodApplicable(Mage_Sales_Model_Order $order) {
 71:         return strpos($order->getShippingMethod(), 'eabidpdee') === 0;
 72:     }
 73:     
 74:     
 75:     
 76:     /**
 77:      * <p>Converts DPD op=pudo Opening Times into human readable format.</p>
 78:      * <ul>
 79:          <li><b>Input: 1:11:0:16:0,2:7:30:20:0,3:7:30:20:0,4:7:30:20:0,5:7:30:20:0,6:7:30:20:0,7:8:0:16:0</b></li>
 80:          <li><b>Result: (E-R 7:30-20; L 8-16; P 11-16)</b></li>
 81:      </ul>
 82:      * 
 83:      * @param string $dpdOpeningDescription DPD Openings description
 84:      * @param Zend_Locale $locale Locale which is used to print out weekday names
 85:      * @return string
 86:      */
 87:     public function getOpeningsDescriptionFromTerminal($dpdOpeningDescription, $locale = null) {
 88:         $openingTimeFormat = 'H:m';
 89:         $displayTimeFormat = 'H:mm';
 90:         
 91:         if (!$locale) {
 92:             $locale = Mage::app()->getLocale()->getLocaleCode();
 93:         }
 94:         
 95:         //days  start from monday
 96:         $passThruOrder = array('2', '3', '4', '5', '6', '7', '1');
 97:         
 98:         /*
 99:          * Format: array key = weekday name
100:          */
101:         $openingDescriptions = array();
102:         
103:         //we need these in order to get times in normalized manner
104:         $startTime = new Zend_Date(0, Zend_Date::TIMESTAMP);
105:         $endTime = new Zend_Date(0, Zend_Date::TIMESTAMP);
106:         
107:         //here are comma separeted opening times
108:         $openings = explode(',', $dpdOpeningDescription);
109:         /*
110:          * Format:
111:          * <weekday>:<starth>:<startm>:<endh>:<endm>
112:          * 1=sunday
113:          * 2=monday
114:          * ...
115:          * 7=saturday
116:          * 
117:          */
118:         foreach ($openings as $opening) {
119:             $openTimePartials = explode(':', $opening);
120:             $startTime->set($openTimePartials[1].':'.$openTimePartials[2], $openingTimeFormat);
121:             $endTime->set($openTimePartials[3].':'.$openTimePartials[4], $openingTimeFormat);
122:             
123:             if (!isset($openingDescriptions[(string)$openTimePartials[0]])) {
124:                 $openingDescriptions[(string)$openTimePartials[0]] = array();
125:             }
126:             $openingDescriptions[(string)$openTimePartials[0]][] = str_replace(':00', '', $startTime->get($displayTimeFormat)) .'-'. str_replace(':00', '', $endTime->get($displayTimeFormat));
127:             
128:         }
129:         
130:         
131:         /*
132:          * Format:
133:          * array key = day of week digit
134:          * array value = all opening times for that day separated by comma
135:          */
136:         $finalOpeningDescriptions = array();
137:         $previusOpeningStatement = false;
138:         $previusWeekdayName = false;
139:         $firstElement = false;
140:         
141:         
142:         foreach ($passThruOrder as $dayOfWeekDigit) {
143:             $startTime->set($dayOfWeekDigit - 1, Zend_Date::WEEKDAY_DIGIT);
144: 
145:             $weekDayName = $startTime->get(Zend_Date::WEEKDAY_NARROW, $locale);
146:             if ($firstElement === false) {
147:                 $firstElement = $previusWeekdayName;
148:             }
149:             if (isset($openingDescriptions[$dayOfWeekDigit])) {
150:                 
151:                 $openingStatement = str_replace('0-0', '0-24', implode(',', $openingDescriptions[$dayOfWeekDigit]));
152:             } else {
153:                 $openingStatement = '';
154:             }
155:             
156:             if ($previusOpeningStatement !== false && $previusOpeningStatement != $openingStatement) {
157:                 //we have a change
158:                 if ($firstElement != $previusWeekdayName) {
159:                     $finalOpeningDescriptions[] = $firstElement.'-'.$previusWeekdayName.' '.$previusOpeningStatement;
160:                 } else {
161:                     $finalOpeningDescriptions[] = $previusWeekdayName.' '.$previusOpeningStatement;
162:                 }
163:                 
164:                 
165:                 $firstElement = false;
166:             }
167:             $previusOpeningStatement = $openingStatement;
168:             $previusWeekdayName = $weekDayName;
169:             
170:         }
171:         if ($previusOpeningStatement !== false) {
172:             if ($previusOpeningStatement !== '') {
173:                 //we have a change
174:                 if (!$firstElement) {
175:                     $finalOpeningDescriptions[] = $previusWeekdayName . ' ' . $previusOpeningStatement;
176:                 } else {
177:                     $finalOpeningDescriptions[] = $firstElement . '-' . $previusWeekdayName . ' ' . $previusOpeningStatement;
178:                 }
179:             }
180:         }
181:         
182:         if (count($finalOpeningDescriptions)) {
183:             return '('.implode('; ', $finalOpeningDescriptions).')';
184:         }
185:         return '';
186:     }
187:     
188: 
189: }
190: 
191: