gplcart\modules\shippo\Shippo

Complexity

Total Complexity

16

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	hookLibraryList()	0	19	1
A	hookRouteList()	0	17	1
A	hookUserRolePermissions()	0	4	1
A	hookOrderCalculateBefore()	0	4	1
A	hookOrderSubmitBefore()	0	4	1
A	hookShippingMethods()	0	4	1
A	hookModuleEnableAfter()	0	4	1
A	hookModuleDisableAfter()	0	4	1
A	hookModuleInstallAfter()	0	4	1
A	hookModuleUninstallAfter()	0	4	1
A	hookModuleInstallBefore()	0	6	2
A	getShippoModel()	0	6	1
A	setShippingMethods()	0	15	2

<?php

/**
 * @package Shippo
 * @author Iurii Makukh <gplcart.software@gmail.com>
 * @copyright Copyright (c) 2017, Iurii Makukh <gplcart.software@gmail.com>
 * @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
 */

namespace gplcart\modules\shippo;

use gplcart\core\Module,
    gplcart\core\Config;

/**
 * Main class for Shippo module
 */
class Shippo extends Module
{

    /**
     * @param Config $config
     */
    public function __construct(Config $config)
    {
        parent::__construct($config);
    }

    /**
     * Implements hook "library.list"
     * @param array $libraries
     */
    public function hookLibraryList(array &$libraries)
    {
        $libraries['shippo'] = array(
            'name' => /* @text */'Shippo',
            'description' => /* @text */'Shipping API PHP library (USPS, FedEx, UPS and more)',
            'url' => 'https://github.com/goshippo/shippo-php-client',
            'download' => 'https://github.com/goshippo/shippo-php-client/archive/v1.3.2.zip',
            'type' => 'php',
            'version_source' => array(
                'lines' => 2,
                'pattern' => '/.*(\\d+\\.+\\d+\\.+\\d+)/',
                'file' => 'vendor/shippo/shippo-php/VERSION'
            ),
            'module' => 'shippo',
            'files' => array(
                'vendor/autoload.php'
            )
        );
    }

    /**
     * Implements hook "route.list"
     * @param array $routes
     */
    public function hookRouteList(array &$routes)
    {
        $routes['admin/module/settings/shippo'] = array(
            'access' => 'module_edit',
            'handlers' => array(
                'controller' => array('gplcart\\modules\\shippo\\controllers\\Settings', 'editSettings')
            )
        );

        $routes['admin/tool/shippo'] = array(
            'access' => 'shippo_label',
            'menu' => array('admin' => /* @text */'Shipping labels'),
            'handlers' => array(
                'controller' => array('gplcart\\modules\\shippo\\controllers\\Label', 'listLabel')
            )
        );
    }

    /**
     * Implements hook "user.role.permissions"
     * @param array $permissions
     */
    public function hookUserRolePermissions(array &$permissions)
    {
        $permissions['shippo_label'] = /* @text */'Shippo: view and buy labels';
    }

    /**
     * Implements hook "order.calculate.before"
     * @param mixed $data
     */
    public function hookOrderCalculateBefore(array &$data)
    {
        $this->getShippoModel()->calculate($data);
    }

    /**
     * Implements hook "order.submit.before"
     * @param array $order
     * @param array $options
     * @param array $result
     */
    public function hookOrderSubmitBefore(&$order, $options, &$result)
    {
        $this->getShippoModel()->validate($order, $options, $result);
    }

    /**
     * Implements hook "shipping.methods"
     * @param mixed $methods
     */
    public function hookShippingMethods(array &$methods)
    {
        $this->setShippingMethods($methods);
    }

    /**
     * Implements hook "module.enable.after"
     */
    public function hookModuleEnableAfter()
    {
        $this->getLibrary()->clearCache();
    }

    /**
     * Implements hook "module.disable.after"
     */
    public function hookModuleDisableAfter()
    {
        $this->getLibrary()->clearCache();
    }

    /**
     * Implements hook "module.install.after"
     */
    public function hookModuleInstallAfter()
    {
        $this->getLibrary()->clearCache();
    }

    /**
     * Implements hook "module.uninstall.after"
     */
    public function hookModuleUninstallAfter()
    {
        $this->getLibrary()->clearCache();
    }

    /**
     * Implements hook "module.install.before"
     * @param mixed $result
     */
    public function hookModuleInstallBefore(&$result)
    {
        if (!function_exists('curl_init')) {
            $result = $this->getLanguage()->text('CURL library is not enabled');
        }
    }

    /**
     * Returns Shippo's model instance
     * @return \gplcart\modules\shippo\models\Shippo
     */
    public function getShippoModel()
    {
        /* @var $model \gplcart\modules\shippo\models\Shippo */
        $model = $this->getModel('Shippo', 'shippo');
        return $model;
    }

    /**
     * Sets module shipping methods
     * @param array $methods
     */
    protected function setShippingMethods(array &$methods)
    {
        $language = $this->getLanguage();
        $settings = $this->config->getFromModule('shippo');

        foreach ($this->getShippoModel()->getServiceNames() as $id => $info) {
            list($carrier, $service) = $info;
            $methods["shippo_$id"] = array(
                'dynamic' => true,
                'module' => 'shippo',
                'status' => in_array("shippo_$id", $settings['enabled']),
                'title' => $language->text('@carrier - @service', array('@carrier' => $carrier, '@service' => $service))
            );
        }
    }

}