hiqdev\yii2\cart\Module

Complexity

Total Complexity

15

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Coupling/Cohesion

Components	5
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	11	2
A	registerTranslations()	0	11	1
A	getInstance()	0	4	1
A	getCart()	0	4	1
A	createUrl()	0	7	4
A	setOrderButton()	0	4	1
A	getOrderButton()	0	4	2
A	getPaymentMethods()	0	11	3

<?php

/*
 * Cart module for Yii2
 *
 * @link      https://github.com/hiqdev/yii2-cart
 * @package   yii2-cart
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\yii2\cart;

use Closure;
use Yii;
use yii\base\InvalidConfigException;
use yii\helpers\Url;

/**
 * Cart Module.
 *
 * Example application configuration:
 *
 * ```php
 * 'modules' => [
 *     'cart' => [
 *         'class'  => 'hiqdev\yii2\cart\Module',
 *     ],
 * ],
 * ```
 */
class Module extends \yii\base\Module
{
    /**
     * @var array array of the options that will be passed to [[set]]
     */
    public $shoppingCartOptions = [];

    /**
     * Cart component ID.
     */
    const CART_COMPONENT_ID = 'cart';

    /**
     * {@inheritdoc}
     * @throws \yii\base\InvalidConfigException
     */
    public function init()
    {
        parent::init();
        if (!$this->has(static::CART_COMPONENT_ID)) {
            $this->set(static::CART_COMPONENT_ID, array_merge([
                'class' => 'hiqdev\yii2\cart\ShoppingCart',
            ], $this->shoppingCartOptions));
        }
        $this->get(static::CART_COMPONENT_ID)->module = $this;
        $this->registerTranslations();
    }

    /**
     * Registers translations.
     * @void
     */
    public function registerTranslations()
    {
        Yii::$app->i18n->translations['cart'] = [
            'class'          => 'yii\i18n\PhpMessageSource',
            'sourceLanguage' => 'en-US',
            'basePath'       => __DIR__ . '/messages',
            'fileMap'        => [
                'merchant' => 'cart.php',
            ],
        ];
    }

    /**
     * @var string the module name
     */
    public static $name = 'cart';

    /**
     * Finds cart module.
     * TODO think of how to find NOT by name.
     */
    public static function getInstance()
    {
        return Yii::$app->getModule(static::$name);
    }

    /**
     * @throws \yii\base\InvalidConfigException
     * @return null|\yz\shoppingcart\ShoppingCart|ShoppingCart
     */
    public function getCart()
    {
        return $this->get(static::CART_COMPONENT_ID);
    }

    public function createUrl($route = null)
    {
        $params = is_array($route) ? $route : [$route];
        $params[0] = '/' . $this->id . '/' . (strpos($params[0], '/') !== false ? $params[0] : 'cart/' . ($params[0] ?: 'index'));

        return Url::toRoute($params);
    }

    /**
     * @var string|array route to the terms of use page, suitable for Url::to().
     */
    public $termsPage;

    /**
     * @var string|array route to the order page, suitable for Url::to().
     */
    public $orderPage = ['order'];

    protected $_orderButton;

    public function setOrderButton($value)
    {
        $this->_orderButton = $value;
    }

    public function getOrderButton()
    {
        return $this->_orderButton instanceof Closure ? call_user_func($this->_orderButton, $this) : $this->_orderButton;
    }

    /**
     * @var PaymentMethodsProviderInterface|null
     */
    public $paymentMethodsProvider;

    public function getPaymentMethods()
    {
        if (empty($this->paymentMethodsProvider)) {
            return new InvalidConfigException('Payment methods provider must be set');
        }
        if (!($this->paymentMethodsProvider instanceof PaymentMethodsProviderInterface)) {
            return new InvalidConfigException('Payment methods provider are bad configured');
        }

        return $this->paymentMethodsProvider->getPaymentMethods();
    }
}