Messages::createEmptyMessagesStore() - Code Metrics - Inspection of "Create `Http\StatusCode` class" - bluzphp/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#381)

by Anton

created 2016-12-13 14:51 UTC

Messages::createEmptyMessagesStore() A

↳ Parent: Messages

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1.064

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	0
dl	0
loc	10
ccs	3
cts	5
cp	0.6
crap	1.064
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Bluz Framework Component
 *
 * @copyright Bluz PHP Team
 * @link https://github.com/bluzphp/framework
 */

/**
 * @namespace
 */
namespace Bluz\Messages;

use Bluz\Common\Options;
use Bluz\Proxy\Session;
use Bluz\Proxy\Translator;

/**
 * Realization of Flash Messages
 *
 * @package  Bluz\Messages
 * @author   Anton Shevchuk
 * @link     https://github.com/bluzphp/framework/wiki/Messages
 */
class Messages
{
    use Options;

    const TYPE_ERROR = 'error';
    const TYPE_SUCCESS = 'success';
    const TYPE_NOTICE = 'notice';

    /**
     * @var array list of messages types
     */
    protected $types = [
        self::TYPE_ERROR,
        self::TYPE_SUCCESS,
        self::TYPE_NOTICE
    ];

    /**
     * Initialize Messages container
     *
     * @return Messages
     */
    protected function init()
    {
        if (!$this->getMessagesStore()) {
            $this->reset();
        }
        return $this;
    }

    /**
     * Add notice
     *
     * @param  string   $message
     * @param  string[] $text
     * @return void
     * @since  1.0.0 added $text
     */
    public function addNotice($message, ...$text)
    {
        $this->add(self::TYPE_NOTICE, $message, ...$text);
    }

    /**
     * Add success
     *
     * @param  string   $message
     * @param  string[] $text
     * @return void
     * @since  1.0.0 added $text
     */
    public function addSuccess($message, ...$text)
    {
        $this->add(self::TYPE_SUCCESS, $message, ...$text);
    }

    /**
     * Add error
     *
     * @param  string   $message
     * @param  string[] $text
     * @return void
     * @since  1.0.0 added $text
     */
    public function addError($message, ...$text)
    {
        $this->add(self::TYPE_ERROR, $message, ...$text);
    }

    /**
     * Add message to container
     *
     * @param  string   $type One of error, notice or success
     * @param  string   $message
     * @param  string[] $text
     * @return void
     */
    protected function add($type, $message, ...$text)
    {
        $this->init();
        $this->getMessagesStore()[$type][] = Translator::translate($message, ...$text);
    }

    /**
     * Pop a message
     *
     * @param  string $type
     * @return \stdClass|null
     */
    public function pop($type = null)
    {
        if (!$this->getMessagesStore()) {
            return null;
        }

        if ($type !== null) {
            $text = array_shift($this->getMessagesStore()[$type]);
            if ($text) {
                $message = new \stdClass();
                $message->text = $text;
                $message->type = $type;
                return $message;
            }
        } else {
            foreach ($this->types as $type) {
                if ($message = $this->pop($type)) {
                    return $message;
                }
            }
        }
        return null;
    }

    /**
     * Pop all messages
     *
     * @return \ArrayObject
     */
    public function popAll()
    {
        if (!$this->getMessagesStore()) {
            return $this->createEmptyMessagesStore();
        }

        $messages = $this->getMessagesStore()->getArrayCopy();
        $this->reset();
        return $messages;
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());
}
    }

    /**
     * Get size of messages container
     *
     * @return integer
     */
    public function count()
    {
        $size = 0;
        if (!$store = $this->getMessagesStore()) {
            return $size;
        }
        foreach ($store as $messages) {
            $size += sizeof($messages);
        }
        return $size;
    }

    /**
     * Reset messages
     *
     * @return void
     */
    public function reset()
    {
        Session::set('messages:store', $this->createEmptyMessagesStore());
    }

    /**
     * Returns current messages store
     *
     * @return \ArrayObject|null Returns null if store not exists yet
     */
    protected function getMessagesStore()
    {
        return Session::get('messages:store');
    }

    /**
     * Creates a new empty store for messages
     *
     * @return \ArrayObject
     */
    protected function createEmptyMessagesStore()
    {
        return new \ArrayObject(
            [
                self::TYPE_ERROR => [],
                self::TYPE_SUCCESS => [],
                self::TYPE_NOTICE => []
            ]
        );
    }
}


1		<?php
2		/**
3		* Bluz Framework Component
4		*
5		* @copyright Bluz PHP Team
6		* @link https://github.com/bluzphp/framework
7		*/
8
9		/**
10		* @namespace
11		*/
12		namespace Bluz\Messages;
13
14		use Bluz\Common\Options;
15		use Bluz\Proxy\Session;
16		use Bluz\Proxy\Translator;
17
18		/**
19		* Realization of Flash Messages
20		*
21		* @package Bluz\Messages
22		* @author Anton Shevchuk
23		* @link https://github.com/bluzphp/framework/wiki/Messages
24		*/
25		class Messages
26		{
27		use Options;
28
29		const TYPE_ERROR = 'error';
30		const TYPE_SUCCESS = 'success';
31		const TYPE_NOTICE = 'notice';
32
33		/**
34		* @var array list of messages types
35		*/
36		protected $types = [
37		self::TYPE_ERROR,
38		self::TYPE_SUCCESS,
39		self::TYPE_NOTICE
40		];
41
42		/**
43		* Initialize Messages container
44		*
45		* @return Messages
46		*/
47	4	protected function init()
48		{
49	4	if (!$this->getMessagesStore()) {
50	1	$this->reset();
51		}
52	4	return $this;
53		}
54
55		/**
56		* Add notice
57		*
58		* @param string $message
59		* @param string[] $text
60		* @return void
61		* @since 1.0.0 added $text
62		*/
63	4	public function addNotice($message, ...$text)
64		{
65	4	$this->add(self::TYPE_NOTICE, $message, ...$text);
66	4	}
67
68		/**
69		* Add success
70		*
71		* @param string $message
72		* @param string[] $text
73		* @return void
74		* @since 1.0.0 added $text
75		*/
76	4	public function addSuccess($message, ...$text)
77		{
78	4	$this->add(self::TYPE_SUCCESS, $message, ...$text);
79	4	}
80
81		/**
82		* Add error
83		*
84		* @param string $message
85		* @param string[] $text
86		* @return void
87		* @since 1.0.0 added $text
88		*/
89	4	public function addError($message, ...$text)
90		{
91	4	$this->add(self::TYPE_ERROR, $message, ...$text);
92	4	}
93
94		/**
95		* Add message to container
96		*
97		* @param string $type One of error, notice or success
98		* @param string $message
99		* @param string[] $text
100		* @return void
101		*/
102	4	protected function add($type, $message, ...$text)
103		{
104	4	$this->init();
105	4	$this->getMessagesStore()[$type][] = Translator::translate($message, ...$text);
106	4	}
107
108		/**
109		* Pop a message
110		*
111		* @param string $type
112		* @return \stdClass\|null
113		*/
114	4	public function pop($type = null)
115		{
116	4	if (!$this->getMessagesStore()) {
117		return null;
118		}
119
120	4	if ($type !== null) {
121	4	$text = array_shift($this->getMessagesStore()[$type]);
122	4	if ($text) {
123	3	$message = new \stdClass();
124	3	$message->text = $text;
125	3	$message->type = $type;
126	4	return $message;
127		}
128		} else {
129	1	foreach ($this->types as $type) {
130	1	if ($message = $this->pop($type)) {
131	1	return $message;
132		}
133		}
134		}
135	2	return null;
136		}
137
138		/**
139		* Pop all messages
140		*
141		* @return \ArrayObject
142		*/
143	630	public function popAll()
144		{
145	630	if (!$this->getMessagesStore()) {
146	108	return $this->createEmptyMessagesStore();
147		}
148
149	522	$messages = $this->getMessagesStore()->getArrayCopy();
150	522	$this->reset();
151	522	return $messages;
		0 ignored issues – show Bug Best Practice introduced 2016-12-13 14:59 UTC by Report Bug Copy Issue Report The return type of `return $messages;` (`array`) is incompatible with the return type documented by `Bluz\Messages\Messages::popAll` of type `ArrayObject`. 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...
152		}
153
154		/**
155		* Get size of messages container
156		*
157		* @return integer
158		*/
159	2	public function count()
160		{
161	2	$size = 0;
162	2	if (!$store = $this->getMessagesStore()) {
163		return $size;
164		}
165	2	foreach ($store as $messages) {
166	2	$size += sizeof($messages);
167		}
168	2	return $size;
169		}
170
171		/**
172		* Reset messages
173		*
174		* @return void
175		*/
176	522	public function reset()
177		{
178	522	Session::set('messages:store', $this->createEmptyMessagesStore());
179	522	}
180
181		/**
182		* Returns current messages store
183		*
184		* @return \ArrayObject\|null Returns null if store not exists yet
185		*/
186	630	protected function getMessagesStore()
187		{
188	630	return Session::get('messages:store');
189		}
190
191		/**
192		* Creates a new empty store for messages
193		*
194		* @return \ArrayObject
195		*/
196	630	protected function createEmptyMessagesStore()
197		{
198	630	return new \ArrayObject(
199		[
200	630	self::TYPE_ERROR => [],
201		self::TYPE_SUCCESS => [],
202		self::TYPE_NOTICE => []
203		]
204		);
205		}
206		}
207

bluzphp / framework

Pull Request — master (#381)

Messages::createEmptyMessagesStore() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like