OrderStep_QuickDispatch::initStep() - Code Metrics - Inspection of "ADDING CODE" - sunnysideup/silverstripe-ecommerce_quick_dispatch - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 23aac3...27533a )

by Nicolaas

created 2017-07-18 09:30 UTC

OrderStep_QuickDispatch::initStep() A

↳ Parent: OrderStep_QuickDispatch

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php



class OrderStep_QuickDispatch extends OrderStep_Sent implements OrderStepInterface
namespace YourVendor;

class YourClass { }
{

    private static $defaults = array(

        'CustomerCanEdit' => 0,
        'CustomerCanPay' => 0,
        'CustomerCanCancel' => 0,
        'Name' => 'Dispatch',
        'Code' => 'QUICK_DISPATCH',
        'ShowAsInProcessOrder' => 1,
    );


    /**
     * Can run this step once any items have been submitted.
     * makes sure the step is ready to run.... (e.g. check if the order is ready to be emailed as receipt).
     * should be able to run this function many times to check if the step is ready.
     *
     * @see Order::doNextStatus
     *
     * @param Order object
     *
     * @return bool - true if the current step is ready to be run...
     **/
    public function initStep(Order $order)
    {
        return parent::initStep($order);
    }

     /**
      * Add a member to the order - in case he / she is not a shop admin.
      *
      * @param Order object
      *
      * @return bool - true if run correctly.

      **/
     public function doStep(Order $order)
     {
         if($order->HasBeenDispatched) {
            if ( ! $this->RelevantLogEntry($order)) {
                 $log = OrderStatusLog_DispatchPhysicalOrder::create();
                 $log->OrderID = $order->ID;
                 $log->write();
            }
         }
         return parent::doStep($order);
     }

    /**
     * go to next step if order has been submitted.
     *
     * @param Order $order
     *
     * @return OrderStep | Null	(next step OrderStep)

     **/
    public function nextStep(Order $order)
    {
        return parent::nextStep($order);
    }


    /**
     * Explains the current order step.
     *
     * @return string
     */
    protected function myDescription()
    {
        return _t('OrderStep.QUICKDISPATCH_DESCRIPTION', 'The order is on its way to the customer.');
    }



}


1			<?php
2
3
4
5			class OrderStep_QuickDispatch extends OrderStep_Sent implements OrderStepInterface
			0 ignored issues – show Coding Style Compatibility introduced 2017-07-18 09:33 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...
6			{
7
8			private static $defaults = array(
			0 ignored issues – show Comprehensibility introduced 2017-07-18 09:33 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-07-18 09:33 UTC by Report Bug Copy Issue Report The property `$defaults` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
9			'CustomerCanEdit' => 0,
10			'CustomerCanPay' => 0,
11			'CustomerCanCancel' => 0,
12			'Name' => 'Dispatch',
13			'Code' => 'QUICK_DISPATCH',
14			'ShowAsInProcessOrder' => 1,
15			);
16
17
18			/**
19			* Can run this step once any items have been submitted.
20			* makes sure the step is ready to run.... (e.g. check if the order is ready to be emailed as receipt).
21			* should be able to run this function many times to check if the step is ready.
22			*
23			* @see Order::doNextStatus
24			*
25			* @param Order object
26			*
27			* @return bool - true if the current step is ready to be run...
28			**/
29			public function initStep(Order $order)
30			{
31			return parent::initStep($order);
32			}
33
34			/**
35			* Add a member to the order - in case he / she is not a shop admin.
36			*
37			* @param Order object
38			*
39			* @return bool - true if run correctly.
			0 ignored issues – show Documentation introduced 2017-07-18 09:33 UTC by Report Bug Copy Issue Report Should the return type not be `boolean\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
40			**/
41			public function doStep(Order $order)
42			{
43			if($order->HasBeenDispatched) {
44			if ( ! $this->RelevantLogEntry($order)) {
45			$log = OrderStatusLog_DispatchPhysicalOrder::create();
46			$log->OrderID = $order->ID;
47			$log->write();
48			}
49			}
50			return parent::doStep($order);
51			}
52
53			/**
54			* go to next step if order has been submitted.
55			*
56			* @param Order $order
57			*
58			* @return OrderStep \| Null (next step OrderStep)
			0 ignored issues – show Documentation introduced 2017-07-18 09:33 UTC by Report Bug Copy Issue Report Should the return type not be `OrderStep\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
59			**/
60			public function nextStep(Order $order)
61			{
62			return parent::nextStep($order);
63			}
64
65
66			/**
67			* Explains the current order step.
68			*
69			* @return string
70			*/
71			protected function myDescription()
72			{
73			return _t('OrderStep.QUICKDISPATCH_DESCRIPTION', 'The order is on its way to the customer.');
74			}
75
76
77
78			}
79

sunnysideup / silverstripe-ecommerce_quick_dispatch

Push — master ( 23aac3...27533a )

OrderStep_QuickDispatch::initStep() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like