Messages::addMessage() - Code Metrics - Asymptix/Framework - Measure and Improve Code Quality continuously with Scrutinizer

Messages::addMessage() A
last analyzed 2018-07-31 14:35 UTC

↳ Parent: Messages

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	3
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

namespace Asymptix\core;

/**
 * Messages functionlity.
 *
 * @category Asymptix PHP Framework
 * @author Dmytro Zarezenko <[email protected]>
 * @copyright (c) 2013 - 2016, Dmytro Zarezenko
 *
 * @git https://github.com/Asymptix/Framework
 * @license http://opensource.org/licenses/MIT
 */
class Messages {

    const MSG_EMPTY = 0;
    const MSG_INFO = 1;
    const MSG_SUCCESS = 2;
    const MSG_WARNING = 3;
    const MSG_ERROR = 4;

    /**
     * Messages list.
     *
     * @var array
     */
    private static $messages = [];

    /**
     * Push new message to the global messages list.
     *
     * @param int $type Priority type of the message.
     * @param string $text Text of the message.
     * @param string $code Code of the message in the message list (optional).
     *
     * @throws \Exception If wrong priority message type provided.
     */
    public static function pushMessage($type, $text, $code = null) {
        $oClass = new \ReflectionClass(new Messages);
        $constantsList = $oClass->getConstants();

        if (in_array($type, $constantsList)) {
            if (empty($code)) {
                self::$messages[] = new __MSG($type, $text);
            } else {
                self::$messages[$code] = new __MSG($type, $text);
            }
        } else {
            throw new \Exception("Invalid message type code");
        }
    }

    /**
     * Push new message to the global messages list.
     *
     * @param int $type Priority type of the message.
     * @param string $text Text of the message.
     * @param string $code Code of the message in the message list (optional).
     *
     * @throws \Exception If wrong priority message type provided.
     */
    public static function addMessage($type, $text, $code = null) {
        return self::pushMessage($type, $text, $code);
    }

    /**
     * Returns message by it's code from global messages list.
     *
     * @param string $code Code of the message in the message list.
     *
     * @return __MSG Message object.
     *
     * @throws \Exception If message with such code is not exists.
     */
    public static function getMessage($code) {
        if (isset(self::$messages[$code])) {
            return self::$messages[$code];
        } else {
            throw new \Exception("Invalid message code");
        }
    }

    /**
     * Returns message text (content) silently.
     *
     * @param mixed $code Key of the message.
     *
     * @return string Message text or empty string if message doesn't exist.
     */
    public static function get($code) {
        try {
            $msg = self::getMessage($code);
            if (is_object($msg)) {
                return $msg->text;
            }
        } catch (\Exception $ex) {
            unset($ex);
        }

        return "";
    }

    /**
     * Removes message with some code from global messages list.
     *
     * @param string $code Code of the message in the message list.
     */
    public static function popMessages($code) {
        if (isset(self::$messages[$code])) {
            unset(self::$messages[$code]);
        }
    }

    /**
     * Removes message with some code from global messages list.
     *
     * @param string $code Code of the message in the message list.
     */
    public static function removeMessages($code) {
        return self::popMessages($code);
    }

    /**
     * Sort messages list with most important messages priority but save order if
     * priority the same.
     */
    public static function reorderMessages() {
        uasort(self::$messages, function ($a, $b) {
            return ($a->type <= $b->type);
        });
    }

    /**
     * Sort messages list with most important messages priority but save order if
     * priority the same.
     */
    public static function sortMessages() {
        return self::reorderMessages();
    }

    /**
     * Returns reordered by priority messages list.
     *
     * @return array<_MSG> List with reordered by prioroty messages.
     */
    public static function getMessages() {
        self::reorderMessages();

        return self::$messages;
    }

}

/**
 * Message item helper class.
 */
class __MSG {


    public $type = null;
    public $text = "";

    public function __construct($type, $text) {
        $this->type = $type;
        $this->text = trim($text);
    }

}


1			<?php
2
3			namespace Asymptix\core;
4
5			/**
6			* Messages functionlity.
7			*
8			* @category Asymptix PHP Framework
9			* @author Dmytro Zarezenko <[email protected]>
10			* @copyright (c) 2013 - 2016, Dmytro Zarezenko
11			*
12			* @git https://github.com/Asymptix/Framework
13			* @license http://opensource.org/licenses/MIT
14			*/
15			class Messages {
16
17			const MSG_EMPTY = 0;
18			const MSG_INFO = 1;
19			const MSG_SUCCESS = 2;
20			const MSG_WARNING = 3;
21			const MSG_ERROR = 4;
22
23			/**
24			* Messages list.
25			*
26			* @var array
27			*/
28			private static $messages = [];
29
30			/**
31			* Push new message to the global messages list.
32			*
33			* @param int $type Priority type of the message.
34			* @param string $text Text of the message.
35			* @param string $code Code of the message in the message list (optional).
36			*
37			* @throws \Exception If wrong priority message type provided.
38			*/
39			public static function pushMessage($type, $text, $code = null) {
40			$oClass = new \ReflectionClass(new Messages);
41			$constantsList = $oClass->getConstants();
42
43			if (in_array($type, $constantsList)) {
44			if (empty($code)) {
45			self::$messages[] = new __MSG($type, $text);
46			} else {
47			self::$messages[$code] = new __MSG($type, $text);
48			}
49			} else {
50			throw new \Exception("Invalid message type code");
51			}
52			}
53
54			/**
55			* Push new message to the global messages list.
56			*
57			* @param int $type Priority type of the message.
58			* @param string $text Text of the message.
59			* @param string $code Code of the message in the message list (optional).
60			*
61			* @throws \Exception If wrong priority message type provided.
62			*/
63			public static function addMessage($type, $text, $code = null) {
64			return self::pushMessage($type, $text, $code);
65			}
66
67			/**
68			* Returns message by it's code from global messages list.
69			*
70			* @param string $code Code of the message in the message list.
71			*
72			* @return __MSG Message object.
73			*
74			* @throws \Exception If message with such code is not exists.
75			*/
76			public static function getMessage($code) {
77			if (isset(self::$messages[$code])) {
78			return self::$messages[$code];
79			} else {
80			throw new \Exception("Invalid message code");
81			}
82			}
83
84			/**
85			* Returns message text (content) silently.
86			*
87			* @param mixed $code Key of the message.
88			*
89			* @return string Message text or empty string if message doesn't exist.
90			*/
91			public static function get($code) {
92			try {
93			$msg = self::getMessage($code);
94			if (is_object($msg)) {
95			return $msg->text;
96			}
97			} catch (\Exception $ex) {
98			unset($ex);
99			}
100
101			return "";
102			}
103
104			/**
105			* Removes message with some code from global messages list.
106			*
107			* @param string $code Code of the message in the message list.
108			*/
109			public static function popMessages($code) {
110			if (isset(self::$messages[$code])) {
111			unset(self::$messages[$code]);
112			}
113			}
114
115			/**
116			* Removes message with some code from global messages list.
117			*
118			* @param string $code Code of the message in the message list.
119			*/
120			public static function removeMessages($code) {
121			return self::popMessages($code);
122			}
123
124			/**
125			* Sort messages list with most important messages priority but save order if
126			* priority the same.
127			*/
128			public static function reorderMessages() {
129			uasort(self::$messages, function ($a, $b) {
130			return ($a->type <= $b->type);
131			});
132			}
133
134			/**
135			* Sort messages list with most important messages priority but save order if
136			* priority the same.
137			*/
138			public static function sortMessages() {
139			return self::reorderMessages();
140			}
141
142			/**
143			* Returns reordered by priority messages list.
144			*
145			* @return array<_MSG> List with reordered by prioroty messages.
146			*/
147			public static function getMessages() {
148			self::reorderMessages();
149
150			return self::$messages;
151			}
152
153			}
154
155			/**
156			* Message item helper class.
157			*/
158			class __MSG {
			0 ignored issues – show Coding Style Compatibility introduced 2016-07-26 12:49 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
159
160			public $type = null;
161			public $text = "";
162
163			public function __construct($type, $text) {
164			$this->type = $type;
165			$this->text = trim($text);
166			}
167
168			}
169

Asymptix / Framework

Messages::addMessage() A last analyzed 2018-07-31 14:35 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Messages::addMessage() A
last analyzed 2018-07-31 14:35 UTC