OrderStep_SentAdminNotification::initStep() - Code Metrics - Inspection of "MINOR: adding new step" - sunnysideup/silverstripe-ecommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 17dce1...f0b4ea )

by Nicolaas

created 2019-07-04 19:38 UTC

OrderStep_SentAdminNotification::initStep() A

↳ Parent: OrderStep_SentAdminNotification

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php


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

    private static $defaults = array(

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

    /**
     * can run step once order has been submitted.
     * NOTE: must have a payment (even if it is a fake payment).
     * The reason for this is if people pay straight away then they want to see the payment shown on their invoice.
     *
     * @param Order object
     *
     * @return bool - true if the current step is ready to be run...
     **/
    public function initStep(Order $order)
    {
        if ($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,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

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

    /**
     * can do next step once the invoice has been sent or in case the invoice does not need to be sent.
     *
     * @param Order $order
     *
     * @return OrderStep | Null (next step OrderStep object)

     **/
    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.SENTADMIN_NOTIFICATION',
            'Admin notification to admin about order.'
        );
    }
}


1			<?php
2
3
4			/**
5			* @authors: Nicolaas [at] Sunny Side Up .co.nz
6			* @package: ecommerce
7			* @sub-package: model
8			* @inspiration: Silverstripe Ltd, Jeremy
9			**/
10			class OrderStep_SentAdminNotification extends OrderStep implements OrderStepInterface
11			{
12			/**
13			* @var string
14			*/
15			protected $emailClassName = 'Order_ReceiptEmail';
16
17			private static $defaults = array(
			0 ignored issues – show Comprehensibility introduced 2019-07-04 19:40 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...
18			'CustomerCanEdit' => 0,
19			'CustomerCanCancel' => 0,
20			'CustomerCanPay' => 1,
21			'Name' => 'Send Admin Notification',
22			'Code' => 'NOTIFIED',
23			'ShowAsInProcessOrder' => 1,
24			'SendInvoiceToCustomer' => 1,
25			);
26
27			/**
28			* can run step once order has been submitted.
29			* NOTE: must have a payment (even if it is a fake payment).
30			* The reason for this is if people pay straight away then they want to see the payment shown on their invoice.
31			*
32			* @param Order object
33			*
34			* @return bool - true if the current step is ready to be run...
35			**/
36			public function initStep(Order $order)
37			{
38			if ($order->IsSubmitted()) {
			0 ignored issues – show Unused Code introduced 2019-07-04 19:40 UTC by Report Bug Copy Issue Report This `if` statement, and the following `return` statement can be replaced with `return $order->IsSubmitted();`. Loading history...
39			return true;
40			}
41
42			return false;
43			}
44
45			/**
46			* send invoice to customer
47			* or in case this is not selected, it will send a message to the shop admin only
48			* The latter is useful in case the payment does not go through (and no receipt is received).
49			*
50			* @param DataObject $order Order
51			*
52			* @return bool
53			**/
54			public function doStep(Order $order)
55			{
56			return $this->sendEmailForStep(
57			$order,
58			$subject = $this->EmailSubject,
			0 ignored issues – show Documentation introduced 2019-07-04 19:40 UTC by Report Bug Copy Issue Report The property `EmailSubject` does not exist on `object<OrderStep_SentAdminNotification>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
59			$message = '',
60			$resend = false,
61			$adminOnlyOrToEmail = true,
62			$this->getEmailClassName()
63			);
64			}
65
66			/**
67			* can do next step once the invoice has been sent or in case the invoice does not need to be sent.
68			*
69			* @param Order $order
70			*
71			* @return OrderStep \| Null (next step OrderStep object)
			0 ignored issues – show Documentation introduced 2019-07-04 19:40 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...
72			**/
73			public function nextStep(Order $order)
74			{
75			if ($this->hasBeenSent($order)) {
76			return parent::nextStep($order);
77			}
78
79			return;
80			}
81
82			/**
83			* Allows the opportunity for the Order Step to add any fields to Order::getCMSFields.
84			*
85			*@param FieldList $fields
86			*@param Order $order
87			*
88			*@return FieldList
89			**/
90			public function addOrderStepFields(FieldList $fields, Order $order)
91			{
92			$fields = parent::addOrderStepFields($fields, $order);
93			$title = _t('OrderStep.CANADDGENERALLOG', ' ... if you want to make some notes about this step then do this here...');
94			$fields->addFieldToTab('Root.Next', $order->getOrderStatusLogsTableField('OrderStatusLog', $title), 'ActionNextStepManually');
95
96			return $fields;
97			}
98
99			/**
100			* For some ordersteps this returns true...
101			*
102			* @return bool
103			**/
104			protected function hasCustomerMessage()
105			{
106			return false;
107			}
108
109			/**
110			* Explains the current order step.
111			*
112			* @return string
113			*/
114			protected function myDescription()
115			{
116			return _t(
117			'OrderStep.SENTADMIN_NOTIFICATION',
118			'Admin notification to admin about order.'
119			);
120			}
121			}
122

sunnysideup / silverstripe-ecommerce

Push — master ( 17dce1...f0b4ea )

OrderStep_SentAdminNotification::initStep() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like