Jnjxp\Molniya\Messenger\MessengerTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
	addMessage()	0	1	?
A	exist()	0	4	1
A	add()	0	9	1
A	success()	0	4	1
A	danger()	0	4	1
A	warning()	0	4	1
A	info()	0	4	1

<?php
/**
 * Molniya Messenger
 *
 * PHP version 5
 *
 * Copyright (C) 2017 Jake Johns
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 *
 * @category  Trait
 * @package   Jnjxp\Molniya
 * @author    Jake Johns <jake@jakejohns.net>
 * @copyright 2017 Jake Johns
 * @license   http://jnj.mit-license.org/2017 MIT License
 * @link      https://github.com/jnjxp/jnjxp.molniya
 */

namespace Jnjxp\Molniya\Messenger;

/**
 * Messenger
 *
 * @category Messenger
 * @package  Jnjxp\Molniya
 * @author   Jake Johns <jake@jakejohns.net>
 * @license  https://jnj.mit-license.org/ MIT License
 * @link     https://github.com/jnjxp/jnjxp.molniya
 */
trait MessengerTrait
{

    protected $message = Message\Message::class;

    /**
     * Add a message
     *
     * @param string $message DESCRIPTION
     *
     * @return void
     *
     * @access public
     */
    abstract public function addMessage(Message\MessageInterface $message) : void;


    /**
     * Has
     *
     * @return bool
     *
     * @access public
     */
    public function exist() : bool
    {
        return count($this) > 0;
    }

    /**
     * Add a message
     *
     * @param string $message DESCRIPTION
     * @param string $context DESCRIPTION
     *
     * @return Message\MessageInterface
     *
     * @access public
     */
    public function add(
        string $message,
        string $context = Message\Context::INFO
    ) : Message\MessageInterface {
        $class   = $this->message;
        $message = new $class($message, $context);
        $this->addMessage($message);
        return $message;
    }

    /**
     * Add as message with context success
     *
     * @param string $message message to add
     *
     * @return Message\MessageInterface
     *
     * @access public
     */
    public function success(string $message) : Message\MessageInterface
    {
        $this->add($message, Message\Context::SUCCSS);
    }

    /**
     * Add as message with context danger
     *
     * @param string $message message to add
     *
     * @return Message\MessageInterface
     *
     * @access public
     */
    public function danger(string $message) : Message\MessageInterface
    {
        $this->add($message, Message\Context::DANGER);
    }

    /**
     * Add as message with context warning
     *
     * @param string $message message to add
     *
     * @return Message\MessageInterface
     *
     * @access public
     */
    public function warning(string $message) : Message\MessageInterface
    {
        $this->add($message, Message\Context::WARNING);
    }

    /**
     * Add as message with context info
     *
     * @param string $message message to add
     *
     * @return Message\MessageInterface
     *
     * @access public
     */
    public function info(string $message) : Message\MessageInterface
    {
        $this->add($message, Message\Context::INFO);
    }
}