ProductOption::getCMSFields() - Code Metrics - Inspection of "CHANGELOG 1.0.4" - dynamic/silverstripe-foxy - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( e312ae...228662 )

by Nic
created 2020-04-09 14:15 UTC
ProductOption::getCMSFields() B

↳ Parent: ProductOption
Complexity

Conditions	2
Paths	1
Size

Total Lines	100
Code Lines	68
Duplication

Lines	0
Ratio	0 %
Importance

Changes	3
Bugs	0	Features	0
Metric	Value
cc	2
eloc	68
c	3
b	0
f	0
nc	1
nop	0
dl	0
loc	100
rs	8.6981
How to fix Long Method

<?php

namespace Dynamic\Foxy\Model;

use Dynamic\Foxy\Extension\Purchasable;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\CurrencyField;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\HeaderField;
use SilverStripe\Forms\NumericField;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\Forms\TextField;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBBoolean;
use SilverStripe\Security\Permission;
use SilverStripe\Security\Security;

/**
 * Class ProductOption
 * @package Dynamic\Foxy\Model
 *
 * @property string Title
 *
 * The following are from many_many_extraFields
 * @property-read double WeightModifier
 * @property-read string CodeModifier
 * @property-read double PriceModifier
 * @property-read string WeightModifierAction
 * @property-read string CodeModifierAction
 * @property-read string PriceModifierAction
 * @property-read bool Available
 * @property-read int Type
 * @property-read string OptionModifierKey
 * @property-read int SortOrder
 */
class ProductOption extends DataObject
{
    /**
     * @var array
     */
    private static $db = [
        'Title' => 'Varchar(255)',
    ];

    /**
     * @var string
     */
    private static $table_name = 'ProductOption';

    /**
     * @var string
     */
    private static $singular_name = 'Option';

    /**
     * @var string
     */
    private static $plural_name = 'Options';

    /**
     * @var array
     */
    private static $defaults = [
        'ManyMany[Available]' => true,
    ];

    /**
     * @var array
     */
    private static $summary_fields = [
        'Title' => 'Title',
        'IsAvailable' => 'Available',
        'OptionType' => 'Type',
    ];

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function (FieldList $fields) {
            if ($this->exists()) {
                $fields->addFieldToTab(
                    'Root.Main',
                    ReadonlyField::create('ManyMany[OptionModifierKey]')
                        ->setTitle(_t('OptionItem.ModifierKey', 'Modifier Key'))
                );
            }

            $fields->addFieldsToTab('Root.Main', [
                CheckboxField::create('ManyMany[Available]', 'Available for purchase'),

                DropdownField::create('ManyMany[Type]', 'Option Type', OptionType::get()->map())
                    ->setEmptyString(''),

                // Weight Modifier Fields
                HeaderField::create('WeightHD', _t('OptionItem.WeightHD', 'Modify Weight'), 4),
                NumericField::create("ManyMany[WeightModifier]")
                    ->setTitle(_t('OptionItem.WeightModifier', 'Weight'))
                    ->setScale(3)
                    ->setDescription(_t(
                        'OptionItem.WeightDescription',
                        'Only supports up to 3 decimal places'
                    )),
                DropdownField::create(
                    'ManyMany[WeightModifierAction]',
                    _t('OptionItem.WeightModifierAction', 'Weight Modification'),
                    [
                        'Add' => _t(
                            'OptionItem.WeightAdd',
                            'Add to Base Weight',
                            'Add to weight'
                        ),
                        'Subtract' => _t(
                            'OptionItem.WeightSubtract',
                            'Subtract from Base Weight',
                            'Subtract from weight'
                        ),
                        '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'), 4),
                CurrencyField::create('ManyMany[PriceModifier]')
                    ->setTitle(_t('OptionItem.PriceModifier', 'Price')),
                DropdownField::create(
                    'ManyMany[PriceModifierAction]',
                    _t('OptionItem.PriceModifierAction', 'Price Modification'),
                    [
                        'Add' => _t(
                            'OptionItem.PriceAdd',
                            'Add to Base Price',
                            'Add to price'
                        ),
                        'Subtract' => _t(
                            'OptionItem.PriceSubtract',
                            'Subtract from Base Price',
                            'Subtract from price'
                        ),
                        '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'), 4),
                TextField::create('ManyMany[CodeModifier]')
                    ->setTitle(_t('OptionItem.CodeModifier', 'Code')),
                DropdownField::create(
                    'ManyMany[CodeModifierAction]',
                    _t('OptionItem.CodeModifierAction', 'Code Modification'),
                    [
                        'Add' => _t(
                            'OptionItem.CodeAdd',
                            'Add to Base Code',
                            'Add to code'
                        ),
                        'Subtract' => _t(
                            'OptionItem.CodeSubtract',
                            'Subtract from Base Code',
                            'Subtract from code'
                        ),
                        'Set' => _t('OptionItem.CodeSet', 'Set as a new Code'),
                    ]
                )
                    ->setEmptyString('')
                    ->setDescription(_t('OptionItem.CodeDescription', 'Does code modify or replace base code?')),
            ]);
        });

        return parent::getCMSFields();
    }

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

        $modifierKeyField = 'ManyMany[OptionModifierKey]';
        $this->{$modifierKeyField} = $this->getGeneratedValue();

        $codeModifierField = 'ManyMany[CodeModifier]';
        switch ($this->CodeModifierAction) {
            case 'Subtract':
            case 'Add':
                if ($this->config()->get('trimAllWhitespace') == false) {
                    // trim the right of the code - some companies use spaces to denote options
                    $trimmed = rtrim($this->{$codeModifierField});
                    // replace duplicate spaces
                    $this->{$codeModifierField} = preg_replace('/\s+/', ' ', $trimmed);
                    break;
                }
                /* falls through */
            case 'Set':
                $trimmed = trim($this->{$codeModifierField});
                $this->{$codeModifierField} = preg_replace('/\s+/', ' ', $trimmed);
                break;
        }
    }

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

        return $symbol;
    }

    /**
     * @return string
     */
    public function getWeightModifierWithSymbol()
    {
        return self::getOptionModifierActionSymbol($this->WeightModifierAction) . $this->WeightModifier;
    }

    /**
     * @return string
     */
    public function getPriceModifierWithSymbol()
    {
        return self::getOptionModifierActionSymbol($this->PriceModifierAction) . $this->PriceModifier;
    }

    /**
     * @return string
     */
    public function getCodeModifierWithSymbol()
    {
        return self::getOptionModifierActionSymbol($this->CodeModifierAction) . $this->CodeModifier;
    }

    /**
     * @return string
     */
    public function getGeneratedValue()
    {
        $modPrice = ($this->PriceModifier) ? (string)$this->PriceModifier : '0';
        $modPriceWithSymbol = self::getOptionModifierActionSymbol($this->PriceModifierAction) . $modPrice;
        $modWeight = ($this->WeightModifier) ? (string)$this->WeightModifier : '0';
        $modWeight = self::getOptionModifierActionSymbol($this->WeightModifierAction) . $modWeight;
        $modCode = self::getOptionModifierActionSymbol($this->CodeModifierAction) . $this->CodeModifier;

        return $this->Title . '{p' . $modPriceWithSymbol . '|w' . $modWeight . '|c' . $modCode . '}';
    }

    /**
     * @return mixed|string
     */
    public function getGeneratedTitle()
    {
        $modPrice = ($this->PriceModifier) ? (string)$this->PriceModifier : '0';
        $title = $this->Title;
        $title .= ($this->PriceModifier != 0) ?
            ': (' . self::getOptionModifierActionSymbol(
                $this->PriceModifierAction,
                $returnWithOnlyPlusMinus = true
            ) . '$' . $modPrice . ')' :
            '';

        return $title;
    }

    /**
     * @return bool
     */
    public function getAvailability()
    {
        $available = ($this->Available == 1) ? true : false;
        $this->extend('updateOptionAvailability', $available);

        return $available;
    }

    /**
     * @return string
     */
    public function getIsAvailable()
    {
        $available = DBBoolean::create();
        $available->setValue($this->getAvailability());

        return $available->Nice();
    }

    /**
     * @return string
     */
    public function getOptionType()
    {
        if ($this->Type) {
            $type = OptionType::get()->byID($this->Type);
            if ($type) {

                return $type->Title;
            }
        }
    }

    /**
     * @param $member
     * @return bool|int|void
     */
    public function canCreate($member = null, $context = [])
    {
        if (!$member) {
            $member = Security::getCurrentUser();
        }

        return Permission::checkMember($member, 'MANAGE_FOXY_PRODUCTS');
    }

    /**
     * @param $member
     * @return bool|int|void|null
     */
    public function canEdit($member = null, $context = [])
    public function canEdit($member = null, /** @scrutinizer ignore-unused */ $context = [])
    {
        if (!$member) {
            $member = Security::getCurrentUser();
        }

        return Permission::checkMember($member, 'MANAGE_FOXY_PRODUCTS');
    }

    /**
     * @param $member
     * @return bool|int|void
     */
    public function canDelete($member = null, $context = [])
    public function canDelete($member = null, /** @scrutinizer ignore-unused */ $context = [])
    {
        if (!$member) {
            $member = Security::getCurrentUser();
        }

        return Permission::checkMember($member, 'MANAGE_FOXY_PRODUCTS');
    }

    /**
     * @param Purchasable $product
     * @return mixed
     */
    public function getPrice($product)
    {
        switch ($this->PriceModifierAction) {
            case 'Subtract':
                return $product->Price - $this->PriceModifier;
            case 'Set':
                return $this->PriceModifier;
            case 'Add':
                return $product->Price + $this->PriceModifier;
        }

        return $product->Price;
    }

    /**
     * @param Purchasable $product
     * @return string
     */
    public function getCode($product)
    {
        switch ($this->CodeModifierAction) {
            case 'Subtract':
                return rtrim($product->Code, $this->CodeModifier);
            case 'Set':
                return $this->CodeModifier;
            case 'Add':
                return $product->Code . $this->CodeModifier;
        }

        return $product->Code;
    }
}

dynamic / silverstripe-foxy

Push — master ( e312ae...228662 )

ProductOption::getCMSFields() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like
