EcommerceTaskTryToFinaliseOrders::run() - Code Metrics - Inspection of "MINOR: better use of isCli" - sunnysideup/silverstripe-ecommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 27e2c5...e639df )

by Nicolaas

created 2017-02-10 01:23 UTC

EcommerceTaskTryToFinaliseOrders::run() F

↳ Parent: EcommerceTaskTryToFinaliseOrders

Complexity

Conditions	13
Paths	720

Size

Total Lines	70
Code Lines	49

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	13
eloc	49
nc	720
nop	1
dl	0
loc	70
rs	2.8571
c	0
b	0
f	0

How to fix Long Method Complexity

<?php


/**
 * @description: cleans up old (abandonned) carts...
 *
 *
 * @authors: Nicolaas [at] Sunny Side Up .co.nz
 * @package: ecommerce
 * @sub-package: tasks
 * @inspiration: Silverstripe Ltd, Jeremy
 **/
class EcommerceTaskTryToFinaliseOrders extends BuildTask
namespace YourVendor;

class YourClass { }
{
    protected $sendEmails = true;

    protected $limit = 1;

    protected $title = 'Try to finalise all orders - WILL SEND EMAILS';

    protected $description = '
        This task can be useful in moving a bunch of orders through the latest order step.
        It will only move orders if they can be moved through order steps.
        You may need to run this task several times to move all orders.';

    /**
     * @param SS_Request $request
     **/
    public function run($request)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        //IMPORTANT!
        if ( ! $this->sendEmails) {
            Config::inst()->update('Email', 'send_all_emails_to', 'no-one@localhost');
            Email::set_mailer(new Ecommerce_Dummy_Mailer());

        }

        //get limits
        $limit = null;
        if (isset($_GET['limit'])) {
            $limit = intval($_GET['limit']);
        }
        if (!intval($limit)) {
            $limit = $this->limit;
        }
        $startAt = null;
        if (isset($_GET['startat'])) {
            $startAt = intval($_GET['startat']);
        }
        if (!intval($startAt)) {
            $startAt = intval(Session::get('EcommerceTaskTryToFinaliseOrders'));
            if (!$startAt) {
                $startAt = 0;
            }
        }
        $queueObjectSingleton = Injector::inst()->get('OrderProcessQueue');
        $ordersinQueue = $queueObjectSingleton->OrdersToBeProcessed(0);
        //find any other order that may need help ...

        $submittedOrderStatusLogClassName = EcommerceConfig::get('OrderStatusLog', 'order_status_log_class_used_for_submitting_order');
        if ($submittedOrderStatusLogClassName) {
            $submittedStatusLog = $submittedOrderStatusLogClassName::get()->First();
            if ($submittedStatusLog) {
                $lastOrderStep = OrderStep::get()->Last();
                if ($lastOrderStep) {
                    if($this->isCli()) {
                        $sort = 'RAND()';
                    } else {
                        $sort = array('ID' => 'ASC');
                    }
                    $orders = Order::get()
                        ->sort($sort)
                        ->where('StatusID <> ' . $lastOrderStep->ID)
                        ->exclude(array('ID' => $ordersinQueue->column('ID')))
                        ->innerJoin(
                            'OrderStatusLog',
                            "\"OrderStatusLog\".\"OrderID\" = \"Order\".\"ID\""
                        )
                        ->innerJoin(
                            $submittedOrderStatusLogClassName,
                            "\"$submittedOrderStatusLogClassName\".\"ID\" = \"OrderStatusLog\".\"ID\""
                        );
                    $startAt = $this->tryToFinaliseOrders($orders, $limit, $startAt);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                } else {
                    DB::alteration_message('NO  order step.', 'deleted');
                }
            } else {
                DB::alteration_message('NO submitted order status log.', 'deleted');
            }
        } else {
            DB::alteration_message('NO EcommerceConfig::get("OrderStatusLog", "order_status_log_class_used_for_submitting_order")', 'deleted');
        }
        if (Session::get('EcommerceTaskTryToFinaliseOrders')) {
            if(! $this->isCli()) {
                DB::alteration_message('WAIT: we are still moving more orders ... this page will automatically load the next lot in 5 seconds.', 'deleted');
                echo '<script type="text/javascript">window.setTimeout(function() {location.reload();}, 5000);</script>';
            }
        }
    }


    protected function tryToFinaliseOrders($orders, $limit, $startAt)

    {
        $orders = $orders->limit($limit, $startAt);
        if ($orders->count()) {
            DB::alteration_message("<h1>Moving $limit Orders (starting from $startAt)</h1>");
            foreach ($orders as $order) {
                ++$startAt;
                Session::set('EcommerceTaskTryToFinaliseOrders', $startAt);
                $stepBefore = OrderStep::get()->byID($order->StatusID);
                try {
                    $order->tryToFinaliseOrder();
                } catch (Exception $e) {
                    DB::alteration_message($e, 'deleted');
                }
                $stepAfter = OrderStep::get()->byID($order->StatusID);
                if ($stepBefore) {
                    if ($stepAfter) {
                        if ($stepBefore->ID == $stepAfter->ID) {
                            DB::alteration_message('could not move Order '.$order->getTitle().', remains at <strong>'.$stepBefore->Name.'</strong>');
                        } else {
                            DB::alteration_message('Moving Order #'.$order->getTitle().' from <strong>'.$stepBefore->Name.'</strong> to <strong>'.$stepAfter->Name.'</strong>', 'created');
                        }
                    } else {
                        DB::alteration_message('Moving Order '.$order->getTitle().' from  <strong>'.$stepBefore->Name.'</strong> to <strong>unknown step</strong>', 'deleted');
                    }
                } elseif ($stepAfter) {
                    DB::alteration_message('Moving Order '.$order->getTitle().' from <strong>unknown step</strong> to <strong>'.$stepAfter->Name.'</strong>', 'deleted');
                } else {
                    DB::alteration_message('Moving Order '.$order->getTitle().' from <strong>unknown step</strong> to <strong>unknown step</strong>', 'deleted');
                }
            }
        } else {
            Session::clear('EcommerceTaskTryToFinaliseOrders');
            DB::alteration_message('<br /><br /><br /><br /><h1>COMPLETED!</h1>All orders have been moved.', 'created');
        }

        return $startAt;
    }

    protected function isCli()
    {
        return Director::is_cli();
    }

}


1			<?php
2
3
4			/**
5			* @description: cleans up old (abandonned) carts...
6			*
7			*
8			* @authors: Nicolaas [at] Sunny Side Up .co.nz
9			* @package: ecommerce
10			* @sub-package: tasks
11			* @inspiration: Silverstripe Ltd, Jeremy
12			**/
13			class EcommerceTaskTryToFinaliseOrders extends BuildTask
			0 ignored issues – show Coding Style Compatibility introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
14			{
15			protected $sendEmails = true;
16
17			protected $limit = 1;
18
19			protected $title = 'Try to finalise all orders - WILL SEND EMAILS';
20
21			protected $description = '
22			This task can be useful in moving a bunch of orders through the latest order step.
23			It will only move orders if they can be moved through order steps.
24			You may need to run this task several times to move all orders.';
25
26			/**
27			* @param SS_Request $request
28			**/
29			public function run($request)
			0 ignored issues – show Coding Style introduced 2016-10-31 23:06 UTC by Report Bug Copy Issue Report `run` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
30			{
31			//IMPORTANT!
32			if ( ! $this->sendEmails) {
33			Config::inst()->update('Email', 'send_all_emails_to', 'no-one@localhost');
34			Email::set_mailer(new Ecommerce_Dummy_Mailer());
			0 ignored issues – show Deprecated Code introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report The method `Email::set_mailer()` has been deprecated with message: since version 4.0 This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
35			}
36
37			//get limits
38			$limit = null;
39			if (isset($_GET['limit'])) {
40			$limit = intval($_GET['limit']);
41			}
42			if (!intval($limit)) {
43			$limit = $this->limit;
44			}
45			$startAt = null;
46			if (isset($_GET['startat'])) {
47			$startAt = intval($_GET['startat']);
48			}
49			if (!intval($startAt)) {
50			$startAt = intval(Session::get('EcommerceTaskTryToFinaliseOrders'));
51			if (!$startAt) {
52			$startAt = 0;
53			}
54			}
55			$queueObjectSingleton = Injector::inst()->get('OrderProcessQueue');
56			$ordersinQueue = $queueObjectSingleton->OrdersToBeProcessed(0);
57			//find any other order that may need help ...
58
59			$submittedOrderStatusLogClassName = EcommerceConfig::get('OrderStatusLog', 'order_status_log_class_used_for_submitting_order');
60			if ($submittedOrderStatusLogClassName) {
61			$submittedStatusLog = $submittedOrderStatusLogClassName::get()->First();
62			if ($submittedStatusLog) {
63			$lastOrderStep = OrderStep::get()->Last();
64			if ($lastOrderStep) {
65			if($this->isCli()) {
66			$sort = 'RAND()';
67			} else {
68			$sort = array('ID' => 'ASC');
69			}
70			$orders = Order::get()
71			->sort($sort)
72			->where('StatusID <> ' . $lastOrderStep->ID)
73			->exclude(array('ID' => $ordersinQueue->column('ID')))
74			->innerJoin(
75			'OrderStatusLog',
76			"\"OrderStatusLog\".\"OrderID\" = \"Order\".\"ID\""
77			)
78			->innerJoin(
79			$submittedOrderStatusLogClassName,
80			"\"$submittedOrderStatusLogClassName\".\"ID\" = \"OrderStatusLog\".\"ID\""
81			);
82			$startAt = $this->tryToFinaliseOrders($orders, $limit, $startAt);
			0 ignored issues – show Unused Code introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report `$startAt` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
83			} else {
84			DB::alteration_message('NO order step.', 'deleted');
85			}
86			} else {
87			DB::alteration_message('NO submitted order status log.', 'deleted');
88			}
89			} else {
90			DB::alteration_message('NO EcommerceConfig::get("OrderStatusLog", "order_status_log_class_used_for_submitting_order")', 'deleted');
91			}
92			if (Session::get('EcommerceTaskTryToFinaliseOrders')) {
93			if(! $this->isCli()) {
94			DB::alteration_message('WAIT: we are still moving more orders ... this page will automatically load the next lot in 5 seconds.', 'deleted');
95			echo '<script type="text/javascript">window.setTimeout(function() {location.reload();}, 5000);</script>';
96			}
97			}
98			}
99
100
101			protected function tryToFinaliseOrders($orders, $limit, $startAt)
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
102			{
103			$orders = $orders->limit($limit, $startAt);
104			if ($orders->count()) {
105			DB::alteration_message("<h1>Moving $limit Orders (starting from $startAt)</h1>");
106			foreach ($orders as $order) {
107			++$startAt;
108			Session::set('EcommerceTaskTryToFinaliseOrders', $startAt);
109			$stepBefore = OrderStep::get()->byID($order->StatusID);
110			try {
111			$order->tryToFinaliseOrder();
112			} catch (Exception $e) {
113			DB::alteration_message($e, 'deleted');
114			}
115			$stepAfter = OrderStep::get()->byID($order->StatusID);
116			if ($stepBefore) {
117			if ($stepAfter) {
118			if ($stepBefore->ID == $stepAfter->ID) {
119			DB::alteration_message('could not move Order '.$order->getTitle().', remains at <strong>'.$stepBefore->Name.'</strong>');
120			} else {
121			DB::alteration_message('Moving Order #'.$order->getTitle().' from <strong>'.$stepBefore->Name.'</strong> to <strong>'.$stepAfter->Name.'</strong>', 'created');
122			}
123			} else {
124			DB::alteration_message('Moving Order '.$order->getTitle().' from <strong>'.$stepBefore->Name.'</strong> to <strong>unknown step</strong>', 'deleted');
125			}
126			} elseif ($stepAfter) {
127			DB::alteration_message('Moving Order '.$order->getTitle().' from <strong>unknown step</strong> to <strong>'.$stepAfter->Name.'</strong>', 'deleted');
128			} else {
129			DB::alteration_message('Moving Order '.$order->getTitle().' from <strong>unknown step</strong> to <strong>unknown step</strong>', 'deleted');
130			}
131			}
132			} else {
133			Session::clear('EcommerceTaskTryToFinaliseOrders');
134			DB::alteration_message('<br /><br /><br /><br /><h1>COMPLETED!</h1>All orders have been moved.', 'created');
135			}
136
137			return $startAt;
138			}
139
140			protected function isCli()
141			{
142			return Director::is_cli();
143			}
144
145			}
146

sunnysideup / silverstripe-ecommerce

Push — master ( 27e2c5...e639df )

EcommerceTaskTryToFinaliseOrders::run() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like