Cart - Code Metrics - Inspection of "add namespaces, add injiStorage driver, create dri..." - injitools/cms-Inji - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Branch — v5 (12d602)

by Alexey

created 2018-01-07 15:27 UTC

Cart D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	499
Duplicated Lines	5.21 %

Coupling/Cohesion

Components	2
Dependencies	8

Importance

Changes

Metric	Value
dl	26
loc	499
rs	4.8717
c	0
b	0
f	0
wmc	82
lcom	2
cbo	8

17 Methods

Rating	Name	Duplication	Size	Complexity
A	indexes()	0	23	1
A	relations()	0	61	1
B	beforeDelete()	0	14	5
A	itemName()	0	3	1
B	availablePricesTypes()	0	16	6
C	buildOrderInfo()	20	39	7
C	checkStage()	0	29	12
B	needDelivery()	0	8	6
C	deliverySum()	0	28	12
A	hasDiscount()	0	3	2
A	discountSum()	0	7	3
A	finalSum()	0	6	1
A	itemsSum()	0	11	4
C	addItem()	6	31	7
C	removeItem()	0	27	7
A	calc()	0	5	2
B	availablePayTypes()	0	14	5

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Cart often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Cart, and based on these observations, apply Extract Interface, too.

<?php

/**
 * Cart
 *
 * @author Alexey Krupskiy <[email protected]>
 * @link http://inji.ru/
 * @copyright 2015 Alexey Krupskiy
 * @license https://github.com/injitools/cms-Inji/blob/master/LICENSE
 */

namespace Ecommerce;
/**
 * Class Cart
 *
 * @property int $id
 * @property int $user_id
 * @property int $cart_status_id
 * @property int $delivery_id
 * @property int $paytype_id
 * @property int $card_item_id
 * @property bool $warehouse_block
 * @property bool $payed
 * @property string $comment
 * @property bool $exported
 * @property string $complete_data
 * @property string $date_status
 * @property string $date_last_activ
 * @property string $date_create
 *
 * @property-read \Users\User $user
 * @property-read \Ecommerce\Cart\Item[] $cartItems
 * @property-read \Ecommerce\Cart\Event[] $events
 * @property-read \Ecommerce\Cart\Status $status
 * @property-read \Ecommerce\Delivery $delivery
 * @property-read \Ecommerce\PayType $payType
 * @property-read \Ecommerce\Cart\Info[] $infos
 * @property-read \Ecommerce\Cart\DeliveryInfo[] $deliveryInfos
 * @property-read \Ecommerce\Cart\Extra[] $extras
 * @property-read \Ecommerce\Card\Item $card
 * @property-read \Money\Pay[] $pays
 * @property-read \Ecommerce\Cart\Discount[] $discounts
 *
 * @method \Users\User user($options)($options)
 * @method \Ecommerce\Cart\Item[] cartItems($options)
 * @method \Ecommerce\Cart\Event[] events($options)
 * @method \Ecommerce\Cart\Status status($options)
 * @method \Ecommerce\Delivery delivery($options)
 * @method \Ecommerce\PayType payType($options)
 * @method \Ecommerce\Cart\Info[] infos($options)
 * @method \Ecommerce\Cart\DeliveryInfo[] deliveryInfos($options)
 * @method \Ecommerce\Cart\Extra[] extras($options)
 * @method \Ecommerce\Card\Item card($options)
 * @method \Money\Pay[] pays($options)
 * @method \Ecommerce\Cart\Discount[] discounts($options)
 */
class Cart extends \Model {

    public static $logging = false;
    public static $objectName = 'Корзины';

    public static function indexes() {
        return [
            'ecommerce_cartStatusBlock' => [
                'type' => 'INDEX',
                'cols' => [
                    'cart_cart_status_id',
                    'cart_warehouse_block'
                ]
            ],
            'ecommerce_cartStats' => [
                'type' => 'INDEX',
                'cols' => [
                    'cart_cart_status_id',
                ]
            ],
            'ecommerce_cartBlock' => [
                'type' => 'INDEX',
                'cols' => [
                    'cart_warehouse_block'
                ]
            ],
        ];
    }

    public static function relations() {
        return [
            'user' => [
                'model' => 'Users\User',
                'col' => 'user_id'
            ],
            'cartItems' => [
                'type' => 'many',
                'model' => 'Ecommerce\Cart\Item',
                'col' => 'cart_id',
            ],
            'events' => [
                'type' => 'many',
                'model' => 'Ecommerce\Cart\Event',
                'col' => 'cart_id',
            ],
            'status' => [
                'model' => 'Ecommerce\Cart\Status',
                'col' => 'cart_status_id'
            ],
            'delivery' => [
                'model' => 'Ecommerce\Delivery',
                'col' => 'delivery_id'
            ],
            'payType' => [
                'model' => 'Ecommerce\PayType',
                'col' => 'paytype_id'
            ],
            'infos' => [
                'type' => 'many',
                'model' => 'Ecommerce\Cart\Info',
                'col' => 'cart_id',
                'resultKey' => 'useradds_field_id'
            ],
            'deliveryInfos' => [
                'type' => 'many',
                'model' => 'Ecommerce\Cart\DeliveryInfo',
                'col' => 'cart_id',
                'resultKey' => 'delivery_field_id'
            ],
            'extras' => [
                'type' => 'many',
                'model' => 'Ecommerce\Cart\Extra',
                'col' => 'cart_id'
            ],
            'card' => [
                'model' => 'Ecommerce\Card\Item',
                'col' => 'card_item_id'
            ],
            'pays' => [
                'type' => 'many',
                'model' => 'Money\Pay',
                'col' => 'data'
            ],
            'discounts' => [
                'type' => 'relModel',
                'relModel' => 'Ecommerce\Cart\Discount',
                'model' => 'Ecommerce\Discount',
            ]
        ];
    }

    public function beforeDelete() {
        foreach ($this->cartItems as $cartItem) {
            $cartItem->delete();
        }
        foreach ($this->infos as $info) {
            $info->delete();
        }
        foreach ($this->extras as $extra) {
            $extra->delete();
        }
        foreach ($this->events as $event) {
            $event->delete();
        }
    }

    public static $labels = [
        'user_id' => 'Пользователь',
        'cart_status_id' => 'Статус',
        'delivery_id' => 'Доставка',
        'comment' => 'Комментарий',
        'bonus_used' => 'Выгодные рубли',
        'complete_data' => 'Время заказа',
        'info' => 'Информация',
        'items' => 'Товары',
        'paytype_id' => 'Способ оплаты',
        'payed' => 'Оплачен',
        'exported' => 'Выгружено',
        'warehouse_block' => 'Блокировка товаров',
        'extra' => 'Доп.',
        'card_item_id' => 'Дисконтная карта',
        'info' => 'Информация',
        'contacts' => 'Информация',
        'pay' => 'Счета',
        'sums' => 'Суммы',
        'deliveryInfo' => 'Для доставки',
        'discount' => 'Скидки',
    ];
    public static $cols = [
        //Основные параметры
        'user_id' => ['type' => 'select', 'source' => 'relation', 'relation' => 'user'],
        'cart_status_id' => ['type' => 'select', 'source' => 'relation', 'relation' => 'status'],
        'delivery_id' => ['type' => 'select', 'source' => 'relation', 'relation' => 'delivery'],
        'paytype_id' => ['type' => 'select', 'source' => 'relation', 'relation' => 'payType'],
        'card_item_id' => ['type' => 'select', 'source' => 'relation', 'relation' => 'card'],
        'warehouse_block' => ['type' => 'bool'],
        'payed' => ['type' => 'bool'],
        'comment' => ['type' => 'textarea'],
        //Системные
        'exported' => ['type' => 'bool'],
        'complete_data' => ['type' => 'dateTime', 'null' => true, 'emptyValue' => null],
        'date_status' => ['type' => 'dateTime', 'null' => true, 'emptyValue' => null],
        'date_last_activ' => ['type' => 'dateTime', 'null' => true, 'emptyValue' => null, 'logging' => false],
        'date_create' => ['type' => 'dateTime'],
        //Виджеты
        'sums' => [
            'type' => 'void',
            'view' => [
                'type' => 'widget',
                'widget' => 'Ecommerce\adminSums',
            ],
        ],
        'contacts' => [
            'type' => 'void',
            'view' => [
                'type' => 'widget',
                'widget' => 'Ecommerce\admin/contacts',
            ],
        ],
        //Менеджеры
        'extra' => ['type' => 'dataManager', 'relation' => 'extras'],
        'pay' => ['type' => 'dataManager', 'relation' => 'pays'],
        'items' => ['type' => 'dataManager', 'relation' => 'cartItems'],
        'info' => ['type' => 'dataManager', 'relation' => 'infos'],
        'deliveryInfo' => ['type' => 'dataManager', 'relation' => 'deliveryInfos'],
        'discount' => ['type' => 'dataManager', 'relation' => 'discounts'],
    ];
    public static $dataManagers = [
        'manager' => [
            'cols' => [
                'contacts',
                'items',
                'extra',
                'discount',
                'sums',
                'cart_status_id',
                'delivery_id',
                'deliveryInfo',
                'payed',
                'pay',
                'complete_data',
            ],
            'sortable' => [
                'cart_status_id',
                'delivery_id',
                'payed',
                'complete_data',
            ],
            'filters' => [
                'cart_status_id',
                'delivery_id',
                'payed',
                'complete_data',
            ],
            'preSort' => [
                'complete_data' => 'desc'
            ],
            'actions' => [
                'Ecommerce\CloseCartBtn', 'Open', 'Edit', 'Delete'
            ]
        ]
    ];

    public static function itemName($item) {
        return $item->pk() . '. ' . $item->name();
    }

    public static $forms = [
        'manager' => [
            'inputs' => [
                'userSearch' => [
                    'type' => 'search',
                    'source' => 'relation',
                    'relation' => 'user',
                    'label' => 'Покупатель',
                    'cols' => [
                        'info:first_name',
                        'info:last_name',
                        'info:middle_name',
                        'mail'
                    ],
                    'col' => 'user_id',
                    'required' => true,
                    'showCol' => [
                        'type' => 'staticMethod',
                        'class' => 'Ecommerce\Cart',
                        'method' => 'itemName',
                    ],
                ],
                'cardSearch' => [
                    'type' => 'search',
                    'source' => 'relation',
                    'relation' => 'card',
                    'label' => 'Дисконтная карта',
                    'cols' => [
                        'code',
                        'user:info:first_name',
                        'user:info:last_name',
                        'user:info:middle_name',
                        'user:mail'
                    ],
                    'col' => 'card_item_id',
                ],
            ],
            'map' => [
                ['userSearch', 'cart_status_id'],
                ['paytype_id', 'delivery_id'],
                ['cardSearch', 'comment'],
                ['warehouse_block', 'complete_data'],
                ['payed'],
                ['items'],
                ['extra'],
                ['pay'],
                ['info'],
                ['deliveryInfo']
            ]
        ],
    ];

    /**
     * @return true|array
     */
    public function availablePricesTypes() {
        $types = \App::$cur->ecommerce->availablePricesTypes();
        if ($types === true) {
            return true;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
        foreach (Card::getList() as $card) {
            foreach ($this->cartItems as $cartItem) {
                if ($cartItem->item_offer_price_id == $card->item_offer_price_id) {
                    foreach ($card->prices as $priceType) {
                        $types[$priceType->id] = $priceType->id;
                    }
                }
            }
        }
        return $types;
    }

    public function buildOrderInfo() {
        $orderInfo = '<h3>Товары</h3>';
        $orderInfo .= '<table cellspacing="2" border="1" cellpadding="5"><tr><th>Товар</th><th>Артикул</th><th>Кол-во</th><th>Цена</th><th>Сумма</th></tr>';
        foreach ($this->cartItems as $cartItem) {
            $orderInfo .= "<tr>";
            $orderInfo .= "<td><a href='" . \App::$cur->getDomain() . "{$cartItem->item->getHref()}'>{$cartItem->name()}</a></td>";
            $orderInfo .= "<td>{$cartItem->price->offer->article}</td>";
            $orderInfo .= "<td>{$cartItem->count}</td>";
            $orderInfo .= "<td>{$cartItem->final_price}</td>";
            $orderInfo .= "<td>" . ($cartItem->final_price * $cartItem->count) . "</td>";
            $orderInfo .= "</tr>";
        }
        $orderInfo .= '</table>';
        if ($this->infos) {

            $orderInfo .= '<h3>Контакты</h3>';
            $orderInfo .= '<table cellspacing="2" border="1" cellpadding="5">';
            $orderInfo .= "<tr><td>E-mail</td><td><b>{$this->user->mail}</b></td></tr>";
            foreach ($this->infos as $info) {
                $value = \Model::resloveTypeValue($info, 'value');
                $orderInfo .= "<tr><td>{$info->name}</td><td><b>{$value}</b></td></tr>";
            }
            $orderInfo .= '</table>';
        }
        if ($this->delivery) {

            $orderInfo .= '<h3>Информация о доставке</h3>';
            $orderInfo .= "<p><b>{$this->delivery->name}</b></p>";
            $orderInfo .= '<table cellspacing="2" border="1" cellpadding="5">';
            foreach ($this->deliveryInfos as $info) {
                $value = \Model::resloveTypeValue($info, 'value');
                $orderInfo .= "<tr><td>{$info->name}</td><td><b>{$value}</b></td></tr>";
            }
            $orderInfo .= '</table>';
        }
        if ($this->payType) {
            $orderInfo .= '<h3>Способ оплаты</h3>';
            $orderInfo .= "<p><b>{$this->payType->name}</b></p>";
        }
        return $orderInfo;
    }

    public function checkStage() {
        $sum = $this->itemsSum();
        $stages = Cart\Stage::getList(['order' => ['sum', 'asc']]);
        $groups = [];
        foreach ($stages as $stage) {
            if ($sum->greater(new \Money\Sums([$stage->currency_id => $stage->sum])) || $sum->equal(new \Money\Sums([$stage->currency_id => $stage->sum]))) {
                $groups[$stage->group] = $stage;
            }
        }
        $discounts = Cart\Discount::getList(['where' => ['cart_id', $this->id]]);
        foreach ($discounts as $discount) {
            if (!isset($groups[$discount->group]) && $discount->auto) {
                $discount->delete();
            }
            if (isset($groups[$discount->group]) && $groups[$discount->group]->type == 'discount') {
                $discount->discount_id = $groups[$discount->group]->value;
                $discount->save();
                unset($groups[$discount->group]);
            }
        }
        foreach ($groups as $group) {
            if ($group && $group->type == 'discount') {
                $rel = $this->addRelation('discounts', $group->value);
                $rel->auto = true;
                $rel->group = 'discount';
                $rel->save();
            }
        }
    }

    public function needDelivery() {
        foreach ($this->cartItems as $cartItem) {
            if ((!$cartItem->item->type && !empty(\App::$cur->ecommerce->config['defaultNeedDelivery'])) || ($cartItem->item->type && $cartItem->item->type->delivery)) {
                return true;
            }
        }
        return false;
    }

    public function deliverySum() {
        $sum = new \Money\Sums([0 => 0]);
        if ($this->delivery && $this->needDelivery()) {
            $sums = $this->itemsSum();
            $deliveryPrice = new \Money\Sums([$this->delivery->currency_id => $this->delivery->max_cart_price]);
            if ($this->delivery->max_cart_price && $sums->greater($deliveryPrice) || $sums->equal($deliveryPrice)) {
                $sum->sums = [$this->delivery->currency_id => 0];
            } else if ($this->delivery->prices) {

                foreach ($this->delivery->prices(['order' => ['cart_price', 'asc']]) as $delPrice) {
                    $deliveryPrice = new \Money\Sums([$delPrice->currency_id => $delPrice->cart_price]);
                    if ($sums->greater($deliveryPrice) || $sums->equal($deliveryPrice)) {
                        $sum->sums = [$delPrice->currency_id => $delPrice->price];
                    }
                }
                if (!$sum->sums) {
                    $sum->sums = [$this->delivery->currency_id => $this->delivery->price];
                }
            } else {
                if (!$this->delivery->provider) {
                    $sum->sums = [$this->delivery->currency_id => $this->delivery->price];
                } else {
                    $className = 'Ecommerce\DeliveryProvider\\' . $this->delivery->provider->object;
                    $sum = $className::calcPrice($this);
                }
            }
        }
        return $sum;
    }

    public function hasDiscount() {
        return (bool) $this->card || $this->discounts;

    }

    public function discountSum() {
        $sums = [];
        foreach ($this->cartItems as $cartItem) {
            $sums[$cartItem->price->currency_id] = isset($sums[$cartItem->price->currency_id]) ? $sums[$cartItem->price->currency_id] + $cartItem->discount() * $cartItem->count : $cartItem->discount() * $cartItem->count;
        }
        return new \Money\Sums($sums);
    }

    public function finalSum() {
        $sums = $this->itemsSum();
        $sums = $sums->minus($this->discountSum());
        $sums = $sums->plus($this->deliverySum());
        return $sums;
    }

    public function itemsSum() {
        $cart = Cart::get($this->id);
        $sums = [];
        foreach ($cart->cartItems as $cartItem) {
            if (!$cartItem->price) {
                continue;
            }
            $sums[$cartItem->price->currency_id] = isset($sums[$cartItem->price->currency_id]) ? $sums[$cartItem->price->currency_id] + $cartItem->price->price * $cartItem->count : $cartItem->price->price * $cartItem->count;
        }
        return new \Money\Sums($sums);
    }

    public function addItem($offer_price_id, $count = 1, $final_price = 0) {
        $price = Item\Offer\Price::get((int) $offer_price_id);

        if (!$price) {
            return false;
        }

        if ($count <= 0) {
            $count = 1;
        }

        $cartItem = new Cart\Item();
        $cartItem->cart_id = $this->id;
        $cartItem->item_id = $price->offer->item->id;
        $cartItem->count = $count;
        $cartItem->item_offer_price_id = $price->id;
        $cartItem->final_price = $final_price ? $final_price : $price->price;
        $cartItem->save();
        $card = Card::get($price->item_offer_id, 'item_offer_id');
        if ($card && $card->prices) {
            $this->loadRelation('cartItems');
            foreach ($this->cartItems as $cartItem) {

                $price = $cartItem->price->offer->getPrice($this);
                $cartItem->item_offer_price_id = $price->id;
                $cartItem->final_price = $price->price;
                $cartItem->save();
            }
            $this->loadRelation('cartItems');
        }
        return true;
    }

    public function removeItem($offer_price_id, $count = 1, $final_price = 0) {
        $price = Item\Offer\Price::get((int) $offer_price_id);

        if (!$price) {
            return false;
        }

        if ($count <= 0) {
            $count = 1;
        }

        $cartItem = new Cart\Item();
        $cartItem->cart_id = $this->id;
        $cartItem->item_id = $price->offer->item->id;
        $cartItem->count = $count;
        $cartItem->item_offer_price_id = $price->id;
        $cartItem->final_price = $final_price ? $final_price : $price->price;
        $cartItem->save();
        $card = Card::get($price->item_offer_id, 'item_offer_id');
        if ($card && $card->prices) {
            foreach ($this->cartItems as $cartItem) {
                $cartItem->item_offer_price_id = $cartItem->price->offer->getPrice($this);
                $cartItem->save();
            }
        }
        return true;
    }

    public function calc($save = true) {
        if ($save) {
            $this->save();
        }
    }

    public function availablePayTypes() {
        if (!$this->delivery) {
            return \Ecommerce\PayType::getList(['order' => ['weight', 'ASC']]);
        }
        $providerHelper = $this->delivery->providerHelper();
        if (!$providerHelper) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return \Ecommerce\PayType::getList(['order' => ['weight', 'ASC']]);
        }
        $payTypeGroups = $providerHelper::availablePayTypeGroups($this);
        if (!$payTypeGroups || $payTypeGroups[0] === '*') {
            return \Ecommerce\PayType::getList(['order' => ['weight', 'ASC']]);
        }
        return \Ecommerce\PayType::getList(['where' => ['group', $payTypeGroups, 'IN'], 'order' => ['weight', 'ASC']]);
    }
}


injitools / cms-Inji