ShippingZones::import() - Code Metrics - Inspection of "Merge pull request #2 from nerds-and-company/devel..." - nerds-and-company/schematic-commerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( eeec88...a15255 )

by Bob Olde

created 2017-04-26 11:15 UTC

ShippingZones::import() C

↳ Parent: ShippingZones

Complexity

Conditions	7
Paths	20

Size

Total Lines	37
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	37
rs	6.7272
c	0
b	0
f	0
cc	7
eloc	21
nc	20
nop	2

<?php

namespace NerdsAndCompany\Schematic\Commerce\Services;

use Craft\Craft;
use Craft\Commerce_ShippingZoneModel;
use NerdsAndCompany\Schematic\Services\Base;

/**
 * Schematic Commerce Shipping Zones Service.
 *
 * Sync Craft Setups.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2017, Nerds & Company
 * @license   MIT
 *
 * @see      http://www.nerds.company
 */
class ShippingZones extends Base
{
    /**
     * Export shippingZones.
     *
     * @param ShippingZoneModel[] $shippingZones
     *
     * @return array
     */
    public function export(array $shippingZones = [])
    {
        if (!count($shippingZones)) {
            $shippingZones = Craft::app()->commerce_shippingZones->getAllShippingZones(true);
        }

        Craft::log(Craft::t('Exporting Commerce Shipping Zones'));

        $shippingZoneDefinitions = [];

        foreach ($shippingZones as $shippingZone) {
            $shippingZoneDefinitions[$shippingZone->name] = $this->getShippingZoneDefinition($shippingZone);
        }

        return $shippingZoneDefinitions;
    }

    /**
     * Get shipping zones definition.
     *
     * @param Commerce_ShippingZoneModel $shippingZone
     *
     * @return array
     */
    private function getShippingZoneDefinition(Commerce_ShippingZoneModel $shippingZone)
    {
        return [
            'name' => $shippingZone->name,
            'description' => $shippingZone->description,
            'countryBased' => $shippingZone->countryBased,
            'default' => $shippingZone->default,
            'countries' => $this->getCountryDefinitions($shippingZone->getCountries()),
            'states' => $this->getStateDefinitions($shippingZone->getStates()),
        ];
    }

    /**
     * Get country definitions.
     *
     * @param Commerce_CountryModel[] $countries
     *
     * @return array
     */
    private function getCountryDefinitions(array $countries)
    {
        $countryDefinitions = [];

        foreach ($countries as $country) {
            $countryDefinitions[] = $country->iso;
        }

        return $countryDefinitions;
    }

    /**
     * Get state definitions.
     *
     * @param Commerce_StateModel[] $states
     *
     * @return array
     */
    private function getStateDefinitions(array $states)
    {
        $stateDefinitions = [];

        foreach ($states as $state) {
            $stateDefinitions[] = $state->abbreviation;
        }

        return $stateDefinitions;
    }

    /**
     * Attempt to import shipping zones.
     *
     * @param array $shippingZoneDefinitions
     * @param bool  $force                   If set to true shipping zones not included in the import will be deleted
     *
     * @return Result
     */
    public function import(array $shippingZoneDefinitions, $force = false)
    {
        Craft::log(Craft::t('Importing Commerce Shipping Zones'));

        $shippingZones = array();
        foreach (Craft::app()->commerce_shippingZones->getAllShippingZones() as $shippingZone) {
            $shippingZones[$shippingZone->name] = $shippingZone;
        }

        foreach ($shippingZoneDefinitions as $shippingZoneDefinition) {
            $shippingZoneHandle = $shippingZoneDefinition['name'];
            $shippingZone = array_key_exists($shippingZoneHandle, $shippingZones)
                ? $shippingZones[$shippingZoneHandle]
                : new Commerce_ShippingZoneModel();

            unset($shippingZones[$shippingZoneHandle]);

            $this->populateShippingZone($shippingZone, $shippingZoneDefinition, $shippingZoneHandle);

            $countryIds = $this->getCountryIds($shippingZone);
            $stateIds = $this->getStateIds($shippingZone);

            if (!Craft::app()->commerce_shippingZones->saveShippingZone($shippingZone, $countryIds, $stateIds)) { // Save shippingzone via craft
                $this->addErrors($shippingZone->getAllErrors());

                continue;
            }
        }

        if ($force) {
            foreach ($shippingZones as $shippingZone) {
                Craft::app()->commerce_shippingZones->deleteShippingZoneById($shippingZone->id);
            }
        }

        return $this->getResultModel();
    }

    /**
     * Populate shippingZone.
     *
     * @param Commerce_ShippingZoneModel $shippingZone
     * @param array                      $shippingZoneDefinition
     * @param string                     $shippingZoneHandle
     */
    private function populateShippingZone(Commerce_ShippingZoneModel $shippingZone, array $shippingZoneDefinition, $shippingZoneHandle)
    {
        $shippingZone->setAttributes([
            'name' => $shippingZoneHandle,
            'description' => $shippingZoneDefinition['description'],
            'countryBased' => $shippingZoneDefinition['countryBased'],
            'default' => $shippingZoneDefinition['default'],
        ]);

        $countries = array();
        foreach ($shippingZoneDefinition['countries'] as $iso) {
            $countries[] = Craft::app()->commerce_countries->getCountryByAttributes(array('iso' => $iso));
        }
        $shippingZone->setCountries($countries);

        $states = array();
        foreach ($shippingZoneDefinition['states'] as $abbreviation) {
            $states[] = Craft::app()->commerce_states->getStateByAttributes(array('abbreviation' => $abbreviation));
        }
        $shippingZone->setStates($states);
    }

    /**
     * Get country ids.
     *
     * @param Commerce_ShippingZoneModel $shippingZone
     *
     * @return array
     */
    private function getCountryIds(Commerce_ShippingZoneModel $shippingZone)
    {
        $countryIds = array();
        foreach ($shippingZone->getCountries() as $country) {
            $countryIds[] = $country->id;
        }

        return $countryIds;
    }

    /**
     * Get state ids.
     *
     * @param Commerce_ShippingZoneModel $shippingZone
     *
     * @return array
     */
    private function getStateIds(Commerce_ShippingZoneModel $shippingZone)
    {
        $stateIds = array();
        foreach ($shippingZone->getStates() as $state) {
            $stateIds[] = $state->id;
        }

        return $stateIds;
    }
}


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			return [
56			'name' => $shippingZone->name,
57			'description' => $shippingZone->description,
58			'countryBased' => $shippingZone->countryBased,
59			'default' => $shippingZone->default,
60			'countries' => $this->getCountryDefinitions($shippingZone->getCountries()),
61			'states' => $this->getStateDefinitions($shippingZone->getStates()),
62			];
63			}
64
65			/**
66			* Get country definitions.
67			*
68			* @param Commerce_CountryModel[] $countries
69			*
70			* @return array
71			*/
72			private function getCountryDefinitions(array $countries)
73			{
74			$countryDefinitions = [];
75
76			foreach ($countries as $country) {
77			$countryDefinitions[] = $country->iso;
78			}
79
80			return $countryDefinitions;
81			}
82
83			/**
84			* Get state definitions.
85			*
86			* @param Commerce_StateModel[] $states
87			*
88			* @return array
89			*/
90			private function getStateDefinitions(array $states)
91			{
92			$stateDefinitions = [];
93
94			foreach ($states as $state) {
95			$stateDefinitions[] = $state->abbreviation;
96			}
97
98			return $stateDefinitions;
99			}
100
101			/**
102			* Attempt to import shipping zones.
103			*
104			* @param array $shippingZoneDefinitions
105			* @param bool $force If set to true shipping zones not included in the import will be deleted
106			*
107			* @return Result
108			*/
109			public function import(array $shippingZoneDefinitions, $force = false)
110			{
111			Craft::log(Craft::t('Importing Commerce Shipping Zones'));
112
113			$shippingZones = array();
114			foreach (Craft::app()->commerce_shippingZones->getAllShippingZones() as $shippingZone) {
115			$shippingZones[$shippingZone->name] = $shippingZone;
116			}
117
118			foreach ($shippingZoneDefinitions as $shippingZoneDefinition) {
119			$shippingZoneHandle = $shippingZoneDefinition['name'];
120			$shippingZone = array_key_exists($shippingZoneHandle, $shippingZones)
121			? $shippingZones[$shippingZoneHandle]
122			: new Commerce_ShippingZoneModel();
123
124			unset($shippingZones[$shippingZoneHandle]);
125
126			$this->populateShippingZone($shippingZone, $shippingZoneDefinition, $shippingZoneHandle);
127
128			$countryIds = $this->getCountryIds($shippingZone);
129			$stateIds = $this->getStateIds($shippingZone);
130
131			if (!Craft::app()->commerce_shippingZones->saveShippingZone($shippingZone, $countryIds, $stateIds)) { // Save shippingzone via craft
132			$this->addErrors($shippingZone->getAllErrors());
133
134			continue;
135			}
136			}
137
138			if ($force) {
139			foreach ($shippingZones as $shippingZone) {
140			Craft::app()->commerce_shippingZones->deleteShippingZoneById($shippingZone->id);
141			}
142			}
143
144			return $this->getResultModel();
145			}
146
147			/**
148			* Populate shippingZone.
149			*
150			* @param Commerce_ShippingZoneModel $shippingZone
151			* @param array $shippingZoneDefinition
152			* @param string $shippingZoneHandle
153			*/
154			private function populateShippingZone(Commerce_ShippingZoneModel $shippingZone, array $shippingZoneDefinition, $shippingZoneHandle)
155			{
156			$shippingZone->setAttributes([
157			'name' => $shippingZoneHandle,
158			'description' => $shippingZoneDefinition['description'],
159			'countryBased' => $shippingZoneDefinition['countryBased'],
160			'default' => $shippingZoneDefinition['default'],
161			]);
162
163			$countries = array();
164			foreach ($shippingZoneDefinition['countries'] as $iso) {
165			$countries[] = Craft::app()->commerce_countries->getCountryByAttributes(array('iso' => $iso));
166			}
167			$shippingZone->setCountries($countries);
168
169			$states = array();
170			foreach ($shippingZoneDefinition['states'] as $abbreviation) {
171			$states[] = Craft::app()->commerce_states->getStateByAttributes(array('abbreviation' => $abbreviation));
172			}
173			$shippingZone->setStates($states);
174			}
175
176			/**
177			* Get country ids.
178			*
179			* @param Commerce_ShippingZoneModel $shippingZone
180			*
181			* @return array
182			*/
183			private function getCountryIds(Commerce_ShippingZoneModel $shippingZone)
184			{
185			$countryIds = array();
186			foreach ($shippingZone->getCountries() as $country) {
187			$countryIds[] = $country->id;
188			}
189
190			return $countryIds;
191			}
192
193			/**
194			* Get state ids.
195			*
196			* @param Commerce_ShippingZoneModel $shippingZone
197			*
198			* @return array
199			*/
200			private function getStateIds(Commerce_ShippingZoneModel $shippingZone)
201			{
202			$stateIds = array();
203			foreach ($shippingZone->getStates() as $state) {
204			$stateIds[] = $state->id;
205			}
206
207			return $stateIds;
208			}
209			}
210

nerds-and-company / schematic-commerce

GitHub Access Token became invalid

Push — master ( eeec88...a15255 )

ShippingZones::import() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like