OptionGroup::canEdit() - 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

OptionGroup::canEdit() A

↳ Parent: OptionGroup

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	11
c	0
b	0
f	0
ccs	0
cts	7
cp	0
rs	9.4285
cc	2
eloc	8
nc	2
nop	1
crap	6

<?php
/**
 *
 * @package FoxyStripe
 *
 */

class OptionGroup extends DataObject{

	private static $db = array(
		'Title' => 'Varchar(100)'
	);

    private static $singular_name = 'Product Option Group';
	private static $plural_name = 'Product Option Groups';
	private static $description = 'Groups of product options, e.g. size, color, etc';

	function getCMSFields(){


		$fields = parent::getCMSFields();

		$this->extend('getCMSFields', $fields);

		return $fields;
	}

	public function requireDefaultRecords() {
		parent::requireDefaultRecords();
		// create a catch-all group
		if(!OptionGroup::get()->filter(array('Title' => 'Options'))->first()) {

			$do = new OptionGroup();
			$do->Title = "Options";
<?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.");
        }
    }

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

            $do = new OptionGroup();
            $do->Title = "Size";
<?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.");
        }
    }

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

            $do = new OptionGroup();
            $do->Title = "Color";
<?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.");
        }
    }

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

            $do = new OptionGroup();
            $do->Title = "Type";
<?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.");
        }
    }

}
            $do->write();
        }
	}

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

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

		$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.");
        }
    }

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

		return $result;
	}

	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)){
			$noneGroup = OptionGroup::get()->filter(array('Title' => 'Options'))->first();
			foreach($items as $item){
				$item->ProductOptionGroupID = $noneGroup->ID;
				$item->write();
			}
		}
	}

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

	public function canEdit($member = null) {
		switch($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.");
        }
    }

}
			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');
				break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
		}

	}

	public function canDelete($member = null) {
		return $this->canEdit();
	}

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

}


1		<?php
2		/**
3		*
4		* @package FoxyStripe
5		*
6		*/
7
8		class OptionGroup extends DataObject{
9
10		private static $db = array(
11		'Title' => 'Varchar(100)'
12		);
13
14		private static $singular_name = 'Product Option Group';
15		private static $plural_name = 'Product Option Groups';
16		private static $description = 'Groups of product options, e.g. size, color, etc';
17
18		function getCMSFields(){
		0 ignored issues – show Best Practice introduced 2016-10-01 18:12 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
19
20		$fields = parent::getCMSFields();
21
22		$this->extend('getCMSFields', $fields);
23
24		return $fields;
25		}
26
27		public function requireDefaultRecords() {
28		parent::requireDefaultRecords();
29		// create a catch-all group
30	View Code Duplication	if(!OptionGroup::get()->filter(array('Title' => 'Options'))->first()) {
		0 ignored issues – show Duplication introduced 2016-10-01 18:12 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
31		$do = new OptionGroup();
32		$do->Title = "Options";
		0 ignored issues – show Documentation introduced 2016-10-01 18:12 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<OptionGroup>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?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."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
33		$do->write();
34		}
35	View Code Duplication	if(!OptionGroup::get()->filter(array('Title' => 'Size'))->first()) {
		0 ignored issues – show Duplication introduced 2016-10-01 18:12 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
36		$do = new OptionGroup();
37		$do->Title = "Size";
		0 ignored issues – show Documentation introduced 2016-10-01 18:12 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<OptionGroup>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?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."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
38		$do->write();
39		}
40	View Code Duplication	if(!OptionGroup::get()->filter(array('Title' => 'Color'))->first()) {
		0 ignored issues – show Duplication introduced 2016-10-01 18:12 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
41		$do = new OptionGroup();
42		$do->Title = "Color";
		0 ignored issues – show Documentation introduced 2016-10-01 18:12 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<OptionGroup>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?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."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
43		$do->write();
44		}
45	View Code Duplication	if(!OptionGroup::get()->filter(array('Title' => 'Type'))->first()) {
		0 ignored issues – show Duplication introduced 2016-10-01 18:12 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
46		$do = new OptionGroup();
47		$do->Title = "Type";
		0 ignored issues – show Documentation introduced 2016-10-01 18:12 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<OptionGroup>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?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."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
48		$do->write();
49		}
50		}
51
52		public function getCMSValidator() {
53		return new RequiredFields(array('Title'));
54		}
55
56		public function validate(){
57		$result = parent::validate();
58
59		$title = $this->Title;
		0 ignored issues – show Documentation introduced 2016-10-01 18:12 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<OptionGroup>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?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."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
60		$firstChar = substr($title, 0, 1);
61		if(preg_match('/[^a-zA-Z]/', $firstChar)){
62		$result->error('The first character of the Title can only be a letter', 'bad');
63		}
64		if(preg_match('/[^a-zA-Z]\s/', $title)){
65		$result->error('Please only use letters, numbers and spaces in the title', 'bad');
66		}
67
68		return $result;
69		}
70
71		public function onBeforeDelete(){
72		parent::onBeforeDelete();
73
74		//make sure that if we delete this option group, we reassign the group's option items to the 'None' group.
75		$items = OptionItem::get()->filter(array('ProductOptionGroupID' => $this->ID));
76
77		if(isset($items)){
78		$noneGroup = OptionGroup::get()->filter(array('Title' => 'Options'))->first();
79		foreach($items as $item){
80		$item->ProductOptionGroupID = $noneGroup->ID;
81		$item->write();
82		}
83		}
84		}
85
86		public function canView($member = false) {
87		return true;
88		}
89
90		public function canEdit($member = null) {
91		switch($this->Title){
		0 ignored issues – show Documentation introduced 2016-10-01 18:12 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<OptionGroup>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?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."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
92		case 'Options':
93		return false;
94		break;
		0 ignored issues – show Unused Code introduced 2016-10-01 18:12 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...
95		default:
96		return Permission::check('Product_CANCRUD');
97		break;
		0 ignored issues – show Unused Code introduced 2016-10-01 18:12 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...
98		}
99
100		}
101
102		public function canDelete($member = null) {
103		return $this->canEdit();
104		}
105
106		public function canCreate($member = null) {
107		return Permission::check('Product_CANCRUD');
108		}
109
110		}
111

dynamic / foxystripe

Pull Request — master (#292)

OptionGroup::canEdit() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like