EditableDropdown::getFormField() - 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

EditableDropdown::getFormField() A

↳ Parent: EditableDropdown

Complexity

Conditions	4
Paths	4

Size

Total Lines	18
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	4.0582

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	11
cts	13
cp	0.8462
rs	9.2
c	0
b	0
f	0
cc	4
eloc	11
nc	4
nop	0
crap	4.0582

<?php

/**
 * EditableDropdown
 *
 * Represents a modifiable dropdown (select) box on a form
 *
 * @property bool $UseEmptyString
 * @property string $EmptyString
 *
 * @package userforms
 */
class EditableDropdown extends EditableMultipleOptionField
namespace YourVendor;

class YourClass { }
{

    private static $singular_name = 'Dropdown Field';


    private static $plural_name = 'Dropdowns';


    private static $db = array(

        'UseEmptyString' => 'Boolean',
        'EmptyString' => 'Varchar(255)',
    );

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

        $fields->addFieldToTab(
            'Root.Main',
            CheckboxField::create('UseEmptyString')
                ->setTitle('Set default empty string')
        );

        $fields->addFieldToTab(
            'Root.Main',
            TextField::create('EmptyString')
                ->setTitle('Empty String')
        );

        $fields->removeByName('Default');

        return $fields;
    }

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

}
            ->setFieldHolderTemplate('UserFormsField_holder')
            ->setTemplate('UserFormsDropdownField');

        if ($this->UseEmptyString) {
            $field->setEmptyString(($this->EmptyString) ? $this->EmptyString : '');
        }

        // Set default
        $defaultOption = $this->getDefaultOptions()->first();
        if ($defaultOption) {
            $field->setValue($defaultOption->Value);
        }
        $this->doUpdateFormField($field);
        return $field;
    }

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


1		<?php
2
3		/**
4		* EditableDropdown
5		*
6		* Represents a modifiable dropdown (select) box on a form
7		*
8		* @property bool $UseEmptyString
9		* @property string $EmptyString
10		*
11		* @package userforms
12		*/
13		class EditableDropdown extends EditableMultipleOptionField
		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...
14		{
15
16		private static $singular_name = 'Dropdown Field';
		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 = 'Dropdowns';
		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		private static $db = array(
		0 ignored issues – show Comprehensibility introduced 2016-11-16 02:44 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 2016-11-16 02:44 UTC by Report Bug Copy Issue Report The property `$db` 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		'UseEmptyString' => 'Boolean',
22		'EmptyString' => 'Varchar(255)',
23		);
24
25		/**
26		* @return FieldList
27		*/
28		public function getCMSFields()
29		{
30		$fields = parent::getCMSFields();
31
32		$fields->addFieldToTab(
33		'Root.Main',
34		CheckboxField::create('UseEmptyString')
35		->setTitle('Set default empty string')
36		);
37
38		$fields->addFieldToTab(
39		'Root.Main',
40		TextField::create('EmptyString')
41		->setTitle('Empty String')
42		);
43
44		$fields->removeByName('Default');
45
46		return $fields;
47		}
48
49		/**
50		* @return DropdownField
51		*/
52	2	public function getFormField()
53		{
54	2	$field = DropdownField::create($this->Name, $this->EscapedTitle, $this->getOptionsMap())
		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<EditableDropdown>`. 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...
55	2	->setFieldHolderTemplate('UserFormsField_holder')
56	2	->setTemplate('UserFormsDropdownField');
57
58	2	if ($this->UseEmptyString) {
59	1	$field->setEmptyString(($this->EmptyString) ? $this->EmptyString : '');
60	1	}
61
62		// Set default
63	2	$defaultOption = $this->getDefaultOptions()->first();
64	2	if ($defaultOption) {
65		$field->setValue($defaultOption->Value);
66		}
67	2	$this->doUpdateFormField($field);
68	2	return $field;
69		}
70
71		public function getSelectorField(EditableCustomRule $rule, $forOnLoad = false)
72		{
73		return "$(\"select[name='{$this->Name}']\")";
74		}
75		}
76

silverstripe / silverstripe-userforms

Pull Request — master (#636)

EditableDropdown::getFormField() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like