EditableCountryDropdownField::getFormField() - 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-09-04 22:14 UTC

EditableCountryDropdownField::getFormField() A

↳ Parent: EditableCountryDropdownField

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	7
nc	1
nop	0

<?php

namespace SilverStripe\UserForms\Model\EditableFormField;

use SilverStripe\Core\Manifest\ModuleLoader;
use SilverStripe\Forms\DropdownField;
use SilverStripe\i18n\i18n;
use SilverStripe\UserForms\Model\EditableCustomRule;
use SilverStripe\UserForms\Model\EditableFormField;

/**
 * A dropdown field which allows the user to select a country
 *
 * @package userforms
 */
class EditableCountryDropdownField extends EditableFormField
{
    private static $singular_name = 'Country Dropdown';


    private static $plural_name = 'Country Dropdowns';


    private static $table_name = 'EditableCountryDropdownField';


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

        $fields->removeByName('Default');

        return $fields;
    }

    public function getFormField()
    {
        $field = DropdownField::create($this->Name, $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.");
        }
    }

}
            ->setSource(i18n::getData()->getCountries())
            ->setFieldHolderTemplate(EditableFormField::class . '_holder')
            ->setTemplate(EditableDropdown::class);

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

    public function getValueFromData($data)
    {
        if (isset($data[$this->Name])) {
            $source = $this->getFormField()->getSource();
            return $source[$data[$this->Name]];
        }
    }

    public function getIcon()
    {
        return ModuleLoader::getModule('silverstripe/userforms')
            ->getRelativeResourcePath('images/editabledropdown.png');
    }

    public function getSelectorField(EditableCustomRule $rule, $forOnLoad = false)
    {
        return "$(\"select[name='{$this->Name}']\")";
    }
}


1			<?php
2
3			namespace SilverStripe\UserForms\Model\EditableFormField;
4
5			use SilverStripe\Core\Manifest\ModuleLoader;
6			use SilverStripe\Forms\DropdownField;
7			use SilverStripe\i18n\i18n;
8			use SilverStripe\UserForms\Model\EditableCustomRule;
9			use SilverStripe\UserForms\Model\EditableFormField;
10
11			/**
12			* A dropdown field which allows the user to select a country
13			*
14			* @package userforms
15			*/
16			class EditableCountryDropdownField extends EditableFormField
17			{
18			private static $singular_name = 'Country Dropdown';
			0 ignored issues – show Comprehensibility introduced 2016-02-27 19:10 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...
19
20			private static $plural_name = 'Country Dropdowns';
			0 ignored issues – show Comprehensibility introduced 2016-02-27 19:10 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...
21
22			private static $table_name = 'EditableCountryDropdownField';
			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...
23
24			/**
25			* @return FieldList
26			*/
27			public function getCMSFields()
28			{
29			$fields = parent::getCMSFields();
30
31			$fields->removeByName('Default');
32
33			return $fields;
34			}
35
36			public function getFormField()
37			{
38			$field = DropdownField::create($this->Name, $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...leCountryDropdownField>`. 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...
39			->setSource(i18n::getData()->getCountries())
40			->setFieldHolderTemplate(EditableFormField::class . '_holder')
41			->setTemplate(EditableDropdown::class);
42
43			$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\Forms\DropdownField>`, 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...
44
45			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\Forms\DropdownField`) 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...
46			}
47
48			public function getValueFromData($data)
49			{
50			if (isset($data[$this->Name])) {
51			$source = $this->getFormField()->getSource();
52			return $source[$data[$this->Name]];
53			}
54			}
55
56			public function getIcon()
57			{
58			return ModuleLoader::getModule('silverstripe/userforms')
59			->getRelativeResourcePath('images/editabledropdown.png');
60			}
61
62			public function getSelectorField(EditableCustomRule $rule, $forOnLoad = false)
63			{
64			return "$(\"select[name='{$this->Name}']\")";
65			}
66			}
67

silverstripe / silverstripe-userforms

Pull Request — master (#647)

EditableCountryDropdownField::getFormField() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like