NerdsAndCompany\Schematic\Commerce\Services\ShippingZones

Complexity

Total Complexity

22

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	export()	0	16	3
A	getShippingZoneDefinition()	0	11	1
A	getCountryDefinitions()	0	10	2
A	getStateDefinitions()	0	10	2
C	import()	0	37	7
A	populateShippingZone()	0	21	3
A	getCountryIds()	0	9	2
A	getStateIds()	0	9	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;
    }
}