Cornford\Notifier\Models\Notification

Complexity

Total Complexity

31

Size/Duplication

Total Lines	334
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
D	__construct()	0	40	10
A	setId()	0	4	1
A	getId()	0	4	1
A	setMessage()	0	4	1
A	getMessage()	0	4	1
A	setType()	0	4	1
A	getType()	0	4	1
A	setDatetime()	0	4	1
A	getDatetime()	0	4	1
A	setExpiry()	0	4	1
A	getExpiry()	0	4	1
A	getMinutes()	0	16	3
A	isExpired()	0	10	2
A	setDisplayed()	0	4	1
A	getDisplayed()	0	4	1
A	isDisplayed()	0	4	1
A	setOptions()	0	4	1
A	getOptions()	0	4	1
A	__toArray()	0	13	1

<?php namespace Cornford\Notifier\Models;

use Cornford\Notifier\Contracts\NotifierNotificationInterface;
use Cornford\Notifier\Exceptions\NotifierNotificationArgumentException;
use DateInterval;
use DateTime;

class Notification implements NotifierNotificationInterface {

	const NOTIFICATION_TYPE_NONE = 'message';
	const NOTIFICATION_TYPE_INFO = 'info';
	const NOTIFICATION_TYPE_SUCCESS = 'success';
	const NOTIFICATION_TYPE_WARNING = 'warn';
	const NOTIFICATION_TYPE_DANGER = 'error';

	/**
	 * Options.
	 *
	 * @var array
	 */
	protected $options = [];

	/**
	 * Notification id.
	 *
	 * @var integer
	 */
	protected $id;

	/**
	 * Notification message.
	 *
	 * @var string
	 */
	protected $message;

	/**
	 * Notification message type.
	 *
	 * @var string
	 */
	protected $type;

	/**
	 * Notification message date time.
	 *
	 * @var DateTime
	 */
	protected $datetime;

	/**
	 * Notification message expiry in minutes.
	 *
	 * @var DateTime|integer
	 */
	protected $expiry;

	/**
	 * Notification message displayed status.
	 *
	 * @var boolean
	 */
	protected $displayed = false;

	/**
	 * Constructor.
	 *
	 * @param integer          $id
	 * @param string           $message
	 * @param string           $type
	 * @param DateTime         $datetime
	 * @param DateTime|integer $expiry
	 * @param array            $options
	 *
	 * @throws NotifierNotificationArgumentException
	 */
	public function __construct($id, $message, $type, $datetime, $expiry = 0, array $options = [])
	{
		if (empty($id) || !is_numeric($id)) {
			throw new NotifierNotificationArgumentException('Invalid id supplied.');
		}

		if (empty($message) || !is_string($message)) {
			throw new NotifierNotificationArgumentException('Invalid message supplied.');
		}

		if (empty($message) ||
			!in_array(
				$type,
				[
					self::NOTIFICATION_TYPE_NONE,
					self::NOTIFICATION_TYPE_INFO,
					self::NOTIFICATION_TYPE_SUCCESS,
					self::NOTIFICATION_TYPE_WARNING,
					self::NOTIFICATION_TYPE_DANGER
				]
			)
		) {
			throw new NotifierNotificationArgumentException('Invalid message type supplied.');
		}

		if (!$datetime instanceof DateTime) {
			throw new NotifierNotificationArgumentException('Invalid message date time supplied.');
		}

		if (!is_numeric($expiry) && !$expiry instanceof DateTime) {
			throw new NotifierNotificationArgumentException('Invalid message expiry supplied.');
		}

		$this->setId($id);
		$this->setMessage($message);
		$this->setType($type);
		$this->setDatetime($datetime);
		$this->setExpiry($expiry);
		$this->setOptions($options);
	}

	/**
	 * Set the notification id.
	 *
	 * @param integer $value
	 *
	 * @return void
	 */
	public function setId($value)
	{
		$this->id = $value;
	}

	/**
	 * Get the notification id.
	 *
	 * @return integer
	 */
	public function getId()
	{
		return $this->id;
	}

	/**
	 * Set the notification message.
	 *
	 * @param string $value
	 *
	 * @return void
	 */
	public function setMessage($value)
	{
		$this->message = $value;
	}

	/**
	 * Get the notification message.
	 *
	 * @return string
	 */
	public function getMessage()
	{
		return $this->message;
	}

	/**
	 * Set the notification message type.
	 *
	 * @param string $value
	 *
	 * @return void
	 */
	public function setType($value)
	{
		$this->type = $value;
	}

	/**
	 * Get the notification message.
	 *
	 * @return string
	 */
	public function getType()
	{
		return $this->type;
	}

	/**
	 * Set the notification message date time.
	 *
	 * @param DateTime $value
	 *
	 * @return void
	 */
	public function setDatetime($value)
	{
		$this->datetime = $value;
	}

	/**
	 * Get the notification message date time.
	 *
	 * @return DateTime
	 */
	public function getDatetime()
	{
		return $this->datetime;
	}

	/**
	 * Set the notification message expiry in minutes or with a DateTime object.
	 *
	 * @param DateTime|integer $value
	 *
	 * @return void
	 */
	public function setExpiry($value)
	{
		$this->expiry = $value;
	}

	/**
	 * Get the notification message expiry in minutes or a DateTime object.
	 *
	 * @return DateTime|integer
	 */
	public function getExpiry()
	{
		return $this->expiry;
	}

	/**
	 * Calculate the number of minutes between now and the given duration.
	 *
	 * @param DateTime|integer $duration
	 *
	 * @return integer
	 */
	protected function getMinutes($duration)
	{
		if ($duration instanceof DateTime) {
			$dateNow = new DateTime('now');

			if (($duration->format('U')) < ($dateNow->format('U'))) {
				return 0;
			}

			$interval = $dateNow->diff($duration);

			return $interval->format('%i');
		}

		return $duration;
	}

	/**
	 * Is notification message expired.
	 *
	 * @return boolean
	 */
	public function isExpired()
	{
		$expiryInSeconds = ($this->getMinutes($this->getExpiry()) * 60);

		if (($this->getDatetime()->add(new DateInterval('PT' . $expiryInSeconds . 'S'))->format('U')) > ((new DateTime('now'))->format('U'))) {
			return false;
		}

		return true;
	}

	/**
	 * Set the notification message displayed status.
	 *
	 * @param boolean $value
	 *
	 * @return void
	 */
	public function setDisplayed($value)
	{
		$this->displayed = $value;
	}

	/**
	 * Get the notification message displayed status.
	 *
	 * @return boolean
	 */
	public function getDisplayed()
	{
		return $this->displayed;
	}

	/**
	 * Get the notification message displayed status.
	 *
	 * @return boolean
	 */
	public function isDisplayed()
	{
		return $this->displayed;
	}

	/**
	 * Set the notification message options.
	 *
	 * @param array $value
	 *
	 * @return void
	 */
	public function setOptions(array $value)
	{
		$this->options = $value;
	}

	/**
	 * Get the notification message options.
	 *
	 * @return array
	 */
	public function getOptions()
	{
		return $this->options;
	}

	/**
	 * To array method.
	 *
	 * @return array
	 */
	public function __toArray()
	{
		return [
			'id' => $this->getId(),
			'message' => $this->getMessage(),
			'options' => $this->getOptions(),
			'type' => $this->getType(),
			'datetime' => $this->getDatetime(),
			'expiry' => $this->getExpiry(),
			'displayed' => $this->getDisplayed(),
			'expired' => $this->isExpired(),
		];
	}

}