ProductCategory - Code Metrics - Inspection of "FoxyCart Hyper API Integration - initial" - dynamic/foxystripe - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#304)

by Jason
created 2017-02-26 20:01 UTC
ProductCategory A

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	283
Duplicated Lines	0 %
Coupling/Cohesion

Components	2
Dependencies	10
Test Coverage

Coverage
29.5%
Importance

Changes
Metric	Value
wmc	20
lcom	2
cbo	10
dl	0
loc	283
ccs	41
cts	139
cp	0.295
rs	10
c	0
b	0
f	0
13 Methods

Rating	Name	Size	Complexity
B	getCMSFields()	116	3
A	requireDefaultRecords()	10	2
A	canView()	3	1
A	canEdit()	3	1
A	canDelete()	5	2
A	canCreate()	3	1
A	getShippingOptions()	10	1
A	getShippingFlatRateTypes()	7	1
A	getHandlingFeeTypes()	9	1
A	getDiscountTypes()	9	1
A	getDataMap()	23	1
A	onAfterWrite()	10	3
A	onAfterDelete()	8	2
<?php

use Dynamic\FoxyStripe\Model\FoxyStripeClient;

class ProductCategory extends DataObject {

    private static $db = array(
		'Title' => 'Varchar(255)',
		'Code' => 'Varchar(50)',
        'DeliveryType' => 'Varchar(50)',
        'MaxDownloads' => 'Int',
        'MaxDownloadsTime' => 'Int',
        'DefaultWeight' => 'Float',
        'DefaultWeightUnit' => 'Enum("LBS, KBS", "LBS")',
        'DefaultLengthUnit' => 'Enum("in, cm", "in")',
        'ShippingFlatRate' => 'Currency',
        'ShippingFlatRateType' => 'Varchar(50)',
        'HandlingFeeType' => 'Varchar(50)',
        'HandlingFee' => 'Currency',
        'HandlingFeePercentage' => 'Decimal',
        'HandlingFeeMinimum' => 'Currency',
        'DiscountType' => 'Varchar(50)',
        'DiscountName' => 'Varchar(50)',
        'DiscountDetails' => 'Varchar(200)',
        'CustomsValue' => 'Currency',
	);

    private static $singular_name = 'FoxyCart Category';
    private static $plural_name = 'FoxyCart Categories';
    private static $description = 'Set the FoxyCart Category on a Product';

    private static $summary_fields = array(
        'Title' => 'Name',
        'Code' => 'Code'
    );

	private static $indexes = array(
		'Code' => true
	);

    public function getCMSFields() {

        $fields = parent::getCMSFields();

        if ($this->ID) {
            if ($this->Title == 'Default') {
<?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.");
        }
    }

}
                $fields->replaceField(
                    'Title',
                    ReadonlyField::create('Title')
                );
            }

            $fields->replaceField(
                'Code',
                ReadonlyField::create('Code')
            );
        }

        $fields->insertBefore(HeaderField::create('DeliveryHD', 'Delivery Options', 3), 'DeliveryType');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $fields->replaceField(
            'DeliveryType',
            OptionsetField::create('DeliveryType', 'Delivery Type', $this->getShippingOptions())
        );

        $fields->dataFieldByName('MaxDownloads')
            ->displayIf('DeliveryType')->isEqualTo('downloaded');

        $fields->dataFieldByName('MaxDownloadsTime')
            ->displayIf('DeliveryType')->isEqualTo('downloaded');

        $fields->dataFieldByName('DefaultWeight')
            ->displayIf('DeliveryType')->isEqualTo('shipped');

        $fields->dataFieldByName('DefaultWeightUnit')
            ->displayIf('DeliveryType')->isEqualTo('shipped');

        $fields->dataFieldByName('DefaultLengthUnit')
            ->displayIf('DeliveryType')->isEqualTo('shipped');

        $fields->dataFieldByName('ShippingFlatRate')
            ->displayIf('DeliveryType')->isEqualTo('flat_rate');

        $fields->replaceField(
            'ShippingFlatRateType',
            DropdownField::create('ShippingFlatRateType', 'Flat Rate Type', $this->getShippingFlatRateTypes())
                ->setEmptyString('')
                ->displayIf('DeliveryType')->isEqualTo('flat_rate')->end()
        );

        $fields->insertBefore(HeaderField::create('HandlingHD', 'Handling Fees and Discounts', 3), 'HandlingFeeType');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $fields->replaceField(
            'HandlingFeeType',
            DropdownField::create('HandlingFeeType', 'Handling Fee Type', $this->getHandlingFeeTypes())
                ->setEmptyString('')
                ->setDescription('This determines what type of Handling Fee you would like to use.')
        );

        $fields->dataFieldByName('HandlingFee')
            ->displayIf('HandlingFeeType')->isNotEqualTo('');

        $fields->dataFieldByName('HandlingFeeMinimum')
            ->displayIf('HandlingFeeType')->isEqualTo('flat_percent_with_minimum');

        $fields->dataFieldByName('HandlingFeePercentage')
            ->displayIf('HandlingFeeType')->isEqualTo('flat_percent_with_minimum')
            ->orIf('HandlingFeeType')->isEqualTo('flat_percent');

        $fields->replaceField(
            'DiscountType',
            DropdownField::create('DiscountType', 'Discount Type', $this->getDiscountTypes())
                ->setEmptyString('')
                ->setDescription('This determines what type of per category discount you would like to use, if any.')
        );

        $fields->dataFieldByName('DiscountName')
            ->displayIf('DiscountType')->isNotEqualTo('');

        $fields->dataFieldByName('DiscountDetails')
            ->displayIf('DiscountType')->isNotEqualTo('');

        $fields->dataFieldByName('CustomsValue')
            ->setDescription('Enter a dollar amount here for the declared customs value for international shipments. If you leave this blank, the sale price of the item will be used.');

        /*

		$fields = FieldList::create(
            LiteralField::create(
                'PCIntro',
                _t(
                    'ProductCategory.PCIntro',
                    '<p>Categories must be created in your
                        <a href="https://admin.foxycart.com/admin.php?ThisAction=ManageProductCategories" target="_blank">
                            FoxyCart Product Categories
                        </a>, and also manually created in FoxyStripe.
                    </p>'
                )
            ),
            TextField::create('Code')
                ->setTitle(_t('ProductCategory.Code', 'Category Code'))
                ->setDescription(_t('ProductCategory.CodeDescription', 'copy/paste from FoxyCart')),
            TextField::create('Title')
                ->setTitle(_t('ProductCategory.Title', 'Category Title'))
                ->setDescription(_t('ProductCategory.TitleDescription', 'copy/paste from FoxyCart')),
            DropdownField::create(
                'DeliveryType',
                'Delivery Type',
                singleton('ProductCategory')->dbObject('DeliveryType')->enumValues()
            )->setEmptyString('')
        );

        $this->extend('updateCMSFields', $fields);
        */

        return $fields;
	}

	public function requireDefaultRecords() {
		parent::requireDefaultRecords();
		$allCats = DataObject::get('ProductCategory');
		if(!$allCats->count()){
			$cat = new ProductCategory();
			$cat->Title = 'Default';
<?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.");
        }
    }

}
			$cat->Code = 'DEFAULT';
<?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.");
        }
    }

}
			$cat->write();
		}
	}

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

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

	public function canDelete($member = null) {

		//don't allow deletion of DEFAULT category
		return ($this->Code == 'DEFAULT') ? false : Permission::check('Product_CANCRUD', 'any', $member);
<?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 canCreate($member = null) {
		return Permission::check('Product_CANCRUD', 'any', $member);
	}

    /**
     * @return array
     */
	public function getShippingOptions()
    {
        return [
            'shipped' => 'Shipped using live shipping rates',
            'downloaded' => 'Downloaded by the customer',
            'flat_rate' => 'Shipped using a flat rate fee',
            'pickup' => 'Picked up by the customer',
            'notshipped' => 'No Shipping',
        ];
    }

    /**
     * @return array
     */
    public function getShippingFlatRateTypes()
    {
        return [
            'per_order' => 'Charge per order',
            'per_item' => 'Charge per item',
        ];
    }

    /**
     * @return array
     */
    public function getHandlingFeeTypes()
    {
        return [
            'flat_per_order' => 'Flat fee per order with products in this category',
            'flat_per_item' => 'Flat fee per product in this category',
            'flat_percent' => 'Flat fee per shipment + % of price for products in this category',
            'flat_percent_with_minimum' => 'Flat fee per shipment OR % of order total with products in this category. Whichever is greater.',
        ];
    }

    public function getDiscountTypes()
    {
        return [
            'quantity_amount' => 'Discount by an amount based on the quantity',
            'quantity_percentage' => 'Discount by a percentage based on the quantity',
            'price_amount' => 'Discount by an amount based on the price in this category',
            'price_percentage' => 'Discount by a percentage based on the price in this category',
        ];
    }

    /**
     * @return array
     */
	public function getDataMap()
    {
        return [
            'name' => $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.");
        }
    }

}
            'code' => $this->Code,
<?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.");
        }
    }

}
            'item_delivery_type' => $this->DeliveryType,
<?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.");
        }
    }

}
            'max_downloads_per_customer' => $this->MaxDownloads,
<?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.");
        }
    }

}
            'max_downloads_time_period' => $this->MaxDownloadsTime,
<?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.");
        }
    }

}
            'customs_value' => $this->CustomsValue,
<?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.");
        }
    }

}
            'default_weight' => $this->DefaultWeight,
<?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.");
        }
    }

}
            'default_weight_unit' => $this->DefaultWeightUnit,
<?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.");
        }
    }

}
            'default_length_unit' => $this->DefautlLengthUnit,
<?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.");
        }
    }

}
            'shipping_flat_rate' => $this->ShippingFlatRate,
<?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.");
        }
    }

}
            'shipping_flat_rate_type' => $this->ShippingFlatRateType,
<?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.");
        }
    }

}
            'handling_fee_type' => $this->HandlingFeeType,
<?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.");
        }
    }

}
            'handling_fee' => $this->HandlingFee,
<?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.");
        }
    }

}
            'handling_fee_minimum' => $this->HandlingFeeMinimum,
<?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.");
        }
    }

}
            'handling_fee_percentage' => $this->HandlingFeePercentage,
<?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.");
        }
    }

}
            'discount_type' => $this->DiscountType,
<?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.");
        }
    }

}
            'discount_name' => $this->DiscountName,
<?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.");
        }
    }

}
            'discount_details' => $this->DiscountDetails,
<?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 onAfterWrite()
    {
        parent::onAfterWrite();

        if ($this->isChanged()) {
            if ($fc = new FoxyStripeClient()) {
                $fc->putCategory($this->getDataMap());
            }
        }
    }

    /**
     *
     */
    public function onAfterDelete()
    {
        parent::onAfterDelete();

        if ($fc = new FoxyStripeClient()) {
            $fc->deleteCategory($this->getDataMap());
        }
    }
}

dynamic / foxystripe

Pull Request — master (#304)

ProductCategory A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

13 Methods

Duplication Side-by-Side

Filter issues like
