OrderStep_SendAdminNotification::addOrderStepFields() - Code Metrics - Inspection of "MINOR: admin notification" - sunnysideup/silverstripe-ecommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f0b4ea...4efcd1 )

by Nicolaas

created 2019-07-04 19:42 UTC

addOrderStepFields() A

↳ Parent: OrderStep_SendAdminNotification

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	2
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_SendAdminNotification 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' => '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()) {

            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 admin notification has been 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.SENDADMIN_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_SendAdminNotification 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' => 'ADMINNOTIFIED',
23			'ShowAsInProcessOrder' => 1,
24			);
25
26			/**
27			* can run step once order has been submitted.
28			*
29			* @param Order object
30			*
31			* @return bool - true if the current step is ready to be run...
32			**/
33			public function initStep(Order $order)
34			{
35			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...
36			return true;
37			}
38
39			return false;
40			}
41
42			/**
43			* send invoice to customer
44			* or in case this is not selected, it will send a message to the shop admin only
45			* The latter is useful in case the payment does not go through (and no receipt is received).
46			*
47			* @param DataObject $order Order
48			*
49			* @return bool
50			**/
51			public function doStep(Order $order)
52			{
53			return $this->sendEmailForStep(
54			$order,
55			$subject = $this->EmailSubject,
			0 ignored issues – show Documentation introduced 2019-07-04 19:44 UTC by Report Bug Copy Issue Report The property `EmailSubject` does not exist on `object<OrderStep_SendAdminNotification>`. 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...
56			$message = '',
57			$resend = false,
58			$adminOnlyOrToEmail = true,
59			$this->getEmailClassName()
60			);
61			}
62
63			/**
64			* can do next step once the admin notification has been sent
65			*
66			* @param Order $order
67			*
68			* @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...
69			**/
70			public function nextStep(Order $order)
71			{
72			if ($this->hasBeenSent($order)) {
73			return parent::nextStep($order);
74			}
75
76			return;
77			}
78
79			/**
80			* Allows the opportunity for the Order Step to add any fields to Order::getCMSFields.
81			*
82			*@param FieldList $fields
83			*@param Order $order
84			*
85			*@return FieldList
86			**/
87			public function addOrderStepFields(FieldList $fields, Order $order)
88			{
89			$fields = parent::addOrderStepFields($fields, $order);
90			$title = _t('OrderStep.CANADDGENERALLOG', ' ... if you want to make some notes about this step then do this here...');
91			$fields->addFieldToTab('Root.Next', $order->getOrderStatusLogsTableField('OrderStatusLog', $title), 'ActionNextStepManually');
92
93			return $fields;
94			}
95
96			/**
97			* For some ordersteps this returns true...
98			*
99			* @return bool
100			**/
101			protected function hasCustomerMessage()
102			{
103			return false;
104			}
105
106			/**
107			* Explains the current order step.
108			*
109			* @return string
110			*/
111			protected function myDescription()
112			{
113			return _t(
114			'OrderStep.SENDADMIN_NOTIFICATION',
115			'Admin notification to admin about order.'
116			);
117			}
118			}
119

sunnysideup / silverstripe-ecommerce

Push — master ( f0b4ea...4efcd1 )

addOrderStepFields() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like