OrderStep_FraudCheck::initStep() - Code Metrics - sunnysideup/silverstripe-ecommerce_maxmind_minfraud - Measure and Improve Code Quality continuously with Scrutinizer

OrderStep_FraudCheck::initStep() A
last analyzed 2018-09-07 02:28 UTC

↳ Parent: OrderStep_FraudCheck

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * @authors: Nicolaas [at] Sunny Side Up .co.nz
 * @package: ecommerce
 * @sub-package: model
 **/
class OrderStep_FraudCheck extends OrderStep implements OrderStepInterface
{
    public static $db = [
        'MinOrderValue' => 'Int',
        'MinFraudService' =>  'Enum("Score,Insights","Score")'
    ];

    private static $defaults = [

        'CustomerCanEdit' => 0,
        'CustomerCanCancel' => 0,
        'CustomerCanPay' => 0,
        'Name' => 'Fraud Check for Order',
        'Code' => 'FRAUD_CHECK',
        'ShowAsInProcessOrder' => 1,
        'HideStepFromCustomer' => 1
    ];

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

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

        $fields->addFieldToTab(
            'Root.Main',
            HeaderField::create('MinFraudHeader', 'MaxMind Min Fraud Settings')
        );

        $fields->addFieldToTab(
            'Root.Main',
            NumericField::create('MinOrderValue', 'Minimum Order Value', 0)->setRightTitle('The Risk Score will only be retrieved for orders with a total greater than the value in this field.')
        );

        $fields->addFieldToTab(
            'Root.Main',
            OptionsetField::create(
                'MinFraudService',
                'Min Fraud Service',
                $this->dbObject('MinFraudService')->enumValues()
            )->setRightTitle(
                '
                The MinFraud service that will be used to check if an order potentially fraudulent.<br>
                Compare the <a href="https://www.maxmind.com/en/minfraud-service-comparison" target="_blank">services</a> to decide which one you should use.
                '
            )
        );

        $fields->removeByName('DeferHeader');
        $fields->removeByName('DeferTimeInSeconds');
        $fields->removeByName('DeferFromSubmitTime');

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


    /**
     *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 ($order->getTotal() < $this->MinOrderValue) {
<?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.");
        }
    }

}
            return true;
        }

        $className = $this->getRelevantLogEntryClassName();

        if (class_exists($className)) {

            $obj = $className::create();
            if (is_a($obj, Object::getCustomClass('OrderStatusLog'))) {
                $obj->OrderID = $order->ID;
                $obj->Title = $this->Name;
<?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.");
        }
    }

}
                $obj->ServiceType = $this->MinFraudService;
<?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.");
        }
    }

}
                $obj->write();
            }
        }

        return true;
    }

    /**
     *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)
    {
        return parent::nextStep($order);
    }

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

    /**
     * Explains the current order step.
     *
     * @return string
     */
    protected function myDescription()
    {
        return 'Checks for possible fraudulent orders using the minFraud API provided by MaxMind';
    }
}


1		<?php
2
3		/**
4		* @authors: Nicolaas [at] Sunny Side Up .co.nz
5		* @package: ecommerce
6		* @sub-package: model
7		**/
8		class OrderStep_FraudCheck extends OrderStep implements OrderStepInterface
9		{
10		public static $db = [
11		'MinOrderValue' => 'Int',
12		'MinFraudService' => 'Enum("Score,Insights","Score")'
13		];
14
15		private static $defaults = [
		0 ignored issues – show Comprehensibility introduced 2018-05-02 22:49 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...
16		'CustomerCanEdit' => 0,
17		'CustomerCanCancel' => 0,
18		'CustomerCanPay' => 0,
19		'Name' => 'Fraud Check for Order',
20		'Code' => 'FRAUD_CHECK',
21		'ShowAsInProcessOrder' => 1,
22		'HideStepFromCustomer' => 1
23		];
24
25		/**
26		* The OrderStatusLog that is relevant to the particular step.
27		*
28		* @var string
29		*/
30		protected $relevantLogEntryClassName = 'OrderStatusLog_MinFraudStatusLog';
31
32		public function getCMSFields()
33		{
34		$fields = parent::getCMSFields();
35
36		$fields->addFieldToTab(
37		'Root.Main',
38		HeaderField::create('MinFraudHeader', 'MaxMind Min Fraud Settings')
39		);
40
41		$fields->addFieldToTab(
42		'Root.Main',
43		NumericField::create('MinOrderValue', 'Minimum Order Value', 0)->setRightTitle('The Risk Score will only be retrieved for orders with a total greater than the value in this field.')
44		);
45
46		$fields->addFieldToTab(
47		'Root.Main',
48		OptionsetField::create(
49		'MinFraudService',
50		'Min Fraud Service',
51		$this->dbObject('MinFraudService')->enumValues()
52		)->setRightTitle(
53		'
54		The MinFraud service that will be used to check if an order potentially fraudulent.<br>
55		Compare the <a href="https://www.maxmind.com/en/minfraud-service-comparison" target="_blank">services</a> to decide which one you should use.
56		'
57		)
58		);
59
60		$fields->removeByName('DeferHeader');
61		$fields->removeByName('DeferTimeInSeconds');
62		$fields->removeByName('DeferFromSubmitTime');
63
64		return $fields;
65		}
66
67		/**
68		*initStep:
69		* makes sure the step is ready to run.... (e.g. check if the order is ready to be emailed as receipt).
70		* should be able to run this function many times to check if the step is ready.
71		*
72		* @see Order::doNextStatus
73		*
74		* @param Order object
75		*
76		* @return bool - true if the current step is ready to be run...
77		**/
78		public function initStep(Order $order)
79		{
80		return true;
81		}
82
83
84		/**
85		*doStep:
86		* should only be able to run this function once
87		* (init stops you from running it twice - in theory....)
88		* runs the actual step.
89		*
90		* @see Order::doNextStatus
91		*
92		* @param Order object
93		*
94		* @return bool - true if run correctly.
95		**/
96		public function doStep(Order $order)
97		{
98		if ($order->getTotal() < $this->MinOrderValue) {
		0 ignored issues – show Documentation introduced 2018-05-02 22:49 UTC by Report Bug Copy Issue Report The property `MinOrderValue` does not exist on `object<OrderStep_FraudCheck>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
99		return true;
100		}
101
102		$className = $this->getRelevantLogEntryClassName();
103
104	View Code Duplication	if (class_exists($className)) {
		0 ignored issues – show Duplication introduced 2018-05-02 22:49 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...
105		$obj = $className::create();
106		if (is_a($obj, Object::getCustomClass('OrderStatusLog'))) {
107		$obj->OrderID = $order->ID;
108		$obj->Title = $this->Name;
		0 ignored issues – show Documentation introduced 2018-05-02 22:49 UTC by Report Bug Copy Issue Report The property `Name` does not exist on `object<OrderStep_FraudCheck>`. 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...
109		$obj->ServiceType = $this->MinFraudService;
		0 ignored issues – show Documentation introduced 2018-05-02 22:49 UTC by Report Bug Copy Issue Report The property `MinFraudService` does not exist on `object<OrderStep_FraudCheck>`. 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...
110		$obj->write();
111		}
112		}
113
114		return true;
115		}
116
117		/**
118		*nextStep:
119		* returns the next step (after it checks if everything is in place for the next step to run...).
120		*
121		* @see Order::doNextStatus
122		*
123		* @param Order $order
124		*
125		* @return OrderStep \| Null (next step OrderStep object)
		0 ignored issues – show Documentation introduced 2018-05-02 22:49 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...
126		**/
127		public function nextStep(Order $order)
128		{
129		return parent::nextStep($order);
130		}
131
132		/**
133		* For some ordersteps this returns true...
134		*
135		* @return bool
136		**/
137		protected function hasCustomerMessage()
138		{
139		return false;
140		}
141
142		/**
143		* Explains the current order step.
144		*
145		* @return string
146		*/
147		protected function myDescription()
148		{
149		return 'Checks for possible fraudulent orders using the minFraud API provided by MaxMind';
150		}
151		}
152

sunnysideup / silverstripe-ecommerce_maxmind_minfraud

OrderStep_FraudCheck::initStep() A last analyzed 2018-09-07 02:28 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

OrderStep_FraudCheck::initStep() A
last analyzed 2018-09-07 02:28 UTC