Notification.php

<?php

namespace App\Util;

use App\Entity\User;
use DateTime;

/**
 * Data class for all Notifications
 *
 * @author Aquib Baig <aquibbaig97@gmail.com>
 */
class Notification
{
    /**
     * Subject of the Notification
     *
     * @var string $subject
     */
    protected $subject;

    /**
     * Actual definition of the Notification
     *
     * @var string $message
     */
    protected $message;

    /**
     * User associated with the Notification
     *
     * @var User $recipient
     */
    protected $recipient;

    /**
     * The type of Notification
     *
     * @var string $type
     */
    protected $type;

    /**
     * When is the Notification created
     *
     * @var DateTime $createdAt
     */
    protected $createdAt;

    /**
     * Notification constructor.
     */
    public function __construct()
    {
        $this->setCreatedAt(new DateTime());
    }

    /**
     * Gets the Notification Subject
     *
     * @return string
     */
    public function getSubject(): string
    {
        return $this->subject;
    }

    /**
     * Sets the Notification Subject
     *
     * @param string $subject
     *
     * @return $this
     */
    public function setSubject(string $subject)
    {
        $this->subject = $subject;

        return $this;
    }

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

    /**
     * Set the Notification Message
     *
     * @param string $message
     *
     * @return $this
     */
    public function setMessage(string $message)
    {
        $this->message = $message;

        return $this;
    }

    /**
     * Returns the type of the Notification
     *
     * @return string
     */
    public function getType(): string
    {
        return $this->type;
    }

    /**
     * Set the Notification type
     *
     * @param string $type
     *
     * @return $this
     */
    public function setType(string $type)
    {
        $this->type = $type;

        return $this;
    }

    /**
     * Returns User associated with a Notification
     *
     * @return User
     */
    public function getRecipient(): User
    {
        return $this->recipient;
    }

    /**
     * Used to bind users to any Notification
     *
     * @param User $recipient
     *
     * @return $this
     */
    public function setRecipient(User $recipient)
    {
        $this->recipient = $recipient;

        return $this;
    }

    /**
     * Gets the timestamp of a Notification
     *
     * @return DateTime
     */
    public function getCreatedAt(): DateTime
    {
        return $this->createdAt;
    }

    /**
     * Sets the timestamp of a Notification
     *
     * @param DateTime $createdAt
     *
     * @return $this
     */
    public function setCreatedAt(DateTime $createdAt)
    {
        $this->createdAt = $createdAt;

        return $this;
    }
}