OrderStep_WhitelistCustomer::getCMSFields() - Code Metrics - sunnysideup/silverstripe-ecommerce_security - Measure and Improve Code Quality continuously with Scrutinizer

OrderStep_WhitelistCustomer::getCMSFields() A
last analyzed 2018-08-23 00:24 UTC

↳ Parent: OrderStep_WhitelistCustomer

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

class OrderStep_WhitelistCustomer extends OrderStep implements OrderStepInterface
namespace YourVendor;

class YourClass { }
{
    private static $defaults = array(

        '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.

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

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


        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)

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


1		<?php
2
3		class OrderStep_WhitelistCustomer extends OrderStep implements OrderStepInterface
		0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 01:12 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...
4		{
5		private static $defaults = array(
		0 ignored issues – show Comprehensibility introduced 2017-01-03 01:12 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-01-03 01:12 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...
6		'CustomerCanEdit' => 0,
7		'CustomerCanCancel' => 0,
8		'CustomerCanPay' => 0,
9		'Name' => 'Whitelist Customer',
10		'Code' => 'WHITELIST_CUSTOMER',
11		'ShowAsInProcessOrder' => 1,
12		'HideStepFromCustomer' => 1
13		);
14
15		/**
16		* The OrderStatusLog that is relevant to the particular step.
17		*
18		* @var string
19		*/
20		protected $relevantLogEntryClassName = 'OrderStatusLog_WhitelistCustomer';
21
22		public function getCMSFields()
23		{
24		$fields = parent::getCMSFields();
25
26		return $fields;
27		}
28
29		/**
30		* initStep:
31		* makes sure the step is ready to run.... (e.g. check if the order is ready to be emailed as receipt).
32		* should be able to run this function many times to check if the step is ready.
33		*
34		* @see Order::doNextStatus
35		*
36		* @param Order object
37		*
38		* @return bool - true if the current step is ready to be run...
39		**/
40		public function initStep(Order $order)
41		{
42		return true;
43		}
44
45		/**
46		*
47		*
48		* @var null \| bool
49		*/
50		private $_completed = null;
51
52		/**
53		* doStep:
54		* should only be able to run this function once
55		* (init stops you from running it twice - in theory....)
56		* runs the actual step.
57		*
58		* @see Order::doNextStatus
59		*
60		* @param Order object
61		*
62		* @return bool - true if run correctly.
		0 ignored issues – show Documentation introduced 2017-02-02 07:33 UTC by Report Bug Copy Issue Report Should the return type not be `null\|boolean`? 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...
63		**/
64		public function doStep(Order $order)
65		{
66		if ($this->_completed !== null) {
67		return $this->_completed;
68		}
69		$entry = $this->RelevantLogEntry($order);
70	View Code Duplication	if (! $entry) {
		0 ignored issues – show Duplication introduced 2017-02-02 07:33 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
71		$className = $this->relevantLogEntryClassName;
72		$entry = $className::create();
73		$entry->OrderID = $order->ID;
74		$entry->write();
75		}
76		$entry->assessCustomer();
77		$this->_completed = true;
		0 ignored issues – show Documentation Bug introduced 2017-02-02 07:33 UTC by Report Bug Copy Issue Report It seems like `true` of type `boolean` is incompatible with the declared type `null` of property `$_completed`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
78
79		return $this->_completed;
80		}
81
82		/**
83		*nextStep:
84		* returns the next step (after it checks if everything is in place for the next step to run...).
85		*
86		* @see Order::doNextStatus
87		*
88		* @param Order $order
89		*
90		* @return OrderStep \| Null (next step OrderStep object)
		0 ignored issues – show Documentation introduced 2017-01-03 01:12 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...
91		**/
92		public function nextStep(Order $order)
93		{
94		if ($this->doStep($order)) {
95		return parent::nextStep($order);
96		}
97
98		return;
99		}
100
101		/**
102		* For some ordersteps this returns true...
103		*
104		* @return bool
105		**/
106		protected function hasCustomerMessage()
107		{
108		return false;
109		}
110
111		/**
112		* Explains the current order step.
113		*
114		* @return string
115		*/
116		protected function myDescription()
117		{
118		return 'Whitelist a customer if they qualify for this.';
119		}
120
121		public function HideFromEveryone()
122		{
123		return true;
124		}
125		}
126

sunnysideup / silverstripe-ecommerce_security

OrderStep_WhitelistCustomer::getCMSFields() A last analyzed 2018-08-23 00:24 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

OrderStep_WhitelistCustomer::getCMSFields() A
last analyzed 2018-08-23 00:24 UTC