Issues in MinMaxModifier.php - All Issues - Inspection of "Merge branch 'master' of https://github.com/sunnys..." - sunnysideup/silverstripe-ecommerce_stockcontrol - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b7c5b8...080abf )

by Nicolaas

created 2017-07-23 06:03 UTC

code/modifiers/MinMaxModifier.php (9 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

/**
 * @author Nicolaas [at] sunnysideup.co.nz
 * @package: ecommerce
 * @sub-package: ecommerce_stockcontrol
 * @description: makes sure that a buyable quantity in cart stays between a min and a max
 */
class MinMaxModifier extends OrderModifier
namespace YourVendor;

class YourClass { }
{

//--------------------------------------------------------------------*** static variables

    private static $db = array(

        "Adjustments" => "HTMLText"
    );

    private static $singular_name = "Stock Adjustment";
    public function i18n_singular_name()
    {
        self::$singular_name;
    }

    private static $plural_name = "Stock Adjustments";
    public function i18n_plural_name()
    {
        return self::$plural_name;
    }

    private static $title = "MinMaxModifier";


    private static $default_min_quantity = 1;

    private static $default_max_quantity = 9999;

    private static $min_field = "MinQuantity";

    private static $max_field = "MaxQuantity";

    private static $adjustment_message = "Based on stock availability, quantities have been adjusted as follows: ";

    private static $sorry_message = "Sorry, your selected value not is available.";

    private static $use_stock_quantities = true;

    private static $ids_of_items_adjusted = array();

//-------------------------------------------------------------------- *** static functions

    public static function show_form()
    {
        self::apply_min_max();
        return false;
    }

    public static function get_form($controller)

    {
        return false;
    }

//-------------------------------------------------------------------- *** cms fuctions

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->removeByName("Adjustments");
        $fields->addFieldToTab("Root.Debug", new ReadonlyField("AdjustmentsShown", "Adjustments", $this->Adjustments));
        return $fields;
    }
//-------------------------------------------------------------------- *** display functions
    public function CanBeRemoved()
    {
        return false;
    }

    public function ShowInTable()
    {
        return false;
    }


//--------------------------------------------------------------------*** table values
    public function LiveCalculatedTotal()
    {
        self::apply_min_max();
        return 0;
    }

    public function LiveTableValue()
    {
        return "";
    }


//--------------------------------------------------------------------*** table titles
    public function LiveName()
    {
        return "";
    }

//-------------------------------------------------------------------- *** calculations
    public static function apply_min_max()
    {
        if (self::$min_field || self::$max_field  || self::$default_min_quantity || self::$default_max_quantity) {
            $msgArray = array();
            $minFieldName = self::$min_field;
            $maxFieldName = self::$max_field;
            $currentOrder = ShoppingCart::current_order();
            if ($currentOrder->IsSubmitted()) {
                //too late!
                return;
            }
            $items = $currentOrder->Items();
            $i = 0;
            if ($items) {
                foreach ($items as $item) {
                    $buyable = $item->Buyable();
                    if ($buyable) {
                        $quantity = $item->Quantity;
                        $absoluteMin = self::$default_min_quantity;
                        $absoluteMax = self::$default_max_quantity;
                        $parent = $buyable->Parent();
                        if ($minFieldName) {
                            if (isset($buyable->$minFieldName) && $buyable->$minFieldName > 0) {
                                $absoluteMin = $buyable->$minFieldName;
                            }
                            //product variations
                            elseif (!isset($buyable->$minFieldName)) {
                                if ($parent && isset($parent->$minFieldName) && $parent->$minFieldName > 0) {
                                    $absoluteMin = $parent->$minFieldName;
                                }
                            }
                        }
                        if ($maxFieldName) {
                            if (isset($buyable->$maxFieldName) && $buyable->$maxFieldName > 0) {
                                $absoluteMax = $buyable->$maxFieldName;
                            }
                            //product variations
                            elseif (!isset($buyable->$maxFieldName)) {
                                if ($parent && isset($parent->$maxFieldName) && $parent->$maxFieldName > 0) {
                                    $absoluteMax = $parent->$maxFieldName;
                                }
                            }
                        }
                        if ($buyable->UnlimitedStock) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
                            //nothing more to do
                        } elseif (self::$use_stock_quantities) {
                            $maxStockQuantity = $buyable->getActualQuantity();
                            if ($absoluteMax > $maxStockQuantity) {
                                $absoluteMax = $maxStockQuantity;
                            }
                            if ($absoluteMin > $maxStockQuantity) {
                                $absoluteMax = 0;
                                $maxStockQuantity = 0;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                            }
                        }
                        $absoluteMin = intval($absoluteMin) - 0;
                        $absoluteMax = intval($absoluteMax) - 0;
                        $newValue = $quantity;
                        if ($quantity < $absoluteMin && $absoluteMin > 0) {
                            debug::log("adjusting for MIN: $quantity < $absoluteMin");
                            $newValue = $absoluteMin;
                        }
                        if ($quantity > $absoluteMax && $absoluteMax > 0) {
                            debug::log("adjusting for MAX: $quantity > $absoluteMax");
                            $newValue = $absoluteMax;
                        }
                        if ($quantity != $newValue) {
                            $item->Quantity = $newValue;
                            ShoppingCart::singleton()->setQuantity($buyable, $newValue);
                            $msgArray[$i] = $buyable->Title." changed from ".$quantity." to ".$newValue;
                            $i++;
                            $quantity = $newValue;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                            self::$ids_of_items_adjusted[$item->ID] = $item->ID;
                        }
                        if (Director::is_ajax()) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
                            //do nothing
                        } else {
                            //IS THIS WORKING?
                            $fieldName = $item->AJAXDefinitions()->QuantityFieldName();
                            $js = 'MinMaxModifier.add_item("input[name=\''.$fieldName.'\']", '.intval($absoluteMin).', '.intval($absoluteMax).', "'.addslashes(self::$sorry_message).'");';
                            Requirements::javascript("ecommerce_stockcontrol/javascript/MinMaxModifier.js");
                            Requirements::customScript($js, $fieldName);
                        }
                    }
                }
            }
        }
        if (count($msgArray)) {
            if (self::$adjustment_message) {
                $msg = self::$adjustment_message."\n".implode("\n", $msgArray);
                if ($msg && !Director::is_ajax()) {
                    Requirements::customScript('alert("'.Convert::raw2js($msg).'");', "MinMaxModifierAlert");
                }
                //$this->Adjustments = $msg;

            }
        }
    }

    public function updateForAjax(array $js)
    {
        parent::updateForAjax($js);
        self::apply_min_max();
        if (is_array(self::$ids_of_items_adjusted) && count(self::$ids_of_items_adjusted)) {
            $items = OrderItem::get()->filter(array('ID' => self::$ids_of_items_adjusted));
            if ($items->count()) {
                foreach ($items as $item) {
                    $item->updateForAjax($js);
                }
            }
        }
        return $js;
    }


//--------------------------------------------------------------------*** database functions
}


1		<?php
2
3		/**
4		* @author Nicolaas [at] sunnysideup.co.nz
5		* @package: ecommerce
6		* @sub-package: ecommerce_stockcontrol
7		* @description: makes sure that a buyable quantity in cart stays between a min and a max
8		*/
9		class MinMaxModifier extends OrderModifier
		0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 01:13 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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...
10		{
11
12		//--------------------------------------------------------------------*** static variables
13
14		private static $db = array(
		0 ignored issues – show Unused Code introduced 2017-01-03 01:13 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `$db` 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...
15		"Adjustments" => "HTMLText"
16		);
17
18		private static $singular_name = "Stock Adjustment";
19		public function i18n_singular_name()
20		{
21		self::$singular_name;
22		}
23
24		private static $plural_name = "Stock Adjustments";
25		public function i18n_plural_name()
26		{
27		return self::$plural_name;
28		}
29
30		private static $title = "MinMaxModifier";
		0 ignored issues – show Unused Code introduced 2017-01-03 01:13 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `$title` 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...
31
32		private static $default_min_quantity = 1;
33
34		private static $default_max_quantity = 9999;
35
36		private static $min_field = "MinQuantity";
37
38		private static $max_field = "MaxQuantity";
39
40		private static $adjustment_message = "Based on stock availability, quantities have been adjusted as follows: ";
41
42		private static $sorry_message = "Sorry, your selected value not is available.";
43
44		private static $use_stock_quantities = true;
45
46		private static $ids_of_items_adjusted = array();
47
48		//-------------------------------------------------------------------- *** static functions
49
50		public static function show_form()
51		{
52		self::apply_min_max();
53		return false;
54		}
55
56		public static function get_form($controller)
		0 ignored issues – show Unused Code introduced 2017-01-03 01:13 UTC by Report Bug Copy Issue Report Show Similar Issues like this The parameter `$controller` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
57		{
58		return false;
59		}
60
61		//-------------------------------------------------------------------- *** cms fuctions
62
63		public function getCMSFields()
64		{
65		$fields = parent::getCMSFields();
66		$fields->removeByName("Adjustments");
67		$fields->addFieldToTab("Root.Debug", new ReadonlyField("AdjustmentsShown", "Adjustments", $this->Adjustments));
68		return $fields;
69		}
70		//-------------------------------------------------------------------- *** display functions
71		public function CanBeRemoved()
72		{
73		return false;
74		}
75
76		public function ShowInTable()
77		{
78		return false;
79		}
80
81
82		//--------------------------------------------------------------------*** table values
83		public function LiveCalculatedTotal()
84		{
85		self::apply_min_max();
86		return 0;
87		}
88
89		public function LiveTableValue()
90		{
91		return "";
92		}
93
94
95		//--------------------------------------------------------------------*** table titles
96		public function LiveName()
97		{
98		return "";
99		}
100
101		//-------------------------------------------------------------------- *** calculations
102		public static function apply_min_max()
103		{
104		if (self::$min_field \|\| self::$max_field \|\| self::$default_min_quantity \|\| self::$default_max_quantity) {
105		$msgArray = array();
106		$minFieldName = self::$min_field;
107		$maxFieldName = self::$max_field;
108		$currentOrder = ShoppingCart::current_order();
109		if ($currentOrder->IsSubmitted()) {
110		//too late!
111		return;
112		}
113		$items = $currentOrder->Items();
114		$i = 0;
115		if ($items) {
116		foreach ($items as $item) {
117		$buyable = $item->Buyable();
118		if ($buyable) {
119		$quantity = $item->Quantity;
120		$absoluteMin = self::$default_min_quantity;
121		$absoluteMax = self::$default_max_quantity;
122		$parent = $buyable->Parent();
123	View Code Duplication	if ($minFieldName) {
124		if (isset($buyable->$minFieldName) && $buyable->$minFieldName > 0) {
125		$absoluteMin = $buyable->$minFieldName;
126		}
127		//product variations
128		elseif (!isset($buyable->$minFieldName)) {
129		if ($parent && isset($parent->$minFieldName) && $parent->$minFieldName > 0) {
130		$absoluteMin = $parent->$minFieldName;
131		}
132		}
133		}
134	View Code Duplication	if ($maxFieldName) {
135		if (isset($buyable->$maxFieldName) && $buyable->$maxFieldName > 0) {
136		$absoluteMax = $buyable->$maxFieldName;
137		}
138		//product variations
139		elseif (!isset($buyable->$maxFieldName)) {
140		if ($parent && isset($parent->$maxFieldName) && $parent->$maxFieldName > 0) {
141		$absoluteMax = $parent->$maxFieldName;
142		}
143		}
144		}
145		if ($buyable->UnlimitedStock) {
		0 ignored issues – show Unused Code introduced 2017-01-03 01:13 UTC by Report Bug Copy Issue Report Show Similar Issues like this This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
146		//nothing more to do
147		} elseif (self::$use_stock_quantities) {
148		$maxStockQuantity = $buyable->getActualQuantity();
149		if ($absoluteMax > $maxStockQuantity) {
150		$absoluteMax = $maxStockQuantity;
151		}
152		if ($absoluteMin > $maxStockQuantity) {
153		$absoluteMax = 0;
154		$maxStockQuantity = 0;
		0 ignored issues – show Unused Code introduced 2017-01-03 01:13 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$maxStockQuantity` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
155		}
156		}
157		$absoluteMin = intval($absoluteMin) - 0;
158		$absoluteMax = intval($absoluteMax) - 0;
159		$newValue = $quantity;
160		if ($quantity < $absoluteMin && $absoluteMin > 0) {
161		debug::log("adjusting for MIN: $quantity < $absoluteMin");
162		$newValue = $absoluteMin;
163		}
164		if ($quantity > $absoluteMax && $absoluteMax > 0) {
165		debug::log("adjusting for MAX: $quantity > $absoluteMax");
166		$newValue = $absoluteMax;
167		}
168		if ($quantity != $newValue) {
169		$item->Quantity = $newValue;
170		ShoppingCart::singleton()->setQuantity($buyable, $newValue);
171		$msgArray[$i] = $buyable->Title." changed from ".$quantity." to ".$newValue;
172		$i++;
173		$quantity = $newValue;
		0 ignored issues – show Unused Code introduced 2017-01-03 01:13 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$quantity` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
174		self::$ids_of_items_adjusted[$item->ID] = $item->ID;
175		}
176		if (Director::is_ajax()) {
		0 ignored issues – show Unused Code introduced 2017-01-03 01:13 UTC by Report Bug Copy Issue Report Show Similar Issues like this This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
177		//do nothing
178		} else {
179		//IS THIS WORKING?
180		$fieldName = $item->AJAXDefinitions()->QuantityFieldName();
181		$js = 'MinMaxModifier.add_item("input[name=\''.$fieldName.'\']", '.intval($absoluteMin).', '.intval($absoluteMax).', "'.addslashes(self::$sorry_message).'");';
182		Requirements::javascript("ecommerce_stockcontrol/javascript/MinMaxModifier.js");
183		Requirements::customScript($js, $fieldName);
184		}
185		}
186		}
187		}
188		}
189		if (count($msgArray)) {
190		if (self::$adjustment_message) {
191		$msg = self::$adjustment_message."\n".implode("\n", $msgArray);
192		if ($msg && !Director::is_ajax()) {
193		Requirements::customScript('alert("'.Convert::raw2js($msg).'");', "MinMaxModifierAlert");
194		}
195		//$this->Adjustments = $msg;
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-03 01:13 UTC by Report Bug Copy Issue Report Show Similar Issues like this `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
196		}
197		}
198		}
199
200		public function updateForAjax(array $js)
201		{
202		parent::updateForAjax($js);
203		self::apply_min_max();
204		if (is_array(self::$ids_of_items_adjusted) && count(self::$ids_of_items_adjusted)) {
205		$items = OrderItem::get()->filter(array('ID' => self::$ids_of_items_adjusted));
206		if ($items->count()) {
207		foreach ($items as $item) {
208		$item->updateForAjax($js);
209		}
210		}
211		}
212		return $js;
213		}
214
215
216		//--------------------------------------------------------------------*** database functions
217		}
218

sunnysideup / silverstripe-ecommerce_stockcontrol

Push — master ( b7c5b8...080abf )

code/modifiers/MinMaxModifier.php (9 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like