WidgetModel::isPinned() - Code Metrics - anomalylabs/dashboard-module - Measure and Improve Code Quality continuously with Scrutinizer

WidgetModel::isPinned() A
last analyzed 2017-08-18 07:28 UTC

↳ Parent: WidgetModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php namespace Anomaly\DashboardModule\Widget;

use Anomaly\DashboardModule\Widget\Command\GetSortableFlag;
use Anomaly\DashboardModule\Widget\Contract\WidgetInterface;
use Anomaly\DashboardModule\Widget\Extension\Contract\WidgetExtensionInterface;
use Anomaly\Streams\Platform\Model\Dashboard\DashboardWidgetsEntryModel;
use Anomaly\UsersModule\Role\RoleCollection;

/**
 * Class WidgetModel
 *
 * @link          http://pyrocms.com/
 * @author        PyroCMS, Inc. <[email protected]>
 * @author        Ryan Thompson <[email protected]>
 */
class WidgetModel extends DashboardWidgetsEntryModel implements WidgetInterface
{

    /**
     * The widget data.
     *
     * @var WidgetCollection
     */
    protected $data;

    /**
     * Create a new WidgetModel instance.
     *
     * @param array $attributes
     */
    public function __construct(array $attributes = [])
    {
        $this->data = new WidgetCollection();

        parent::__construct($attributes);
    }

    /**
     * Get the pinned flag.
     *
     * @return bool
     */
    public function isPinned()
    {
        return $this->pinned;
    }

    /**
     * Get the column.
     *
     * @return int
     */
    public function getColumn()
    {
        return $this->column;
    }

    /**
     * Get the extension.
     *
     * @return WidgetExtensionInterface
     */
    public function getExtension()
    {
        return $this->extension;
    }

    /**
     * Get the allowed roles.
     *
     * @return RoleCollection
     */
    public function getAllowedRoles()
    {
        return $this->allowedRoles()->get();
    }

    /**
     * Get the content.
     *
     * @return string
     */
    public function getContent()
    {
        return $this->content;
    }

    /**
     * Set the content.
     *
     * @param $content
     * @return $this
     */
    public function setContent($content)
    {
        $this->content = $content;

        return $this;
    }

    /**
     * Get the data.
     *
     * @return WidgetData
     */
    public function getData()
    {
        return $this->data;
    }

    /**
     * Add to the widget data.
     *
     * @param $key
     * @param $data
     * @return $this
     */
    public function addData($key, $data)
    {
        $this->data->put($key, $data);

        return $this;
    }

    /**
     * Return the sortable flag.
     *
     * @return bool
     */
    public function isSortable()
    {
        return $this->dispatch(new GetSortableFlag($this));
    }

    /**
     * Return the widget's context.
     *
     * @return string
     */
    public function context()
    {
        $extension = $this->getExtension();

        return $extension->getContext();
    }

    /**
     * Return the widget output.
     *
     * @return string
     */
    public function output()
    {
        $extension = $this->getExtension();

        return $extension->output($this);
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());
}
    }
}


1			<?php namespace Anomaly\DashboardModule\Widget;
2
3			use Anomaly\DashboardModule\Widget\Command\GetSortableFlag;
4			use Anomaly\DashboardModule\Widget\Contract\WidgetInterface;
5			use Anomaly\DashboardModule\Widget\Extension\Contract\WidgetExtensionInterface;
6			use Anomaly\Streams\Platform\Model\Dashboard\DashboardWidgetsEntryModel;
7			use Anomaly\UsersModule\Role\RoleCollection;
8
9			/**
10			* Class WidgetModel
11			*
12			* @link http://pyrocms.com/
13			* @author PyroCMS, Inc. <[email protected]>
14			* @author Ryan Thompson <[email protected]>
15			*/
16			class WidgetModel extends DashboardWidgetsEntryModel implements WidgetInterface
17			{
18
19			/**
20			* The widget data.
21			*
22			* @var WidgetCollection
23			*/
24			protected $data;
25
26			/**
27			* Create a new WidgetModel instance.
28			*
29			* @param array $attributes
30			*/
31			public function __construct(array $attributes = [])
32			{
33			$this->data = new WidgetCollection();
34
35			parent::__construct($attributes);
36			}
37
38			/**
39			* Get the pinned flag.
40			*
41			* @return bool
42			*/
43			public function isPinned()
44			{
45			return $this->pinned;
46			}
47
48			/**
49			* Get the column.
50			*
51			* @return int
52			*/
53			public function getColumn()
54			{
55			return $this->column;
56			}
57
58			/**
59			* Get the extension.
60			*
61			* @return WidgetExtensionInterface
62			*/
63			public function getExtension()
64			{
65			return $this->extension;
66			}
67
68			/**
69			* Get the allowed roles.
70			*
71			* @return RoleCollection
72			*/
73			public function getAllowedRoles()
74			{
75			return $this->allowedRoles()->get();
76			}
77
78			/**
79			* Get the content.
80			*
81			* @return string
82			*/
83			public function getContent()
84			{
85			return $this->content;
86			}
87
88			/**
89			* Set the content.
90			*
91			* @param $content
92			* @return $this
93			*/
94			public function setContent($content)
95			{
96			$this->content = $content;
97
98			return $this;
99			}
100
101			/**
102			* Get the data.
103			*
104			* @return WidgetData
105			*/
106			public function getData()
107			{
108			return $this->data;
109			}
110
111			/**
112			* Add to the widget data.
113			*
114			* @param $key
115			* @param $data
116			* @return $this
117			*/
118			public function addData($key, $data)
119			{
120			$this->data->put($key, $data);
121
122			return $this;
123			}
124
125			/**
126			* Return the sortable flag.
127			*
128			* @return bool
129			*/
130			public function isSortable()
131			{
132			return $this->dispatch(new GetSortableFlag($this));
133			}
134
135			/**
136			* Return the widget's context.
137			*
138			* @return string
139			*/
140			public function context()
141			{
142			$extension = $this->getExtension();
143
144			return $extension->getContext();
145			}
146
147			/**
148			* Return the widget output.
149			*
150			* @return string
151			*/
152			public function output()
153			{
154			$extension = $this->getExtension();
155
156			return $extension->output($this);
			0 ignored issues – show Bug Best Practice introduced 2015-11-23 08:53 UTC by Report Bug Copy Issue Report The return type of `return $extension->output($this);` (`Illuminate\Contracts\View\View`) is incompatible with the return type declared by the interface `Anomaly\DashboardModule\...WidgetInterface::output` of type `string`. 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...
157			}
158			}
159

anomalylabs / dashboard-module

WidgetModel::isPinned() A last analyzed 2017-08-18 07:28 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WidgetModel::isPinned() A
last analyzed 2017-08-18 07:28 UTC