Notifier::displayNotifications() - Code Metrics - bradcornford/Notifier - Measure and Improve Code Quality continuously with Scrutinizer

Notifier::displayNotifications() A
last analyzed 2017-06-05 10:18 UTC

↳ Parent: Notifier

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php namespace Cornford\Notifier;

use Cornford\Notifier\Contracts\NotifierInterface;
use DateTime;

class Notifier extends NotifierAbstract implements NotifierInterface {

	/**
	 * Get display notification messages.
	 *
	 * @return array
	 */
	public function getDisplayNotifications()
	{
		$notifications = [];

		foreach ($this->getNotifications() as $notification) {
			if (!$notification->isDisplayed() ||
				($notification->isDisplayed() && !$notification->isExpired()) ||
				($notification->isDisplayed() && !$notification->getExpiry() instanceof DateTime && $notification->getExpiry() == 0)
			) {
				$notifications[] = $notification;
			}
		}

		return $notifications;
	}

	/**
	 *  Update displayed status for passed notification messages.
	 *
	 * @param array $notifications
	 *
	 * @return self
	 */
	public function displayNotifications(array $notifications = [])
	{
		foreach ($notifications as $notification) {
			$notification->setDisplayed(true);
		}

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

	/**
	 *  Update displayed status for displayable notification messages.
	 *
	 * @return self
	 */
	public function displayedDisplayableNotifications()
	{
		foreach ($this->getDisplayNotifications() as $notification) {
			$notification->setDisplayed(true);
		}

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

	/**
	 *  Update displayed status for all notification messages.
	 *
	 * @return self
	 */
	public function displayedAllNotifications()
	{
		foreach ($this->getNotifications() as $notification) {
			$notification->setDisplayed(true);
		}

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

	/**
	 * Expire passed notification messages.
	 *
	 * @param array $notifications
	 *
	 * @return self
	 */
	public function expireNotifications(array $notifications = [])
	{
		foreach ($notifications as $key => $notification) {
			unset(self::$notifications[$key]);
		}

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

	/**
	 * Expire displayed notification messages.
	 *
	 * @return self
	 */
	public function expireDisplayedNotifications()
	{
		foreach ($this->getNotifications() as $key => $notification) {

			if ($notification->isExpired() && $notification->isDisplayed()) {
				unset(self::$notifications[$key]);
			}
		}

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

	/**
	 *  Expire all notification messages.
	 *
	 * @return self
	 */
	public function expireAllNotifications()
	{
		$this->setNotifications([]);

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

	/**
	 * Fetch notifications from Session.
	 *
	 * @param array $notifications
	 *
	 * @return self
	 */
	public function fetchNotifications(array $notifications = [])

	{
		if (empty($notifications)) {
			$notifications = $this->session->get('notifier.notifications', []);
		}

		foreach ($notifications as $notification) {
			if ($notification->getId() > self::$notificationId) {
				self::$notificationId = $notification->getId();
			}
		}

		$this->setNotifications($notifications);

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

	/**
	 * Store notifications in Session.
	 *
	 * @param array $notifications
	 *
	 * @return self
	 */
	public function storeNotifications(array $notifications = [])

	{
		if (empty($notifications)) {
			$notifications = $this->getNotifications();
		}

		foreach ($notifications as $notification) {
			if ($notification->getId() > self::$notificationId) {
				self::$notificationId = $notification->getId();
			}
		}

		$this->session->put('notifier.notifications', $notifications);

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

	/**
	 * Convert an array of Notification objects to an array of arrays.
	 *
	 * @param array $notifications
	 *
	 * @return array
	 */
	public function toArray(array $notifications = [])
	{
		$result = [];

		foreach ($notifications as $notification) {
			$result[] = $notification->__toArray();
		}

		return $result;
	}

}

1		<?php namespace Cornford\Notifier;
2
3		use Cornford\Notifier\Contracts\NotifierInterface;
4		use DateTime;
5
6		class Notifier extends NotifierAbstract implements NotifierInterface {
7
8		/**
9		* Get display notification messages.
10		*
11		* @return array
12		*/
13		public function getDisplayNotifications()
14		{
15		$notifications = [];
16
17		foreach ($this->getNotifications() as $notification) {
18		if (!$notification->isDisplayed() \|\|
19		($notification->isDisplayed() && !$notification->isExpired()) \|\|
20		($notification->isDisplayed() && !$notification->getExpiry() instanceof DateTime && $notification->getExpiry() == 0)
21		) {
22		$notifications[] = $notification;
23		}
24		}
25
26		return $notifications;
27		}
28
29		/**
30		* Update displayed status for passed notification messages.
31		*
32		* @param array $notifications
33		*
34		* @return self
35		*/
36		public function displayNotifications(array $notifications = [])
37		{
38		foreach ($notifications as $notification) {
39		$notification->setDisplayed(true);
40		}
41
42		return $this;
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 16:28 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Cornford\Notifier\Notifier`) is incompatible with the return type declared by the interface `Cornford\Notifier\Contra...e::displayNotifications` of type `Cornford\Notifier\Contracts\Notifier`. 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...
43		}
44
45		/**
46		* Update displayed status for displayable notification messages.
47		*
48		* @return self
49		*/
50		public function displayedDisplayableNotifications()
51		{
52		foreach ($this->getDisplayNotifications() as $notification) {
53		$notification->setDisplayed(true);
54		}
55
56		return $this;
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 16:28 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Cornford\Notifier\Notifier`) is incompatible with the return type declared by the interface `Cornford\Notifier\Contra...isplayableNotifications` of type `Cornford\Notifier\Contracts\Notifier`. 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...
57		}
58
59		/**
60		* Update displayed status for all notification messages.
61		*
62		* @return self
63		*/
64		public function displayedAllNotifications()
65		{
66		foreach ($this->getNotifications() as $notification) {
67		$notification->setDisplayed(true);
68		}
69
70		return $this;
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 16:28 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Cornford\Notifier\Notifier`) is incompatible with the return type declared by the interface `Cornford\Notifier\Contra...splayedAllNotifications` of type `Cornford\Notifier\Contracts\Notifier`. 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...
71		}
72
73		/**
74		* Expire passed notification messages.
75		*
76		* @param array $notifications
77		*
78		* @return self
79		*/
80		public function expireNotifications(array $notifications = [])
81		{
82		foreach ($notifications as $key => $notification) {
83		unset(self::$notifications[$key]);
84		}
85
86		return $this;
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 16:28 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Cornford\Notifier\Notifier`) is incompatible with the return type declared by the interface `Cornford\Notifier\Contra...ce::expireNotifications` of type `Cornford\Notifier\Contracts\Notifier`. 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...
87		}
88
89		/**
90		* Expire displayed notification messages.
91		*
92		* @return self
93		*/
94		public function expireDisplayedNotifications()
95		{
96		foreach ($this->getNotifications() as $key => $notification) {
97
98		if ($notification->isExpired() && $notification->isDisplayed()) {
99		unset(self::$notifications[$key]);
100		}
101		}
102
103		return $this;
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 16:28 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Cornford\Notifier\Notifier`) is incompatible with the return type declared by the interface `Cornford\Notifier\Contra...eDisplayedNotifications` of type `Cornford\Notifier\Contracts\Notifier`. 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...
104		}
105
106		/**
107		* Expire all notification messages.
108		*
109		* @return self
110		*/
111		public function expireAllNotifications()
112		{
113		$this->setNotifications([]);
114
115		return $this;
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 16:28 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Cornford\Notifier\Notifier`) is incompatible with the return type declared by the interface `Cornford\Notifier\Contra...:expireAllNotifications` of type `Cornford\Notifier\Contracts\Notifier`. 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...
116		}
117
118		/**
119		* Fetch notifications from Session.
120		*
121		* @param array $notifications
122		*
123		* @return self
124		*/
125	View Code Duplication	public function fetchNotifications(array $notifications = [])
		0 ignored issues – show Duplication introduced 2016-01-12 14:31 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...
126		{
127		if (empty($notifications)) {
128		$notifications = $this->session->get('notifier.notifications', []);
129		}
130
131		foreach ($notifications as $notification) {
132		if ($notification->getId() > self::$notificationId) {
133		self::$notificationId = $notification->getId();
134		}
135		}
136
137		$this->setNotifications($notifications);
138
139		return $this;
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 16:28 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Cornford\Notifier\Notifier`) is incompatible with the return type declared by the interface `Cornford\Notifier\Contra...ace::fetchNotifications` of type `Cornford\Notifier\Contracts\Notifier`. 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...
140		}
141
142		/**
143		* Store notifications in Session.
144		*
145		* @param array $notifications
146		*
147		* @return self
148		*/
149	View Code Duplication	public function storeNotifications(array $notifications = [])
		0 ignored issues – show Duplication introduced 2016-01-12 14:31 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...
150		{
151		if (empty($notifications)) {
152		$notifications = $this->getNotifications();
153		}
154
155		foreach ($notifications as $notification) {
156		if ($notification->getId() > self::$notificationId) {
157		self::$notificationId = $notification->getId();
158		}
159		}
160
161		$this->session->put('notifier.notifications', $notifications);
162
163		return $this;
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 16:28 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Cornford\Notifier\Notifier`) is incompatible with the return type declared by the interface `Cornford\Notifier\Contra...ace::storeNotifications` of type `Cornford\Notifier\Contracts\Notifier`. 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...
164		}
165
166		/**
167		* Convert an array of Notification objects to an array of arrays.
168		*
169		* @param array $notifications
170		*
171		* @return array
172		*/
173		public function toArray(array $notifications = [])
174		{
175		$result = [];
176
177		foreach ($notifications as $notification) {
178		$result[] = $notification->__toArray();
179		}
180
181		return $result;
182		}
183
184		}

bradcornford / Notifier

Notifier::displayNotifications() A last analyzed 2017-06-05 10:18 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Notifier::displayNotifications() A
last analyzed 2017-06-05 10:18 UTC