OrderTotalCalculator::calculate() - Code Metrics - Inspection of "Merge pull request #729 from shoosah/bugfix/config..." - silvershop/silvershop-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3c661d...2a57f9 )

by Will

created 2019-11-22 02:31 UTC

OrderTotalCalculator::calculate() F

↳ Parent: OrderTotalCalculator

Complexity

Conditions	14
Paths	769

Size

Total Lines	72
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	14
eloc	38
nc	769
nop	0
dl	0
loc	72
rs	2.4208
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

namespace SilverShop\Cart;

use ErrorException;
use Exception;
use Monolog\Logger;
use SilverShop\Model\Order;
use SilverStripe\Core\ClassInfo;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\ORM\DB;

/**
 * Handles the calculation of order totals.
 *
 * Creates (if necessary) and calculates values for each modifier,
 * and subsequently the total of the order.
 * Caches to prevent recalculation, unless dirty.
 */
class OrderTotalCalculator
{
    use Injectable;

    private static $dependencies = [

        'logger' => '%$SilverShop\Logger',
    ];

    /**
     * @var Logger
     */
    public $logger;

    /**
     * @var Order
     */
    protected $order;

    function __construct(Order $order)
    {
        $this->order = $order;
    }

    /**
     * @return float
     * @throws Exception
     * @throws \Psr\Container\NotFoundExceptionInterface
     */
    function calculate()

    {
        $runningtotal = $this->order->SubTotal();
        $sort = 1;
        $existingmodifiers = $this->order->Modifiers();
        $modifierclasses = array_unique(Order::config()->modifiers);

        //check if modifiers are even in use
        if (!is_array($modifierclasses) || empty($modifierclasses)) {

            return $runningtotal;
        }

        if (DB::get_conn()->supportsTransactions()) {
            DB::get_conn()->transactionStart();
        }

        set_error_handler(
            function ($severity, $message, $file, $line) {
                throw new ErrorException($message, 0, $severity, $file, $line);
            },
            E_ALL & ~(E_STRICT | E_NOTICE)
        );

        try {
            foreach ($modifierclasses as $ClassName) {
                if ($modifier = $this->getModifier($ClassName)) {
                    $modifier->Sort = $sort;
                    $runningtotal = $modifier->modify($runningtotal);
                    if ($modifier->isChanged()) {
                        $modifier->write();
                    }
                }
                $sort++;
            }
            //clear old modifiers out
            if ($existingmodifiers) {
                foreach ($existingmodifiers as $modifier) {
                    if (!in_array($modifier->ClassName, $modifierclasses)) {
                        $modifier->delete();
                        $modifier->destroy();
                    }
                }
            }
        } catch (Exception $ex) {
            // Rollback the transaction if an error occurred
            if (DB::get_conn()->supportsTransactions()) {
                DB::get_conn()->transactionRollback();
            }
            // throw the exception after rollback
            throw $ex;
        } finally {
            // restore the error handler, no matter what
            restore_error_handler();
        }

        // Everything went through fine, complete the transaction
        if (DB::get_conn()->supportsTransactions()) {
            DB::get_conn()->transactionEnd();
        }

        //prevent negative sales from ever occurring
        if ($runningtotal < 0) {
            $this->logger->error(
                "Order (ID = {$this->order->ID}) was calculated to equal $runningtotal.\n
                Order totals should never be negative!\n
                The order total was set to $0"
            );

            $runningtotal = 0;
        }

        return $runningtotal;
    }

    /**
     * Retrieve a modifier of a given class for the order.
     * Modifier will be retrieved from database if it already exists,
     * or created if it is always required.
     *
     * @param string  $className
     * @param boolean $forcecreate - force the modifier to be created.
     */
    public function getModifier($className, $forcecreate = false)
    {
        if (!ClassInfo::exists($className)) {
            user_error("Modifier class \"$className\" does not exist.");
        }
        //search for existing
        $modifier = $className::get()
            ->filter("OrderID", $this->order->ID)
            ->first();
        if ($modifier) {
            //remove if no longer valid
            if (!$modifier->valid()) {
                //TODO: need to provide feedback message - why modifier was removed
                $modifier->delete();
                $modifier->destroy();
                return null;
            }
            return $modifier;
        }
        $modifier = new $className();
        if ($modifier->required() || $forcecreate) { //create any modifiers that are required for every order
            $modifier->OrderID = $this->order->ID;
            $modifier->write();
            $this->order->Modifiers()->add($modifier);

            return $modifier;
        }

        return null;
    }
}


1			<?php
2
3			namespace SilverShop\Cart;
4
5			use ErrorException;
6			use Exception;
7			use Monolog\Logger;
8			use SilverShop\Model\Order;
9			use SilverStripe\Core\ClassInfo;
10			use SilverStripe\Core\Injector\Injectable;
11			use SilverStripe\ORM\DB;
12
13			/**
14			* Handles the calculation of order totals.
15			*
16			* Creates (if necessary) and calculates values for each modifier,
17			* and subsequently the total of the order.
18			* Caches to prevent recalculation, unless dirty.
19			*/
20			class OrderTotalCalculator
21			{
22			use Injectable;
23
24			private static $dependencies = [
			0 ignored issues – show introduced 2018-02-08 22:43 UTC by Report Bug Copy Issue Report The private property `$dependencies` is not used, and could be removed. Loading history...
25			'logger' => '%$SilverShop\Logger',
26			];
27
28			/**
29			* @var Logger
30			*/
31			public $logger;
32
33			/**
34			* @var Order
35			*/
36			protected $order;
37
38			function __construct(Order $order)
39			{
40			$this->order = $order;
41			}
42
43			/**
44			* @return float
45			* @throws Exception
46			* @throws \Psr\Container\NotFoundExceptionInterface
47			*/
48			function calculate()
			0 ignored issues – show Best Practice introduced 2018-02-04 17:27 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
49			{
50			$runningtotal = $this->order->SubTotal();
51			$sort = 1;
52			$existingmodifiers = $this->order->Modifiers();
53			$modifierclasses = array_unique(Order::config()->modifiers);
54
55			//check if modifiers are even in use
56			if (!is_array($modifierclasses) \|\| empty($modifierclasses)) {
			0 ignored issues – show introduced 2019-11-22 02:13 UTC by Report Bug Copy Issue Report The condition `is_array($modifierclasses)` is always `true`. Loading history...
57			return $runningtotal;
58			}
59
60			if (DB::get_conn()->supportsTransactions()) {
61			DB::get_conn()->transactionStart();
62			}
63
64			set_error_handler(
65			function ($severity, $message, $file, $line) {
66			throw new ErrorException($message, 0, $severity, $file, $line);
67			},
68			E_ALL & ~(E_STRICT \| E_NOTICE)
69			);
70
71			try {
72			foreach ($modifierclasses as $ClassName) {
73			if ($modifier = $this->getModifier($ClassName)) {
74			$modifier->Sort = $sort;
75			$runningtotal = $modifier->modify($runningtotal);
76			if ($modifier->isChanged()) {
77			$modifier->write();
78			}
79			}
80			$sort++;
81			}
82			//clear old modifiers out
83			if ($existingmodifiers) {
84			foreach ($existingmodifiers as $modifier) {
85			if (!in_array($modifier->ClassName, $modifierclasses)) {
86			$modifier->delete();
87			$modifier->destroy();
88			}
89			}
90			}
91			} catch (Exception $ex) {
92			// Rollback the transaction if an error occurred
93			if (DB::get_conn()->supportsTransactions()) {
94			DB::get_conn()->transactionRollback();
95			}
96			// throw the exception after rollback
97			throw $ex;
98			} finally {
99			// restore the error handler, no matter what
100			restore_error_handler();
101			}
102
103			// Everything went through fine, complete the transaction
104			if (DB::get_conn()->supportsTransactions()) {
105			DB::get_conn()->transactionEnd();
106			}
107
108			//prevent negative sales from ever occurring
109			if ($runningtotal < 0) {
110			$this->logger->error(
111			"Order (ID = {$this->order->ID}) was calculated to equal $runningtotal.\n
112			Order totals should never be negative!\n
113			The order total was set to $0"
114			);
115
116			$runningtotal = 0;
117			}
118
119			return $runningtotal;
120			}
121
122			/**
123			* Retrieve a modifier of a given class for the order.
124			* Modifier will be retrieved from database if it already exists,
125			* or created if it is always required.
126			*
127			* @param string $className
128			* @param boolean $forcecreate - force the modifier to be created.
129			*/
130			public function getModifier($className, $forcecreate = false)
131			{
132			if (!ClassInfo::exists($className)) {
133			user_error("Modifier class \"$className\" does not exist.");
134			}
135			//search for existing
136			$modifier = $className::get()
137			->filter("OrderID", $this->order->ID)
138			->first();
139			if ($modifier) {
140			//remove if no longer valid
141			if (!$modifier->valid()) {
142			//TODO: need to provide feedback message - why modifier was removed
143			$modifier->delete();
144			$modifier->destroy();
145			return null;
146			}
147			return $modifier;
148			}
149			$modifier = new $className();
150			if ($modifier->required() \|\| $forcecreate) { //create any modifiers that are required for every order
151			$modifier->OrderID = $this->order->ID;
152			$modifier->write();
153			$this->order->Modifiers()->add($modifier);
154
155			return $modifier;
156			}
157
158			return null;
159			}
160			}
161

silvershop / silvershop-core

Push — master ( 3c661d...2a57f9 )

OrderTotalCalculator::calculate() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like