EditableFormStep - Code Metrics - Inspection of "Removed unneeded list markup from EditableRadioFie..." - silverstripe/silverstripe-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#636)

by Franco

created 2017-07-11 04:46 UTC

EditableFormStep A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Test Coverage

Coverage

33.33%

Importance

Changes

Metric	Value
wmc	10
lcom	2
cbo	4
dl	0
loc	88
ccs	11
cts	33
cp	0.3333
rs	10
c	0
b	0
f	0

7 Methods

Rating	Name	Size	Complexity
A	getCMSFields()	8	1
A	getFormField()	8	1
A	updateFormField()	7	2
A	showInReports()	4	1
A	getInlineClassnameField()	7	1
A	getCMSTitle()	14	3
A	getSelectorHolder()	4	1

<?php
/**
 * A step in multi-page user form
 *
 * @package userforms
 */
class EditableFormStep extends EditableFormField
namespace YourVendor;

class YourClass { }
{

    private static $singular_name = 'Page Break';


    private static $plural_name = 'Page Breaks';


    /**
     * Disable selection of step class
     *
     * @config
     * @var bool
     */
    private static $hidden = true;


    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $fields->removeByName(array('MergeField', 'Default', 'Validation', 'RightTitle'));

        return $fields;
    }

    /**
     * @return FormField
     */
    public function getFormField()
    {
        $field = UserFormsStepField::create()
            ->setName($this->Name)
            ->setTitle($this->EscapedTitle);
<?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.");
        }
    }

}
        $this->doUpdateFormField($field);
        return $field;
    }

    protected function updateFormField($field)
    {
        // if this field has an extra class
        if ($this->ExtraClass) {
<?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.");
        }
    }

}
            $field->addExtraClass($this->ExtraClass);
<?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 boolean
     */
    public function showInReports()
    {
        return false;
    }

    public function getInlineClassnameField($column, $fieldClasses)
    {
        return new LabelField(
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            $column,
            $this->CMSTitle
<?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 getCMSTitle()
    {
        $title = $this->getFieldNumber()
            ?: $this->Title
            ?: '';

        return _t(
            'EditableFormStep.STEP_TITLE',
            'Page {page}',
            array(
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                'page' => $title
            )
        );
    }

    /**
     * Get the JS expression for selecting the holder for this field
     *
     * @return string
     */
    public function getSelectorHolder()
    {
        return "$(\".step-button-wrapper[data-for='{$this->Name}']\")";
    }
}


1		<?php
2		/**
3		* A step in multi-page user form
4		*
5		* @package userforms
6		*/
7		class EditableFormStep extends EditableFormField
		0 ignored issues – show Coding Style Compatibility introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
8		{
9
10		private static $singular_name = 'Page Break';
		0 ignored issues – show Comprehensibility introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `$singular_name` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
11
12		private static $plural_name = 'Page Breaks';
		0 ignored issues – show Comprehensibility introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `$plural_name` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
13
14		/**
15		* Disable selection of step class
16		*
17		* @config
18		* @var bool
19		*/
20		private static $hidden = true;
		0 ignored issues – show Comprehensibility introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `$hidden` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
21
22		/**
23		* @return FieldList
24		*/
25		public function getCMSFields()
26		{
27		$fields = parent::getCMSFields();
28
29		$fields->removeByName(array('MergeField', 'Default', 'Validation', 'RightTitle'));
30
31		return $fields;
32		}
33
34		/**
35		* @return FormField
36		*/
37	9	public function getFormField()
38		{
39	9	$field = UserFormsStepField::create()
40	9	->setName($this->Name)
41	9	->setTitle($this->EscapedTitle);
		0 ignored issues – show Documentation introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `EscapedTitle` does not exist on `object<EditableFormStep>`. 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...
42	9	$this->doUpdateFormField($field);
43	9	return $field;
44		}
45
46	9	protected function updateFormField($field)
47		{
48		// if this field has an extra class
49	9	if ($this->ExtraClass) {
		0 ignored issues – show Documentation introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `ExtraClass` does not exist on `object<EditableFormStep>`. 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...
50		$field->addExtraClass($this->ExtraClass);
		0 ignored issues – show Documentation introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `ExtraClass` does not exist on `object<EditableFormStep>`. 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...
51		}
52	9	}
53
54		/**
55		* @return boolean
56		*/
57	2	public function showInReports()
58		{
59	2	return false;
60		}
61
62		public function getInlineClassnameField($column, $fieldClasses)
63		{
64		return new LabelField(
		0 ignored issues – show Bug Best Practice introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The return type of `return new \LabelField($column, $this->CMSTitle);` (`LabelField`) is incompatible with the return type of the parent method `EditableFormField::getInlineClassnameField` of type `DropdownField`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
65		$column,
66		$this->CMSTitle
		0 ignored issues – show Documentation introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `CMSTitle` does not exist on `object<EditableFormStep>`. 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...
67		);
68		}
69
70		public function getCMSTitle()
71		{
72		$title = $this->getFieldNumber()
73		?: $this->Title
74		?: '';
75
76		return _t(
77		'EditableFormStep.STEP_TITLE',
78		'Page {page}',
79		array(
		0 ignored issues – show Documentation introduced 2015-12-11 05:10 UTC by Report Bug Copy Issue Report `array('page' => $title)` is of type `array<string,string,{"page":"string"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
80		'page' => $title
81		)
82		);
83		}
84
85		/**
86		* Get the JS expression for selecting the holder for this field
87		*
88		* @return string
89		*/
90		public function getSelectorHolder()
91		{
92		return "$(\".step-button-wrapper[data-for='{$this->Name}']\")";
93		}
94		}
95

silverstripe / silverstripe-userforms

Pull Request — master (#636)

EditableFormStep A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

7 Methods

Duplication Side-by-Side

Filter issues like