AttachmentFormGroup - Code Metrics - Inspection of "fix AttachmentFormGroup bug with widget refresh" - locomotivemtl/charcoal-attachment - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4)

unknown

created 2020-04-27 19:25 UTC

AttachmentFormGroup A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	186
Duplicated Lines	5.91 %

Coupling/Cohesion

Components	3
Dependencies	4

Importance

Changes

Metric	Value
wmc	16
lcom	3
cbo	4
dl	11
loc	186
rs	10
c	0
b	0
f	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	setData()	0	17	1
A	defaultWidgetData()	0	9	1
A	widgetId()	0	8	2
A	setWidgetId()	0	6	1
A	description()	0	4	1
A	notes()	0	4	1
A	setShowNotes()	0	7	1
A	showNotesAbove()	0	4	2
A	setDependencies()	0	16	3
A	setWidgetFactory()	0	6	1
A	widgetFactory()	11	11	2

How to fix Duplicated Code

<?php

namespace Charcoal\Admin\Widget\FormGroup;

use RuntimeException;

// From 'charcoal-admin'
use Charcoal\Admin\Ui\NestedWidgetContainerInterface;
use Charcoal\Admin\Ui\NestedWidgetContainerTrait;
use Charcoal\Admin\Ui\ObjectContainerInterface;
use Charcoal\Admin\Ui\ObjectContainerTrait;

// From 'charcoal-ui'
use Charcoal\Ui\FormGroup\AbstractFormGroup;

// From 'charcoal-config'
use Charcoal\Config\ConfigurableInterface;

// from 'charcoal-factory'
use Charcoal\Factory\FactoryInterface;

// from 'charcoal-translator'
use Charcoal\Translator\Translation;

// From 'pimple'
use Pimple\Container;

// from 'charcoal-attachment'
use Charcoal\Attachment\Traits\ConfigurableAttachmentsTrait;

/**
 * Attachment widget, as form group.
 */
class AttachmentFormGroup extends AbstractFormGroup implements

    ConfigurableInterface,
    NestedWidgetContainerInterface,
    ObjectContainerInterface
{
    use ConfigurableAttachmentsTrait;
    use NestedWidgetContainerTrait;
    use ObjectContainerTrait {
        ObjectContainerTrait::createOrLoadObj as createOrCloneOrLoadObj;
    }

    /**
     * @var string
     */
    private $widgetId;

    /**
     * Store the widget factory instance for the current class.
     *
     * @var FactoryInterface
     */
    private $widgetFactory;

    /**
     * Whether notes should be display before or after the form fields.
     *
     * @var boolean
     */
    private $showNotesAbove = false;

    /**
     * Set the widget's data.
     *
     * @param array $data The widget data.
     * @return self
     */
    public function setData(array $data)
    {
        /**
         * @todo Kinda hacky, but works with the concept of form.
         *     Should work embeded in a form group or in a dashboard.
         */
        $data = array_merge($_GET, $data);

        parent::setData($data);

        /** Merge any available presets */
        $data = $this->mergePresets($data);

        parent::setData($data);

        return $this;
    }

    /**
     * Retrieve the default nested widget options.
     *
     * @return array
     */
    public function defaultWidgetData()
    {
        return [
            'type'     => 'charcoal/admin/widget/attachment',
            'preset'   => $this['preset'],
            'objId'    => $this->objId(),
            'objType'  => $this->objType()
        ];
    }

    /**
     * Retrieve the widget's ID.
     *
     * @return string
     */
    public function widgetId()
    {
        if (!$this->widgetId) {
            $this->widgetId = 'attachment_widget_'.uniqid();
        }

        return $this->widgetId;
    }

    /**
     * Set the widget's ID.
     *
     * @param string $widgetId The widget identifier.
     * @return self
     */
    public function setWidgetId($widgetId)
    {
        $this->widgetId = $widgetId;

        return $this;
    }

    /**
     * @return Translation|string|null
     */
    public function description()
    {
        return $this->renderTemplate((string)parent::description());
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());
}
    }

    /**
     * @return Translation|string|null
     */
    public function notes()
    {
        return $this->renderTemplate((string)parent::notes());
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());
}
    }

    /**
     * Show/hide the widget's notes.
     *
     * @param boolean|string $show Whether to show or hide notes.
     * @return self Chainable
     */
    public function setShowNotes($show)
    {
        $this->showNotesAbove = ($show === 'above');
        parent::setShowNotes($show);

        return $this;
    }

    /**
     * @return boolean
     */
    public function showNotesAbove()
    {
        return $this->showNotesAbove && $this->showNotes();
    }

    /**
     * @param Container $container The DI container.
     * @return void
     */
    protected function setDependencies(Container $container)
    {
        parent::setDependencies($container);

        $this->setWidgetFactory($container['widget/factory']);
        $this->setModelFactory($container['model/factory']);

        if (isset($container['attachments/config'])) {
            $this->setConfig($container['attachments/config']);
        } else if (isset($container['config']['attachments'])) {
            $this->setConfig($container['config']['attachments']);
        }

        // Satisfies Charcoal\View\ViewableInterface dependencies
        $this->setView($container['view']);
    }

    /**
     * Set the widget factory.
     *
     * @param FactoryInterface $factory The factory to create widgets.
     * @return self
     */
    protected function setWidgetFactory(FactoryInterface $factory)
    {
        $this->widgetFactory = $factory;

        return $this;
    }

    /**
     * Retrieve the widget factory.
     *
     * @return FactoryInterface
     * @throws RuntimeException If the widget factory was not previously set.
     */
    protected function widgetFactory()

    {
        if ($this->widgetFactory === null) {
            throw new RuntimeException(sprintf(
                'Widget Factory is not defined for "%s"',
                get_class($this)
            ));
        }

        return $this->widgetFactory;
    }
}


1		<?php
2
3		namespace Charcoal\Admin\Widget\FormGroup;
4
5		use RuntimeException;
6
7		// From 'charcoal-admin'
8		use Charcoal\Admin\Ui\NestedWidgetContainerInterface;
9		use Charcoal\Admin\Ui\NestedWidgetContainerTrait;
10		use Charcoal\Admin\Ui\ObjectContainerInterface;
11		use Charcoal\Admin\Ui\ObjectContainerTrait;
12
13		// From 'charcoal-ui'
14		use Charcoal\Ui\FormGroup\AbstractFormGroup;
15
16		// From 'charcoal-config'
17		use Charcoal\Config\ConfigurableInterface;
18
19		// from 'charcoal-factory'
20		use Charcoal\Factory\FactoryInterface;
21
22		// from 'charcoal-translator'
23		use Charcoal\Translator\Translation;
24
25		// From 'pimple'
26		use Pimple\Container;
27
28		// from 'charcoal-attachment'
29		use Charcoal\Attachment\Traits\ConfigurableAttachmentsTrait;
30
31		/**
32		* Attachment widget, as form group.
33		*/
34		class AttachmentFormGroup extends AbstractFormGroup implements
		0 ignored issues – show Bug introduced 2020-04-27 19:28 UTC by Report Bug Copy Issue Report There is at least one abstract method in this class. Maybe declare it as abstract, or implement the remaining methods: hasPermissions, isAuthorized Loading history...
35		ConfigurableInterface,
36		NestedWidgetContainerInterface,
37		ObjectContainerInterface
38		{
39		use ConfigurableAttachmentsTrait;
40		use NestedWidgetContainerTrait;
41		use ObjectContainerTrait {
42		ObjectContainerTrait::createOrLoadObj as createOrCloneOrLoadObj;
43		}
44
45		/**
46		* @var string
47		*/
48		private $widgetId;
49
50		/**
51		* Store the widget factory instance for the current class.
52		*
53		* @var FactoryInterface
54		*/
55		private $widgetFactory;
56
57		/**
58		* Whether notes should be display before or after the form fields.
59		*
60		* @var boolean
61		*/
62		private $showNotesAbove = false;
63
64		/**
65		* Set the widget's data.
66		*
67		* @param array $data The widget data.
68		* @return self
69		*/
70		public function setData(array $data)
71		{
72		/**
73		* @todo Kinda hacky, but works with the concept of form.
74		* Should work embeded in a form group or in a dashboard.
75		*/
76		$data = array_merge($_GET, $data);
77
78		parent::setData($data);
79
80		/** Merge any available presets */
81		$data = $this->mergePresets($data);
82
83		parent::setData($data);
84
85		return $this;
86		}
87
88		/**
89		* Retrieve the default nested widget options.
90		*
91		* @return array
92		*/
93		public function defaultWidgetData()
94		{
95		return [
96		'type' => 'charcoal/admin/widget/attachment',
97		'preset' => $this['preset'],
98		'objId' => $this->objId(),
99		'objType' => $this->objType()
100		];
101		}
102
103		/**
104		* Retrieve the widget's ID.
105		*
106		* @return string
107		*/
108		public function widgetId()
109		{
110		if (!$this->widgetId) {
111		$this->widgetId = 'attachment_widget_'.uniqid();
112		}
113
114		return $this->widgetId;
115		}
116
117		/**
118		* Set the widget's ID.
119		*
120		* @param string $widgetId The widget identifier.
121		* @return self
122		*/
123		public function setWidgetId($widgetId)
124		{
125		$this->widgetId = $widgetId;
126
127		return $this;
128		}
129
130		/**
131		* @return Translation\|string\|null
132		*/
133		public function description()
134		{
135		return $this->renderTemplate((string)parent::description());
		0 ignored issues – show Bug Best Practice introduced 2020-04-27 19:28 UTC by Report Bug Copy Issue Report The return type of `return $this->renderTemp...parent::description());` (`string`) is incompatible with the return type declared by the interface `Charcoal\Ui\UiItemInterface::description` of type `Charcoal\Translator\Translation\|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...
136		}
137
138		/**
139		* @return Translation\|string\|null
140		*/
141		public function notes()
142		{
143		return $this->renderTemplate((string)parent::notes());
		0 ignored issues – show Bug Best Practice introduced 2020-04-27 19:28 UTC by Report Bug Copy Issue Report The return type of `return $this->renderTemp...ring) parent::notes());` (`string`) is incompatible with the return type declared by the interface `Charcoal\Ui\UiItemInterface::notes` of type `Charcoal\Translator\Translation\|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...
144		}
145
146		/**
147		* Show/hide the widget's notes.
148		*
149		* @param boolean\|string $show Whether to show or hide notes.
150		* @return self Chainable
151		*/
152		public function setShowNotes($show)
153		{
154		$this->showNotesAbove = ($show === 'above');
155		parent::setShowNotes($show);
156
157		return $this;
158		}
159
160		/**
161		* @return boolean
162		*/
163		public function showNotesAbove()
164		{
165		return $this->showNotesAbove && $this->showNotes();
166		}
167
168		/**
169		* @param Container $container The DI container.
170		* @return void
171		*/
172		protected function setDependencies(Container $container)
173		{
174		parent::setDependencies($container);
175
176		$this->setWidgetFactory($container['widget/factory']);
177		$this->setModelFactory($container['model/factory']);
178
179		if (isset($container['attachments/config'])) {
180		$this->setConfig($container['attachments/config']);
181		} else if (isset($container['config']['attachments'])) {
182		$this->setConfig($container['config']['attachments']);
183		}
184
185		// Satisfies Charcoal\View\ViewableInterface dependencies
186		$this->setView($container['view']);
187		}
188
189		/**
190		* Set the widget factory.
191		*
192		* @param FactoryInterface $factory The factory to create widgets.
193		* @return self
194		*/
195		protected function setWidgetFactory(FactoryInterface $factory)
196		{
197		$this->widgetFactory = $factory;
198
199		return $this;
200		}
201
202		/**
203		* Retrieve the widget factory.
204		*
205		* @return FactoryInterface
206		* @throws RuntimeException If the widget factory was not previously set.
207		*/
208	View Code Duplication	protected function widgetFactory()
		0 ignored issues – show Duplication introduced 2020-04-27 19:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
209		{
210		if ($this->widgetFactory === null) {
211		throw new RuntimeException(sprintf(
212		'Widget Factory is not defined for "%s"',
213		get_class($this)
214		));
215		}
216
217		return $this->widgetFactory;
218		}
219		}
220

locomotivemtl / charcoal-attachment

Pull Request — master (#4)

AttachmentFormGroup A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

11 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like