EventEspresso\core\services\notices\NoticesContainer

Complexity

Total Complexity

16

Size/Duplication

Total Lines	233
Duplicated Lines	9.44 %

Coupling/Cohesion

Components	4
Dependencies	1

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	addInformation()	0	11	1
A	addAttention()	11	11	1
A	addError()	0	11	1
A	addSuccess()	11	11	1
A	hasInformation()	0	4	1
A	hasAttention()	0	4	1
A	hasError()	0	4	1
A	hasSuccess()	0	4	1
A	countInformation()	0	4	1
A	countAttention()	0	4	1
A	countError()	0	4	1
A	countSuccess()	0	4	1
A	getInformation()	0	4	1
A	getAttention()	0	4	1
A	getError()	0	4	1
A	getSuccess()	0	4	1

<?php

namespace EventEspresso\core\services\notices;

use EventEspresso\core\exceptions\InvalidDataTypeException;

defined('EVENT_ESPRESSO_VERSION') || exit;



/**
 * Class NoticesContainer
 * Container for holding multiple Notice objects until they can be processed
 *
 * @package       Event Espresso
 * @author        Brent Christensen
 * @since         $VID:$
 */
class NoticesContainer implements NoticesContainerInterface
{


    /**
     * @var NoticeInterface[] $information
     */
    private $information = array();


    /**
     * @var NoticeInterface[] $attention
     */
    private $attention = array();


    /**
     * @var NoticeInterface[] $error
     */
    private $error = array();


    /**
     * @var NoticeInterface[] $success
     */
    private $success = array();


    /**
     * @param string $notice
     * @param bool   $dismissible
     * @param string $file
     * @param string $func
     * @param string $line
     * @throws InvalidDataTypeException
     */
    public function addInformation($notice, $dismissible = true, $file = '', $func = '', $line = '')
    {
        $this->information[] = new Notice(
            Notice::INFORMATION,
            $notice,
            $dismissible,
            $file,
            $func,
            $line
        );
    }



    /**
     * @param string $notice
     * @param bool   $dismissible
     * @param string $file
     * @param string $func
     * @param string $line
     * @throws InvalidDataTypeException
     */
    public function addAttention($notice, $dismissible = true, $file = '', $func = '', $line = '')
    {
        $this->attention[] = new Notice(
            Notice::ATTENTION,
            $notice,
            $dismissible,
            $file,
            $func,
            $line
        );
    }



    /**
     * @param string $notice
     * @param bool   $dismissible
     * @param string $file
     * @param string $func
     * @param string $line
     * @throws InvalidDataTypeException
     */
    public function addError($notice, $dismissible = true, $file, $func, $line)
    {
        $this->error[] = new Notice(
            Notice::ERROR,
            $notice,
            $dismissible,
            $file,
            $func,
            $line
        );
    }



    /**
     * @param string $notice
     * @param bool   $dismissible
     * @param string $file
     * @param string $func
     * @param string $line
     * @throws InvalidDataTypeException
     */
    public function addSuccess($notice, $dismissible = true, $file = '', $func = '', $line = '')
    {
        $this->success[] = new Notice(
            Notice::SUCCESS,
            $notice,
            $dismissible,
            $file,
            $func,
            $line
        );
    }


    /**
     * @return boolean
     */
    public function hasInformation()
    {
        return ! empty($this->information);
    }



    /**
     * @return boolean
     */
    public function hasAttention()
    {
        return ! empty($this->attention);
    }



    /**
     * @return boolean
     */
    public function hasError()
    {
        return ! empty($this->error);
    }



    /**
     * @return boolean
     */
    public function hasSuccess()
    {
        return ! empty($this->success);
    }


    /**
     * @return int
     */
    public function countInformation()
    {
        return count($this->information);
    }



    /**
     * @return int
     */
    public function countAttention()
    {
        return count($this->attention);
    }



    /**
     * @return int
     */
    public function countError()
    {
        return count($this->error);
    }



    /**
     * @return int
     */
    public function countSuccess()
    {
        return count($this->success);
    }


    /**
     * @return NoticeInterface[]
     */
    public function getInformation()
    {
        return $this->information;
    }



    /**
     * @return NoticeInterface[]
     */
    public function getAttention()
    {
        return $this->attention;
    }



    /**
     * @return NoticeInterface[]
     */
    public function getError()
    {
        return $this->error;
    }



    /**
     * @return NoticeInterface[]
     */
    public function getSuccess()
    {
        return $this->success;
    }


}