ElementList::getCMSFields() - Code Metrics - Inspection of "Add disallowed_elements configuration option" - dnadesign/silverstripe-elemental - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#35)

by Robbie

created 2016-06-24 03:37 UTC

ElementList::getCMSFields() B

↳ Parent: ElementList

Complexity

Conditions	5
Paths	1

Size

Total Lines	60
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Importance

Changes	10
Bugs	1	Features	1

Metric	Value
c	10
b	1
f	1
dl	0
loc	60
rs	8.6961
cc	5
eloc	40
nc	1
nop	0

How to fix Long Method

<?php

/**
 * A list contains nested {@link BaseElement} such as a list of related files.
 *
 * @package elemental
 */
class ElementList extends BaseElement
namespace YourVendor;

class YourClass { }
{

    private static $db = array(

        'ListDescription' => 'HTMLText'
    );

    private static $has_many = array(

        'Elements' => 'BaseElement'
    );

    private static $duplicate_relations = array(

        'Elements'
    );

    private static $extensions = array(

        'ElementPublishChildren'
    );

    private static $title = "Element List Element";


    private static $description = "Orderable list of elements";


    private static $enable_title_in_template = true;


    public function getCMSFields()

    {
        $elements = $this->Elements();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $isInDb = $this->isInDB();
        $allowed = $this->config()->get('allowed_elements');
        $disallowed = (array) $this->config()->get('disallowed_elements');

        $this->beforeUpdateCMSFields(function ($fields) use ($elements, $isInDb, $allowed, $disallowed) {
            $fields->removeByName('Root.Elements');
            $fields->removeByName('Elements');

            $desc = HTMLEditorField::create('ListDescription', 'List Description');
            $desc->setRightTitle('Optional');
            $fields->addFieldToTab('Root.Main', $desc);

            if ($isInDb) {
                $adder = new GridFieldAddNewMultiClass();

                if (is_array($allowed)) {
                    $list = $allowed;
                } else {
                    $classes = ClassInfo::subclassesFor('BaseElement');
                    $list = array();
                    unset($classes['BaseElement']);

                    foreach ($classes as $class) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                        if (in_array($class, $disallowed)) {
                            continue;
                        }
                        $list[$class] = singleton($class)->i18n_singular_name();
                    }
                }

                asort($list);

                $adder->setClasses($list);

                $config = GridFieldConfig_RecordEditor::create(100);
                $config->addComponent(new GridFieldSortableRows('Sort'));
                $config->removeComponentsByType('GridFieldAddNewButton');
                $config->addComponent($adder);

                $config->removeComponentsByType('GridFieldDetailForm');
                $config->addComponent(new VersionedDataObjectDetailsForm());

                $widgetArea = new GridField(
                    'Elements',
                    Config::inst()->get("ElementPageExtension", 'elements_title'),
                    $elements,
                    $config
                );

                $fields->addFieldToTab('Root.Main', $widgetArea);
            } else {
                $fields->addFieldToTab('Root.Main', LiteralField::create('warn', '<p class="message notice">Once you save this object you will be able to add items</p>'));
            }
        });

        return parent::getCMSFields();
    }

    /**
     * Used in template instead of {@link Widgets()} to wrap each widget in its
     * controller, making it easier to access and process form logic and
     * actions stored in {@link WidgetController}.
     *
     * @return SS_List - Collection of {@link WidgetController} instances.
     */
    public function WidgetControllers() {
        $controllers = new ArrayList();

        foreach($this->Elements()->filter('Enabled', 1) as $widget) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            $controller = $widget->getController();

            $controller->init();
            $controllers->push($controller);
        }

        return $controllers;
    }
}


1			<?php
2
3			/**
4			* A list contains nested {@link BaseElement} such as a list of related files.
5			*
6			* @package elemental
7			*/
8			class ElementList extends BaseElement
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-17 03:25 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...
9			{
10
11			private static $db = array(
			0 ignored issues – show Comprehensibility introduced 2016-02-17 03:25 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-02-17 03:25 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...
12			'ListDescription' => 'HTMLText'
13			);
14
15			private static $has_many = array(
			0 ignored issues – show Comprehensibility introduced 2016-02-17 03:25 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-02-17 03:25 UTC by Report Bug Copy Issue Report The property `$has_many` 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...
16			'Elements' => 'BaseElement'
17			);
18
19			private static $duplicate_relations = array(
			0 ignored issues – show Unused Code introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The property `$duplicate_relations` 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...
20			'Elements'
21			);
22
23			private static $extensions = array(
			0 ignored issues – show Comprehensibility introduced 2016-02-17 03:25 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-02-17 03:25 UTC by Report Bug Copy Issue Report The property `$extensions` 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...
24			'ElementPublishChildren'
25			);
26
27			private static $title = "Element List Element";
			0 ignored issues – show Comprehensibility introduced 2016-02-17 03:25 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-02-17 03:25 UTC by Report Bug Copy Issue Report The property `$title` 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...
28
29			private static $description = "Orderable list of elements";
			0 ignored issues – show Comprehensibility introduced 2016-02-17 03:25 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-02-17 03:25 UTC by Report Bug Copy Issue Report The property `$description` 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...
30
31			private static $enable_title_in_template = true;
			0 ignored issues – show Comprehensibility introduced 2016-05-31 23:56 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-05-31 23:56 UTC by Report Bug Copy Issue Report The property `$enable_title_in_template` 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...
32
33			public function getCMSFields()
			0 ignored issues – show Documentation introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
34			{
35			$elements = $this->Elements();
			0 ignored issues – show Documentation Bug introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The method `Elements` does not exist on `object<ElementList>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
36			$isInDb = $this->isInDB();
37			$allowed = $this->config()->get('allowed_elements');
38			$disallowed = (array) $this->config()->get('disallowed_elements');
39
40			$this->beforeUpdateCMSFields(function ($fields) use ($elements, $isInDb, $allowed, $disallowed) {
41			$fields->removeByName('Root.Elements');
42			$fields->removeByName('Elements');
43
44			$desc = HTMLEditorField::create('ListDescription', 'List Description');
45			$desc->setRightTitle('Optional');
46			$fields->addFieldToTab('Root.Main', $desc);
47
48			if ($isInDb) {
49			$adder = new GridFieldAddNewMultiClass();
50
51			if (is_array($allowed)) {
52			$list = $allowed;
53			} else {
54			$classes = ClassInfo::subclassesFor('BaseElement');
55			$list = array();
56			unset($classes['BaseElement']);
57
58			foreach ($classes as $class) {
			0 ignored issues – show Bug introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The expression `$classes` of type `null\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
59			if (in_array($class, $disallowed)) {
60			continue;
61			}
62			$list[$class] = singleton($class)->i18n_singular_name();
63			}
64			}
65
66			asort($list);
67
68			$adder->setClasses($list);
69
70			$config = GridFieldConfig_RecordEditor::create(100);
71			$config->addComponent(new GridFieldSortableRows('Sort'));
72			$config->removeComponentsByType('GridFieldAddNewButton');
73			$config->addComponent($adder);
74
75			$config->removeComponentsByType('GridFieldDetailForm');
76			$config->addComponent(new VersionedDataObjectDetailsForm());
77
78			$widgetArea = new GridField(
79			'Elements',
80			Config::inst()->get("ElementPageExtension", 'elements_title'),
81			$elements,
82			$config
83			);
84
85			$fields->addFieldToTab('Root.Main', $widgetArea);
86			} else {
87			$fields->addFieldToTab('Root.Main', LiteralField::create('warn', '<p class="message notice">Once you save this object you will be able to add items</p>'));
88			}
89			});
90
91			return parent::getCMSFields();
92			}
93
94			/**
95			* Used in template instead of {@link Widgets()} to wrap each widget in its
96			* controller, making it easier to access and process form logic and
97			* actions stored in {@link WidgetController}.
98			*
99			* @return SS_List - Collection of {@link WidgetController} instances.
100			*/
101			public function WidgetControllers() {
102			$controllers = new ArrayList();
103
104			foreach($this->Elements()->filter('Enabled', 1) as $widget) {
			0 ignored issues – show Documentation Bug introduced 2016-02-22 21:27 UTC by Report Bug Copy Issue Report The method `Elements` does not exist on `object<ElementList>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
105			$controller = $widget->getController();
106
107			$controller->init();
108			$controllers->push($controller);
109			}
110
111			return $controllers;
112			}
113			}
114

dnadesign / silverstripe-elemental

Pull Request — master (#35)

ElementList::getCMSFields() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like