OrderStep_SendAdminNotification

Complexity

Total Complexity

8

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	initStep()	0	8	2
A	doStep()	0	11	1
A	nextStep()	0	8	2
A	addOrderStepFields()	0	8	1
A	hasCustomerMessage()	0	4	1
A	myDescription()	0	7	1

<?php


/**
 * @authors: Nicolaas [at] Sunny Side Up .co.nz
 * @package: ecommerce
 * @sub-package: model
 * @inspiration: Silverstripe Ltd, Jeremy
 **/
class OrderStep_SendAdminNotification extends OrderStep implements OrderStepInterface
{
    /**
     * @var string
     */
    protected $emailClassName = 'Order_ReceiptEmail';

    private static $defaults = array(

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

        'CustomerCanEdit' => 0,
        'CustomerCanCancel' => 0,
        'CustomerCanPay' => 1,
        'Name' => 'Send Admin Notification',
        'Code' => 'ADMINNOTIFIED',
        'ShowAsInProcessOrder' => 1,
    );

    /**
     * can run step once order has been submitted.
     *
     * @param Order object
     *
     * @return bool - true if the current step is ready to be run...
     **/
    public function initStep(Order $order)
    {
        if ($order->IsSubmitted()) {

This if statement, and the following return statement can be replaced with return $order->IsSubmitted();.

            return true;
        }

        return false;
    }

    /**
     * send invoice to customer
     * or in case this is not selected, it will send a message to the shop admin only
     * The latter is useful in case the payment does not go through (and no receipt is received).
     *
     * @param DataObject $order Order
     *
     * @return bool
     **/
    public function doStep(Order $order)
    {
        return $this->sendEmailForStep(
            $order,
            $subject = $this->EmailSubject,

The property EmailSubject does not exist on object<OrderStep_SendAdminNotification>. Since you implemented __set, maybe consider adding a @property annotation.

            $message = '',
            $resend = false,
            $adminOnlyOrToEmail = true,
            $this->getEmailClassName()
        );
    }

    /**
     * can do next step once the admin notification has been sent
     *
     * @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->hasBeenSent($order)) {
            return parent::nextStep($order);
        }

        return;
    }

    /**
     * Allows the opportunity for the Order Step to add any fields to Order::getCMSFields.
     *
     *@param FieldList $fields
     *@param Order $order
     *
     *@return FieldList
     **/
    public function addOrderStepFields(FieldList $fields, Order $order)
    {
        $fields = parent::addOrderStepFields($fields, $order);
        $title = _t('OrderStep.CANADDGENERALLOG', ' ... if you want to make some notes about this step then do this here...');
        $fields->addFieldToTab('Root.Next', $order->getOrderStatusLogsTableField('OrderStatusLog', $title), 'ActionNextStepManually');

        return $fields;
    }

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

    /**
     * Explains the current order step.
     *
     * @return string
     */
    protected function myDescription()
    {
        return _t(
            'OrderStep.SENDADMIN_NOTIFICATION',
            'Admin notification to admin about order.'
        );
    }
}