EcommerceTaskTryToFinaliseOrders

Complexity

Total Complexity

21

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
F	run()	0	68	12
C	tryToFinaliseOrders()	0	38	8
A	IsCli()	0	4	1

<?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

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    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)

run uses the super-global variable $_GET which is generally not recommended.

    {
        //IMPORTANT!
        if ( ! $this->sendEmails) {
            Config::inst()->update('Email', 'send_all_emails_to', 'no-one@localhost');
            Email::set_mailer(new Ecommerce_Dummy_Mailer());

The method Email::set_mailer() has been deprecated with message: since version 4.0

        }

        //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);

$startAt is not used, you could remove the assignment.

                } 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')) {
            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)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $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 php_sapi_name() == 'cli';
    }

}