1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace NerdsAndCompany\Schematic\Commerce\Services; |
4
|
|
|
|
5
|
|
|
use Craft\Craft; |
6
|
|
|
use Craft\Commerce_ShippingZoneModel; |
7
|
|
|
use NerdsAndCompany\Schematic\Services\Base; |
8
|
|
|
|
9
|
|
|
/** |
10
|
|
|
* Schematic Commerce Shipping Zones Service. |
11
|
|
|
* |
12
|
|
|
* Sync Craft Setups. |
13
|
|
|
* |
14
|
|
|
* @author Nerds & Company |
15
|
|
|
* @copyright Copyright (c) 2015-2017, Nerds & Company |
16
|
|
|
* @license MIT |
17
|
|
|
* |
18
|
|
|
* @see http://www.nerds.company |
19
|
|
|
*/ |
20
|
|
|
class ShippingZones extends Base |
21
|
|
|
{ |
22
|
|
|
/** |
23
|
|
|
* Export shippingZones. |
24
|
|
|
* |
25
|
|
|
* @param ShippingZoneModel[] $shippingZones |
26
|
|
|
* |
27
|
|
|
* @return array |
28
|
|
|
*/ |
29
|
|
|
public function export(array $shippingZones = []) |
30
|
|
|
{ |
31
|
|
|
if (!count($shippingZones)) { |
32
|
|
|
$shippingZones = Craft::app()->commerce_shippingZones->getAllShippingZones(true); |
33
|
|
|
} |
34
|
|
|
|
35
|
|
|
Craft::log(Craft::t('Exporting Commerce Shipping Zones')); |
36
|
|
|
|
37
|
|
|
$shippingZoneDefinitions = []; |
38
|
|
|
|
39
|
|
|
foreach ($shippingZones as $shippingZone) { |
40
|
|
|
$shippingZoneDefinitions[$shippingZone->name] = $this->getShippingZoneDefinition($shippingZone); |
41
|
|
|
} |
42
|
|
|
|
43
|
|
|
return $shippingZoneDefinitions; |
44
|
|
|
} |
45
|
|
|
|
46
|
|
|
/** |
47
|
|
|
* Get shipping zones definition. |
48
|
|
|
* |
49
|
|
|
* @param Commerce_ShippingZoneModel $shippingZone |
50
|
|
|
* |
51
|
|
|
* @return array |
52
|
|
|
*/ |
53
|
|
|
private function getShippingZoneDefinition(Commerce_ShippingZoneModel $shippingZone) |
54
|
|
|
{ |
55
|
|
|
$countries = array(); |
56
|
|
|
foreach ($shippingZone->getCountries() as $country) { |
57
|
|
|
$countries[] = $country->iso; |
58
|
|
|
} |
59
|
|
|
|
60
|
|
|
$states = array(); |
61
|
|
|
foreach ($shippingZone->getStates() as $state) { |
62
|
|
|
$states[] = $state->abbreviation; |
63
|
|
|
} |
64
|
|
|
|
65
|
|
|
return [ |
66
|
|
|
'name' => $shippingZone->name, |
67
|
|
|
'description' => $shippingZone->description, |
68
|
|
|
'countryBased' => $shippingZone->countryBased, |
69
|
|
|
'default' => $shippingZone->default, |
70
|
|
|
'countries' => $countries, |
71
|
|
|
'states' => $states, |
72
|
|
|
]; |
73
|
|
|
} |
74
|
|
|
|
75
|
|
|
/** |
76
|
|
|
* Attempt to import shipping zones. |
77
|
|
|
* |
78
|
|
|
* @param array $shippingZoneDefinitions |
79
|
|
|
* @param bool $force If set to true shipping zones not included in the import will be deleted |
80
|
|
|
* |
81
|
|
|
* @return Result |
82
|
|
|
*/ |
83
|
|
|
public function import(array $shippingZoneDefinitions, $force = false) |
84
|
|
|
{ |
85
|
|
|
Craft::log(Craft::t('Importing Commerce Shipping Zones')); |
86
|
|
|
|
87
|
|
|
$shippingZones = array(); |
88
|
|
|
foreach (Craft::app()->commerce_shippingZones->getAllShippingZones() as $shippingZone) { |
89
|
|
|
$shippingZones[$shippingZone->name] = $shippingZone; |
90
|
|
|
} |
91
|
|
|
|
92
|
|
|
foreach ($shippingZoneDefinitions as $shippingZoneDefinition) { |
93
|
|
|
$shippingZoneHandle = $shippingZoneDefinition['name']; |
94
|
|
|
$shippingZone = array_key_exists($shippingZoneHandle, $shippingZones) |
95
|
|
|
? $shippingZones[$shippingZoneHandle] |
96
|
|
|
: new Commerce_ShippingZoneModel(); |
97
|
|
|
|
98
|
|
|
unset($shippingZones[$shippingZoneHandle]); |
99
|
|
|
|
100
|
|
|
$this->populateShippingZone($shippingZone, $shippingZoneDefinition, $shippingZoneHandle); |
101
|
|
|
|
102
|
|
|
$countryIds = array(); |
103
|
|
|
foreach ($shippingZone->getCountries() as $country) { |
104
|
|
|
$countryIds[] = $country->id; |
105
|
|
|
} |
106
|
|
|
|
107
|
|
|
$stateIds = array(); |
108
|
|
|
foreach ($shippingZone->getStates() as $state) { |
109
|
|
|
$stateIds[] = $state->id; |
110
|
|
|
} |
111
|
|
|
|
112
|
|
|
if (!Craft::app()->commerce_shippingZones->saveShippingZone($shippingZone, $countryIds, $stateIds)) { // Save shippingzone via craft |
113
|
|
|
$this->addErrors($shippingZone->getAllErrors()); |
114
|
|
|
|
115
|
|
|
continue; |
116
|
|
|
} |
117
|
|
|
} |
118
|
|
|
|
119
|
|
|
if ($force) { |
120
|
|
|
foreach ($shippingZones as $shippingZone) { |
121
|
|
|
Craft::app()->commerce_shippingZones->deleteShippingZoneById($shippingZone->id); |
122
|
|
|
} |
123
|
|
|
} |
124
|
|
|
|
125
|
|
|
return $this->getResultModel(); |
126
|
|
|
} |
127
|
|
|
|
128
|
|
|
/** |
129
|
|
|
* Populate shippingZone. |
130
|
|
|
* |
131
|
|
|
* @param Commerce_ShippingZoneModel $shippingZone |
132
|
|
|
* @param array $shippingZoneDefinition |
133
|
|
|
* @param string $shippingZoneHandle |
134
|
|
|
*/ |
135
|
|
|
private function populateShippingZone(Commerce_ShippingZoneModel $shippingZone, array $shippingZoneDefinition, $shippingZoneHandle) |
136
|
|
|
{ |
137
|
|
|
$shippingZone->setAttributes([ |
138
|
|
|
'name' => $shippingZoneHandle, |
139
|
|
|
'description' => $shippingZoneDefinition['description'], |
140
|
|
|
'countryBased' => $shippingZoneDefinition['countryBased'], |
141
|
|
|
'default' => $shippingZoneDefinition['default'], |
142
|
|
|
]); |
143
|
|
|
|
144
|
|
|
$countries = array(); |
145
|
|
|
foreach ($shippingZoneDefinition['countries'] as $iso) { |
146
|
|
|
$countries[] = Craft::app()->commerce_countries->getCountryByAttributes(array('iso' => $iso)); |
147
|
|
|
} |
148
|
|
|
$shippingZone->setCountries($countries); |
149
|
|
|
|
150
|
|
|
$states = array(); |
151
|
|
|
foreach ($shippingZoneDefinition['states'] as $abbreviation) { |
152
|
|
|
$states[] = Craft::app()->commerce_states->getStateByAttributes(array('abbreviation' => $abbreviation)); |
153
|
|
|
} |
154
|
|
|
$shippingZone->setStates($states); |
155
|
|
|
} |
156
|
|
|
} |
157
|
|
|
|