OrderStep_WhitelistCustomer

Complexity

Total Complexity

10

Size/Duplication

Total Lines	123
Duplicated Lines	4.88 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getCMSFields()	0	6	1
A	initStep()	0	4	1
A	doStep()	6	17	3
A	nextStep()	0	8	2
A	hasCustomerMessage()	0	4	1
A	myDescription()	0	4	1
A	HideFromEveryone()	0	4	1

<?php

class OrderStep_WhitelistCustomer extends OrderStep implements OrderStepInterface

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

{
    private static $defaults = array(

Consider using a different property name as you override a private property of the parent class.

The property $defaults is not used and could be removed.

        'CustomerCanEdit' => 0,
        'CustomerCanCancel' => 0,
        'CustomerCanPay' => 0,
        'Name' => 'Whitelist Customer',
        'Code' => 'WHITELIST_CUSTOMER',
        'ShowAsInProcessOrder' => 1,
        'HideStepFromCustomer' => 1
    );

    /**
     * The OrderStatusLog that is relevant to the particular step.
     *
     * @var string
     */
    protected $relevantLogEntryClassName = 'OrderStatusLog_WhitelistCustomer';

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        return $fields;
    }

    /**
     * initStep:
     * 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 true;
    }

    /**
     *
     *
     * @var null | bool
     */
    private $_completed = null;

    /**
     * doStep:
     * should only be able to run this function once
     * (init stops you from running it twice - in theory....)
     * runs the actual step.
     *
     * @see Order::doNextStatus
     *
     * @param Order object
     *
     * @return bool - true if run correctly.

Should the return type not be null|boolean?

     **/
    public function doStep(Order $order)
    {
        if ($this->_completed !== null) {
            return $this->_completed;
        }
        $entry = $this->RelevantLogEntry($order);
        if (! $entry) {

This code seems to be duplicated across your project.

            $className = $this->relevantLogEntryClassName;
            $entry = $className::create();
            $entry->OrderID = $order->ID;
            $entry->write();
        }
        $entry->assessCustomer();
        $this->_completed = true;

It seems like true of type boolean is incompatible with the declared type null of property $_completed.

        return $this->_completed;
    }

    /**
     *nextStep:
     * returns the next step (after it checks if everything is in place for the next step to run...).
     *
     * @see Order::doNextStatus
     *
     * @param Order $order
     *
     * @return OrderStep | Null (next step OrderStep object)

Should the return type not be OrderStep|null?

     **/
    public function nextStep(Order $order)
    {
        if ($this->doStep($order)) {
            return parent::nextStep($order);
        }

        return;
    }

    /**
     * For some ordersteps this returns true...
     *
     * @return bool
     **/
    protected function hasCustomerMessage()
    {
        return false;
    }

    /**
     * Explains the current order step.
     *
     * @return string
     */
    protected function myDescription()
    {
        return 'Whitelist a customer if they qualify for this.';
    }

    public function HideFromEveryone()
    {
        return true;
    }
}