OptionItem - Code Metrics - Inspection of "REFACTOR: move discounts to separate module" - dynamic/foxystripe - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#292)

by Jason
created 2016-12-01 06:04 UTC
OptionItem B

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	244
Duplicated Lines	0 %
Coupling/Cohesion

Components	1
Dependencies	16
Test Coverage

Coverage
Importance

Changes
Metric	Value
wmc	25
lcom	1
cbo	16
dl	0
loc	244
ccs	0
cts	140
cp	0
rs	8.4614
c	0
b	0
f	0
14 Methods

Rating	Name	Size	Complexity
B	getCMSFields()	130	3
A	getOptionModifierActionSymbol()	13	4
A	getWeightModifierWithSymbol()	3	1
A	getPriceModifierWithSymbol()	3	1
A	getCodeModifierWithSymbol()	3	1
A	getProductOptionGroupTitle()	3	1
A	getGeneratedValue()	8	3
A	getGeneratedTitle()	6	3
A	getAvailability()	3	2
A	canView()	3	1
A	canEdit()	3	1
A	canCreate()	3	1
A	validate()	9	2
A	canDelete()	3	1
<?php
/**
 *
 * @package FoxyStripe
 *
 */

class OptionItem extends DataObject{

	private static $db = array(
		'Title' => 'Text',
		'WeightModifier' => 'Int',
		'CodeModifier' => 'Text',
		'PriceModifier' => 'Currency',
		'WeightModifierAction' => "Enum('Add,Subtract,Set','Add')",
		'CodeModifierAction' => "Enum('Add,Subtract,Set','Add')",
		'PriceModifierAction' => "Enum('Add,Subtract,Set','Add')",
		'Available' => 'Boolean',
		'SortOrder' => 'Int'
	);

	private static $has_one = array(
		'Product' => 'ProductPage',
		'ProductOptionGroup' => 'OptionGroup',
		//'Category' => 'ProductCategory'
	);

    private static $belongs_many_many = array(
        'OrderDetails' => 'OrderDetail'
    );

    private static $defaults = array(
		'Available' => true
	);

	private static $summary_fields = array(
		'Title' => 'Title',
		'ProductOptionGroup.Title' => 'Group',
        'Available.Nice' => 'Available'
	);

	private static $default_sort = 'SortOrder';


	public function getCMSFields(){
		$fields = FieldList::create(
			new Tabset('Root',
				new Tab('Main'),
				new Tab('Modifiers')
			)
		);

		// set variables from Product
        $productID = ($this->ProductID != 0) ? $this->ProductID : Session::get('CMSMain.currentPage');
<?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.");
        }
    }

}
        $product = ProductPage::get()->byID($productID);

		$parentPrice = $product->obj('Price')->Nice();
		$parentWeight = $product->Weight;
		$parentCode = $product->Code;

		// ProductOptionGroup Dropdown field w/ add new
		$groups = function(){
		    return OptionGroup::get()->map()->toArray();
		};
		$groupFields = singleton('OptionGroup')->getCMSFields();
		$groupField = DropdownField::create('ProductOptionGroupID', _t("OptionItem.Group", "Group"), $groups())
			->setEmptyString('')
            ->setDescription(_t('OptionItem.GroupDescription', 'Name of this group of options. Managed in <a href="admin/settings">Settings > FoxyStripe > Option Groups</a>'));
		if (class_exists('QuickAddNewExtension')) $groupField->useAddNew('OptionGroup', $groups, $groupFields);

        $fields->addFieldsToTab('Root.Main', array(
			HeaderField::create('DetailsHD', _t("OptionItem.DetailsHD", "Product Option Details"), 2),
			Textfield::create('Title')
                ->setTitle(_t("OptionItem.Title", "Product Option Name")),
			CheckboxField::create('Available')
				->setTitle( _t("OptionItem.Available", "Available for purchase"))
                ->setDescription(_t('OptionItem.AvailableDescription', "If unchecked, will disable this option in the drop down menu")),
			$groupField
		));

		$fields->addFieldsToTab('Root.Modifiers', array(
			HeaderField::create('ModifyHD', _t('OptionItem.ModifyHD', 'Product Option Modifiers'), 2),

			// Weight Modifier Fields
			HeaderField::create('WeightHD', _t('OptionItem.WeightHD', 'Modify Weight'), 3),
			NumericField::create('WeightModifier')
                ->setTitle(_t('OptionItem.WeightModifier', 'Weight')),
			DropdownField::create('WeightModifierAction', _t('OptionItem.WeightModifierAction', 'Weight Modification'),
				array(
                    'Add' => _t(
                        'OptionItem.WeightAdd',
                        "Add to Base Weight ({weight})",
                        'Add to weight',
                        array('weight' => $parentWeight)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    ),
                    'Subtract' => _t(
                        'OptionItem.WeightSubtract',
                        "Subtract from Base Weight ({weight})",
                        'Subtract from weight',
                        array('weight' => $parentWeight)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    ),
                    'Set' => _t('OptionItem.WeightSet', 'Set as a new Weight')
				)
			)->setEmptyString('')
			->setDescription(_t('OptionItem.WeightDescription', 'Does weight modify or replace base weight?')),

			// Price Modifier FIelds
			HeaderField::create('PriceHD', _t('OptionItem.PriceHD', 'Modify Price'), 3),
			CurrencyField::create('PriceModifier')
                ->setTitle(_t('OptionItem.PriceModifier', 'Price')),
			DropdownField::create('PriceModifierAction', _t('OptionItem.PriceModifierAction', 'Price Modification'),
				array(
					'Add' => _t(
                        'OptionItem.PriceAdd',
                        "Add to Base Price ({price})",
                        'Add to price',
                        array('price' => $parentPrice)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    ),
					'Subtract' => _t(
                        'OptionItem.PriceSubtract',
                        "Subtract from Base Price ({price})",
                        'Subtract from price',
                        array('price' => $parentPrice)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    ),
					'Set' => _t('OptionItem.PriceSet', 'Set as a new Price')
				)
			)->setEmptyString('')
			->setDescription(_t('OptionItem.PriceDescription', 'Does price modify or replace base price?')),

			// Code Modifier Fields
			HeaderField::create('CodeHD', _t('OptionItem.CodeHD', 'Modify Code'), 3),
			TextField::create('CodeModifier')
                ->setTitle(_t('OptionItem.CodeModifier', 'Code')),
			DropdownField::create('CodeModifierAction', _t('OptionItem.CodeModifierAction', 'Code Modification'),
				array(
					'Add' => _t(
                        'OptionItem.CodeAdd',
                        "Add to Base Code ({code})",
                        'Add to code',
                        array('code' => $parentCode)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    ),
					'Subtract' => _t(
                        'OptionItem.CodeSubtract',
                        'Subtract from Base Code ({code})',
                        'Subtract from code',
                        array('code' => $parentCode)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    ),
					'Set' => _t('OptionItem.CodeSet', 'Set as a new Code')
				)
			)->setEmptyString('')
			->setDescription(_t('OptionItem.CodeDescription', 'Does code modify or replace base code?'))
		));

        /*

        // Cateogry Dropdown field w/ add new
        // removed until relevance determined
        $categories = function(){
            return ProductCategory::get()->map()->toArray();
        };

        // to do - have OptionItem category override set ProductPage category if selected: issue #155
        $categoryField = DropdownField::create('CategoryID', 'Category', $categories())
            ->setEmptyString('')
            ->setDescription('Categories can be managed in <a href="admin/settings">Settings > FoxyStripe > Categories</a>');
        if (class_exists('QuickAddNewExtension')) $categoryField->useAddNew('ProductCategory', $categories);

        $fields->insertAfter($categoryField, 'ProductOptionGroupID');
        */

        // allow CMS fields to be extended
		$this->extend('getCMSFields', $fields);

		return $fields;
	}

	public function validate(){
		$result = parent::validate();

		if($this->ProductOptionGroupID == 0){
<?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.");
        }
    }

}
			$result->error('Must set a Group prior to saving');
		}

		return $result;
	}

	public static function getOptionModifierActionSymbol($oma, $returnWithOnlyPlusMinus=false){
		switch($oma){
			case 'Subtract':
				$symbol = '-';
				break;
			case 'Set':
				$symbol = ($returnWithOnlyPlusMinus) ? '' : ':';
				break;
			default:
				$symbol = '+';
		}
		return $symbol;
	}

	public function getWeightModifierWithSymbol(){
		return self::getOptionModifierActionSymbol($this->WeightModifierAction).$this->WeightModifier;
<?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.");
        }
    }

}
	}

	public function getPriceModifierWithSymbol(){
		return self::getOptionModifierActionSymbol($this->PriceModifierAction).$this->PriceModifier;
<?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.");
        }
    }

}
	}

	public function getCodeModifierWithSymbol(){
		return self::getOptionModifierActionSymbol($this->CodeModifierAction).$this->CodeModifier;
<?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.");
        }
    }

}
	}

	public function getProductOptionGroupTitle(){
		return $this->ProductOptionGroup()->Title;

	}

	public function getGeneratedValue(){
		$modPrice = ($this->PriceModifier) ? (string)$this->PriceModifier : '0';
<?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.");
        }
    }

}
		$modPriceWithSymbol = OptionItem::getOptionModifierActionSymbol($this->PriceModifierAction).$modPrice;
<?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.");
        }
    }

}
		$modWeight = ($this->WeightModifier) ? (string)$this->WeightModifier : '0';
<?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.");
        }
    }

}
		$modWeight = OptionItem::getOptionModifierActionSymbol($this->WeightModifierAction).$modWeight;
<?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.");
        }
    }

}
		$modCode = OptionItem::getOptionModifierActionSymbol($this->CodeModifierAction).$this->CodeModifier;
<?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 $this->Title.'{p'.$modPriceWithSymbol.'|w'.$modWeight.'|c'.$modCode.'}';
<?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.");
        }
    }

}
	}

	public function getGeneratedTitle(){
		$modPrice = ($this->PriceModifier) ? (string)$this->PriceModifier : '0';
<?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.");
        }
    }

}
		$title = $this->Title;
<?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.");
        }
    }

}
		$title .= ($this->PriceModifier != 0) ? ': ('.OptionItem::getOptionModifierActionSymbol($this->PriceModifierAction, $returnWithOnlyPlusMinus=true).'$'.$modPrice.')' : '';
<?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 $title;
	}

	public function getAvailability(){
		return ($this->Available == 0) ? true : false ;
<?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.");
        }
    }

}
	}

	public function canView($member = false) {
		return true;
	}

	public function canEdit($member = null) {
		return Permission::check('Product_CANCRUD');
	}

	public function canDelete($member = null) {
		return Permission::check('Product_CANCRUD');
	}

	public function canCreate($member = null) {
		return Permission::check('Product_CANCRUD');
	}

}

1			<?php
2			/**
3			*
4			* @package FoxyStripe
5			*
6			*/
7
8			class OptionItem extends DataObject{
9
10			private static $db = array(
11			'Title' => 'Text',
12			'WeightModifier' => 'Int',
13			'CodeModifier' => 'Text',
14			'PriceModifier' => 'Currency',
15			'WeightModifierAction' => "Enum('Add,Subtract,Set','Add')",
16			'CodeModifierAction' => "Enum('Add,Subtract,Set','Add')",
17			'PriceModifierAction' => "Enum('Add,Subtract,Set','Add')",
18			'Available' => 'Boolean',
19			'SortOrder' => 'Int'
20			);
21
22			private static $has_one = array(
23			'Product' => 'ProductPage',
24			'ProductOptionGroup' => 'OptionGroup',
25			//'Category' => 'ProductCategory'
26			);
27
28			private static $belongs_many_many = array(
29			'OrderDetails' => 'OrderDetail'
30			);
31
32			private static $defaults = array(
33			'Available' => true
34			);
35
36			private static $summary_fields = array(
37			'Title' => 'Title',
38			'ProductOptionGroup.Title' => 'Group',
39			'Available.Nice' => 'Available'
40			);
dynamic / foxystripe

Pull Request — master (#292)

OptionItem B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

14 Methods

Duplication Side-by-Side

Filter issues like
