OptionGroup::getCMSFields() - Code Metrics - Inspection of "BUGFIX modifiers error in admin if no product is s..." - dynamic/foxystripe - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 2024_06_18_noProductSet ( f96c1e )

by Nic

created 2024-06-18 18:04 UTC

OptionGroup::getCMSFields() A

↳ Parent: OptionGroup

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	6
dl	0
loc	12
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Dynamic\FoxyStripe\Model;

use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\HeaderField;
use SilverStripe\Forms\RequiredFields;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\Security\Permission;

/**
 * Class OptionGroup
 * @package Dynamic\FoxyStripe\Model
 *
 * @property \SilverStripe\ORM\FieldType\DBVarchar Title
 *
 * @method \SilverStripe\ORM\HasManyList Options
 */
class OptionGroup extends DataObject
{
    /**
     * @var array
     */
    private static $db = array(

        'Title' => 'Varchar(100)',
    );

    /**
     * @var array
     */
    private static $has_many = array(

        'Options' => OptionItem::class,
    );

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


    /**
     * @var string
     */
    private static $plural_name = 'Product Option Groups';


    /**
     * @var string
     */
    private static $description = 'Groups of product options, e.g. size, color, etc';


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


    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function (FieldList $fields) {
            $fields->removeByName('Options');

            $fields->addFieldToTab(
                'Root.Options',
                HeaderField::create('OptionsHeader', 'Options can be added on Product Pages.', 3)
            );
        });

        return parent::getCMSFields();
    }

    /**
     * @throws \SilverStripe\ORM\ValidationException
     */
    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        // create a catch-all group
        if (!self::get()->filter(array('Title' => 'Options'))->first()) {
            $do = new self();
            $do->Title = 'Options';

            $do->write();
        }
        if (!self::get()->filter(array('Title' => 'Size'))->first()) {
            $do = new self();
            $do->Title = 'Size';
            $do->write();
        }
        if (!self::get()->filter(array('Title' => 'Color'))->first()) {
            $do = new self();
            $do->Title = 'Color';
            $do->write();
        }
        if (!self::get()->filter(array('Title' => 'Type'))->first()) {
            $do = new self();
            $do->Title = 'Type';
            $do->write();
        }
    }

    /**
     * @return RequiredFields
     */
    public function getCMSValidator()
    {
        return new RequiredFields(array('Title'));
    }

    /**
     * @return ValidationResult
     */
    public function validate()
    {
        $result = parent::validate();

        $title = $this->Title;
        $firstChar = substr($title, 0, 1);
        if (preg_match('/[^a-zA-Z]/', $firstChar)) {
            $result->addError('The first character of the Title can only be a letter', 'bad');
        }
        if (preg_match('/[^a-zA-Z]\s/', $title)) {
            $result->addError('Please only use letters, numbers and spaces in the title', 'bad');
        }

        return $result;
    }

    /**
     * @throws \SilverStripe\ORM\ValidationException
     */
    public function onBeforeDelete()
    {
        parent::onBeforeDelete();

        //make sure that if we delete this option group, we reassign the group's option items to the 'None' group.
        $items = OptionItem::get()->filter(array('ProductOptionGroupID' => $this->ID));

        if (isset($items)) {
            if ($noneGroup = self::get()->filter(array('Title' => 'Options'))->first()) {
                /** @var OptionItem $item */
                foreach ($items as $item) {
                    $item->ProductOptionGroupID = $noneGroup->ID;
                    $item->write();
                }
            }
        }
    }

    /**
     * @param bool $member
     *
     * @return bool
     */
    public function canView($member = null)
    {
        return true;
    }

    /**
     * @param null $member

     *
     * @return bool|int
     */
    public function canEdit($member = null)
    {
        switch ($this->Title) {
            case 'Options':
                return false;
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            default:
                return Permission::check('Product_CANCRUD', 'any', $member);
                break;
        }
    }

    /**
     * @param null $member

     *
     * @return bool|int
     */
    public function canDelete($member = null)
    {
        return $this->canEdit($member);
    }

    /**
     * @param null $member

     * @param array $context
     *
     * @return bool|int
     */
    public function canCreate($member = null, $context = [])
    {
        return Permission::check('Product_CANCRUD', 'any', $member);
    }
}


1			<?php
2
3			namespace Dynamic\FoxyStripe\Model;
4
5			use SilverStripe\Forms\FieldList;
6			use SilverStripe\Forms\HeaderField;
7			use SilverStripe\Forms\RequiredFields;
8			use SilverStripe\ORM\DataObject;
9			use SilverStripe\ORM\ValidationResult;
10			use SilverStripe\Security\Permission;
11
12			/**
13			* Class OptionGroup
14			* @package Dynamic\FoxyStripe\Model
15			*
16			* @property \SilverStripe\ORM\FieldType\DBVarchar Title
17			*
18			* @method \SilverStripe\ORM\HasManyList Options
19			*/
20			class OptionGroup extends DataObject
21			{
22			/**
23			* @var array
24			*/
25			private static $db = array(
			0 ignored issues – show introduced 2018-03-03 21:50 UTC by Report Bug Copy Issue Report The private property `$db` is not used, and could be removed. Loading history...
26			'Title' => 'Varchar(100)',
27			);
28
29			/**
30			* @var array
31			*/
32			private static $has_many = array(
			0 ignored issues – show introduced 2018-03-03 21:50 UTC by Report Bug Copy Issue Report The private property `$has_many` is not used, and could be removed. Loading history...
33			'Options' => OptionItem::class,
34			);
35
36			/**
37			* @var string
38			*/
39			private static $singular_name = 'Product Option Group';
			0 ignored issues – show introduced 2018-03-03 21:50 UTC by Report Bug Copy Issue Report The private property `$singular_name` is not used, and could be removed. Loading history...
40
41			/**
42			* @var string
43			*/
44			private static $plural_name = 'Product Option Groups';
			0 ignored issues – show introduced 2018-03-03 21:50 UTC by Report Bug Copy Issue Report The private property `$plural_name` is not used, and could be removed. Loading history...
45
46			/**
47			* @var string
48			*/
49			private static $description = 'Groups of product options, e.g. size, color, etc';
			0 ignored issues – show introduced 2018-03-03 21:50 UTC by Report Bug Copy Issue Report The private property `$description` is not used, and could be removed. Loading history...
50
51			/**
52			* @var string
53			*/
54			private static $table_name = 'OptionGroup';
			0 ignored issues – show introduced 2018-03-03 21:50 UTC by Report Bug Copy Issue Report The private property `$table_name` is not used, and could be removed. Loading history...
55
56			/**
57			* @return FieldList
58			*/
59			public function getCMSFields()
60			{
61			$this->beforeUpdateCMSFields(function (FieldList $fields) {
62			$fields->removeByName('Options');
63
64			$fields->addFieldToTab(
65			'Root.Options',
66			HeaderField::create('OptionsHeader', 'Options can be added on Product Pages.', 3)
67			);
68			});
69
70			return parent::getCMSFields();
71			}
72
73			/**
74			* @throws \SilverStripe\ORM\ValidationException
75			*/
76			public function requireDefaultRecords()
77			{
78			parent::requireDefaultRecords();
79			// create a catch-all group
80			if (!self::get()->filter(array('Title' => 'Options'))->first()) {
81			$do = new self();
82			$do->Title = 'Options';
			0 ignored issues – show Documentation Bug introduced 2018-03-13 20:32 UTC by Report Bug Copy Issue Report It seems like `'Options'` of type `string` is incompatible with the declared type `SilverStripe\ORM\FieldType\DBVarchar` of property `$Title`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
83			$do->write();
84			}
85			if (!self::get()->filter(array('Title' => 'Size'))->first()) {
86			$do = new self();
87			$do->Title = 'Size';
88			$do->write();
89			}
90			if (!self::get()->filter(array('Title' => 'Color'))->first()) {
91			$do = new self();
92			$do->Title = 'Color';
93			$do->write();
94			}
95			if (!self::get()->filter(array('Title' => 'Type'))->first()) {
96			$do = new self();
97			$do->Title = 'Type';
98			$do->write();
99			}
100			}
101
102			/**
103			* @return RequiredFields
104			*/
105			public function getCMSValidator()
106			{
107			return new RequiredFields(array('Title'));
108			}
109
110			/**
111			* @return ValidationResult
112			*/
113			public function validate()
114			{
115			$result = parent::validate();
116
117			$title = $this->Title;
118			$firstChar = substr($title, 0, 1);
119			if (preg_match('/[^a-zA-Z]/', $firstChar)) {
120			$result->addError('The first character of the Title can only be a letter', 'bad');
121			}
122			if (preg_match('/[^a-zA-Z]\s/', $title)) {
123			$result->addError('Please only use letters, numbers and spaces in the title', 'bad');
124			}
125
126			return $result;
127			}
128
129			/**
130			* @throws \SilverStripe\ORM\ValidationException
131			*/
132			public function onBeforeDelete()
133			{
134			parent::onBeforeDelete();
135
136			//make sure that if we delete this option group, we reassign the group's option items to the 'None' group.
137			$items = OptionItem::get()->filter(array('ProductOptionGroupID' => $this->ID));
138
139			if (isset($items)) {
140			if ($noneGroup = self::get()->filter(array('Title' => 'Options'))->first()) {
141			/** @var OptionItem $item */
142			foreach ($items as $item) {
143			$item->ProductOptionGroupID = $noneGroup->ID;
144			$item->write();
145			}
146			}
147			}
148			}
149
150			/**
151			* @param bool $member
152			*
153			* @return bool
154			*/
155			public function canView($member = null)
156			{
157			return true;
158			}
159
160			/**
161			* @param null $member
			0 ignored issues – show Documentation Bug introduced 2018-03-03 21:54 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$member` is correct as it would always require `null` to be passed? Loading history...
162			*
163			* @return bool\|int
164			*/
165			public function canEdit($member = null)
166			{
167			switch ($this->Title) {
168			case 'Options':
169			return false;
170			break;
			0 ignored issues – show Unused Code introduced 2018-03-03 21:50 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
171			default:
172			return Permission::check('Product_CANCRUD', 'any', $member);
173			break;
174			}
175			}
176
177			/**
178			* @param null $member
			0 ignored issues – show Documentation Bug introduced 2018-03-03 21:54 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$member` is correct as it would always require `null` to be passed? Loading history...
179			*
180			* @return bool\|int
181			*/
182			public function canDelete($member = null)
183			{
184			return $this->canEdit($member);
185			}
186
187			/**
188			* @param null $member
			0 ignored issues – show Documentation Bug introduced 2018-03-13 20:32 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$member` is correct as it would always require `null` to be passed? Loading history...
189			* @param array $context
190			*
191			* @return bool\|int
192			*/
193			public function canCreate($member = null, $context = [])
194			{
195			return Permission::check('Product_CANCRUD', 'any', $member);
196			}
197			}
198

dynamic / foxystripe

Push — 2024_06_18_noProductSet ( f96c1e )

OptionGroup::getCMSFields() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like