EditableFormStep - Code Metrics - Inspection of "API Upgrade for SS4 compatibility" - silverstripe/silverstripe-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#647)

by Robbie

created 2017-08-21 22:59 UTC

EditableFormStep A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes

Metric	Value
wmc	10
lcom	2
cbo	4
dl	0
loc	84
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()	4	1
A	getCMSTitle()	12	3
A	getSelectorHolder()	4	1

<?php

namespace SilverStripe\UserForms\Model\EditableFormField;

use SilverStripe\Forms\LabelField;
use SilverStripe\UserForms\FormField\UserFormsStepField;
use SilverStripe\UserForms\Model\EditableFormField;

/**
 * A step in multi-page user form
 *
 * @package userforms
 */
class EditableFormStep extends EditableFormField
{
    private static $singular_name = 'Page Break';


    private static $plural_name = 'Page Breaks';


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


    private static $table_name = 'EditableFormStep';


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

        $fields->removeByName(['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);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        return $field;
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());
}
    }

    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 LabelField::create($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(
            __CLASS__.'.STEP_TITLE',
            'Page {page}',
            ['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			namespace SilverStripe\UserForms\Model\EditableFormField;
4
5			use SilverStripe\Forms\LabelField;
6			use SilverStripe\UserForms\FormField\UserFormsStepField;
7			use SilverStripe\UserForms\Model\EditableFormField;
8
9			/**
10			* A step in multi-page user form
11			*
12			* @package userforms
13			*/
14			class EditableFormStep extends EditableFormField
15			{
16			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...
17
18			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...
19
20			/**
21			* Disable selection of step class
22			*
23			* @config
24			* @var bool
25			*/
26			private static $hidden = true;
			0 ignored issues – show Comprehensibility introduced 2017-08-16 02:04 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 2017-08-16 02:04 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...
27
28			private static $table_name = 'EditableFormStep';
			0 ignored issues – show Comprehensibility introduced 2017-08-16 02:04 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 2017-08-16 02:04 UTC by Report Bug Copy Issue Report The property `$table_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...
29
30			/**
31			* @return FieldList
32			*/
33			public function getCMSFields()
34			{
35			$fields = parent::getCMSFields();
36
37			$fields->removeByName(['MergeField', 'Default', 'Validation', 'RightTitle']);
38
39			return $fields;
40			}
41
42			/**
43			* @return FormField
44			*/
45			public function getFormField()
46			{
47			$field = UserFormsStepField::create()
48			->setName($this->Name)
49			->setTitle($this->EscapedTitle);
			0 ignored issues – show Documentation introduced 2017-08-16 02:04 UTC by Report Bug Copy Issue Report The property `EscapedTitle` does not exist on `object<SilverStripe\User...Field\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			$this->doUpdateFormField($field);
			0 ignored issues – show Documentation introduced 2017-08-16 02:04 UTC by Report Bug Copy Issue Report `$field` is of type `object<SilverStripe\User...eld\UserFormsStepField>`, but the function expects a `object<SilverStripe\UserForms\Model\FormField>`. 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...
51			return $field;
			0 ignored issues – show Bug Best Practice introduced 2017-08-16 02:04 UTC by Report Bug Copy Issue Report The return type of `return $field;` (`SilverStripe\UserForms\F...ield\UserFormsStepField`) is incompatible with the return type of the parent method `SilverStripe\UserForms\M...FormField::getFormField` of type `SilverStripe\UserForms\Model\FormField\|null`. 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...
52			}
53
54			protected function updateFormField($field)
55			{
56			// if this field has an extra class
57			if ($this->ExtraClass) {
			0 ignored issues – show Documentation introduced 2017-08-16 02:04 UTC by Report Bug Copy Issue Report The property `ExtraClass` does not exist on `object<SilverStripe\User...Field\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...
58			$field->addExtraClass($this->ExtraClass);
			0 ignored issues – show Documentation introduced 2017-08-16 02:04 UTC by Report Bug Copy Issue Report The property `ExtraClass` does not exist on `object<SilverStripe\User...Field\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...
59			}
60			}
61
62			/**
63			* @return boolean
64			*/
65			public function showInReports()
66			{
67			return false;
68			}
69
70			public function getInlineClassnameField($column, $fieldClasses)
71			{
72			return LabelField::create($column, $this->CMSTitle);
			0 ignored issues – show Documentation introduced 2017-08-16 02:04 UTC by Report Bug Copy Issue Report The property `CMSTitle` does not exist on `object<SilverStripe\User...Field\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... Bug Best Practice introduced 2017-08-16 02:04 UTC by Report Bug Copy Issue Report The return type of `return \SilverStripe\For...lumn, $this->CMSTitle);` (`SilverStripe\Forms\LabelField`) is incompatible with the return type of the parent method `SilverStripe\UserForms\M...getInlineClassnameField` of type `SilverStripe\Forms\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...
73			}
74
75			public function getCMSTitle()
76			{
77			$title = $this->getFieldNumber()
78			?: $this->Title
79			?: '';
80
81			return _t(
82			__CLASS__.'.STEP_TITLE',
83			'Page {page}',
84			['page' => $title]
85			);
86			}
87
88			/**
89			* Get the JS expression for selecting the holder for this field
90			*
91			* @return string
92			*/
93			public function getSelectorHolder()
94			{
95			return "$(\".step-button-wrapper[data-for='{$this->Name}']\")";
96			}
97			}
98

silverstripe / silverstripe-userforms

Pull Request — master (#647)

EditableFormStep A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

Duplication Side-by-Side

Filter issues like