ker0x\Push\Adapter\Fcm\Message\NotificationBuilder

Complexity

Total Complexity

27

Size/Duplication

Total Lines	405
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

25 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getTitle()	0	4	1
A	getBody()	0	4	1
A	setBody()	0	7	1
A	getSound()	0	4	1
A	setSound()	0	7	1
A	getBadge()	0	4	1
A	setBadge()	0	7	1
A	getIcon()	0	4	1
A	setIcon()	0	7	1
A	getTag()	0	4	1
A	setTag()	0	7	1
A	getColor()	0	4	1
A	setColor()	0	9	2
A	getClickAction()	0	4	1
A	setClickAction()	0	7	1
A	getBodyLocKey()	0	4	1
A	setBodyLocKey()	0	7	1
A	getBodyLocArgs()	0	4	1
A	setBodyLocArgs()	0	7	1
A	getTitleLocKey()	0	4	1
A	setTitleLocKey()	0	7	1
A	getTitleLocArgs()	0	4	1
A	setTitleLocArgs()	0	7	1
A	isString()	0	6	2

<?php
namespace ker0x\Push\Adapter\Fcm\Message;

use ker0x\Push\Adapter\Fcm\Message\Exception\InvalidNotificationException;

/**
 * Class NotificationBuilder
 * @package ker0x\Push\Adapter\Fcm\Message
 */
class NotificationBuilder
{

    /**
     * Indicates notification title.
     *
     * @var null|string
     */
    protected $title;

    /**
     * Indicates notification body text.
     *
     * @var null|string
     */
    protected $body;

    /**
     * Indicates a sound to play when the device receives a notification.
     *
     * @var null|string
     */
    protected $sound;

    /**
     * Indicates the badge on the client app home icon. (iOS)
     *
     * @var null|string
     */
    protected $badge;

    /**
     * Indicates notification icon. (Android)
     *
     * @var null|string
     */
    protected $icon;

    /**
     * Indicates whether each notification results in a new entry in the
     * notification drawer on Android. (Android)
     *
     * @var null|string
     */
    protected $tag;

    /**
     * Indicates color of the icon, expressed in #rrggbb format. (Android)
     *
     * @var null|string
     */
    protected $color;

    /**
     * Indicates the action associated with a user click on the notification.
     *
     * @var null|string
     */
    protected $clickAction;

    /**
     * Indicates the key to the body string for localization.
     *
     * @var null|string
     */
    protected $bodyLocKey;

    /**
     * Indicates the string value to replace format specifiers in the
     * body string for localization.
     *
     * @var null|string
     */
    protected $bodyLocArgs;

    /**
     * Indicates the key to the title string for localization.
     *
     * @var null|string
     */
    protected $titleLocKey;

    /**
     * Indicates the string value to replace format specifiers in
     * the title string for localization.
     *
     * @var null|string
     */
    protected $titleLocArgs;

    /**
     * NotificationBuilder constructor.
     *
     * @param string $title Notification title.
     */
    public function __construct($title)
    {
        $this->title = $title;
    }

    /**
     * Getter for title.
     *
     * @return null|string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * Getter for body.
     *
     * @return null|string
     */
    public function getBody()
    {
        return $this->body;
    }

    /**
     * Setter for body.
     *
     * @param string $body Notification body text.
     * @return $this
     * @throws \ker0x\Push\Adapter\Fcm\Message\Exception\InvalidNotificationException
     */
    public function setBody($body)
    {
        $this->isString($body, 'body');
        $this->body = $body;

        return $this;
    }

    /**
     * Getter for sound.
     *
     * @return null|string
     */
    public function getSound()
    {
        return $this->sound;
    }

    /**
     * Setter for sound.
     *
     * @param string $sound Sound to play when the device receives a notification.
     * @return $this
     * @throws \ker0x\Push\Adapter\Fcm\Message\Exception\InvalidNotificationException
     */
    public function setSound($sound)
    {
        $this->isString($sound, 'sound');
        $this->sound = $sound;

        return $this;
    }

    /**
     * Getter for badge.
     *
     * @return null|string
     */
    public function getBadge()
    {
        return $this->badge;
    }

    /**
     * Setter for badge.
     *
     * @param string $badge Badge on the client app home icon. (iOS)
     * @return $this
     * @throws \ker0x\Push\Adapter\Fcm\Message\Exception\InvalidNotificationException
     */
    public function setBadge($badge)
    {
        $this->isString($badge, 'badge');
        $this->badge = $badge;

        return $this;
    }

    /**
     * Getter for icon.
     *
     * @return null|string
     */
    public function getIcon()
    {
        return $this->icon;
    }

    /**
     * Setter for icon.
     *
     * @param string $icon Notification icon. (Android)
     * @return $this
     * @throws \ker0x\Push\Adapter\Fcm\Message\Exception\InvalidNotificationException
     */
    public function setIcon($icon)
    {
        $this->isString($icon, 'icon');
        $this->icon = $icon;

        return $this;
    }

    /**
     * Getter for tag.
     *
     * @return null|string
     */
    public function getTag()
    {
        return $this->tag;
    }

    /**
     * Setter for tag.
     *
     * @param string $tag Notification results in a new entry in the
     * notification drawer on Android. (Android)
     * @return $this
     * @throws \ker0x\Push\Adapter\Fcm\Message\Exception\InvalidNotificationException
     */
    public function setTag($tag)
    {
        $this->isString($tag, 'tag');
        $this->tag = $tag;

        return $this;
    }

    /**
     * Getter for color.
     *
     * @return null|string
     */
    public function getColor()
    {
        return $this->color;
    }

    /**
     * Setter for color.
     *
     * @param string $color Color of the icon, expressed in #rrggbb format. (Android)
     * @return $this
     * @throws \ker0x\Push\Adapter\Fcm\Message\Exception\InvalidNotificationException
     */
    public function setColor($color)
    {
        if (!preg_match('/^#[A-Fa-f0-9]{6}$/', $color)) {
            throw InvalidNotificationException::invalidColor();
        }
        $this->color = $color;

        return $this;
    }

    /**
     * Getter for clickAction.
     *
     * @return null|string
     */
    public function getClickAction()
    {
        return $this->clickAction;
    }

    /**
     * Setter for clickAction
     *
     * @param string $clickAction Action associated with a user click on the notification.
     * @return $this
     * @throws \ker0x\Push\Adapter\Fcm\Message\Exception\InvalidNotificationException
     */
    public function setClickAction($clickAction)
    {
        $this->isString($clickAction, 'click_action');
        $this->clickAction = $clickAction;

        return $this;
    }

    /**
     * Getter for bodyLocKey
     *
     * @return null|string
     */
    public function getBodyLocKey()
    {
        return $this->bodyLocKey;
    }

    /**
     * Setter for bodyLocKey
     *
     * @param string $bodyLocKey Key to the body string for localization.
     * @return $this
     * @throws \ker0x\Push\Adapter\Fcm\Message\Exception\InvalidNotificationException
     */
    public function setBodyLocKey($bodyLocKey)
    {
        $this->isString($bodyLocKey, 'body_loc_key');
        $this->bodyLocKey = $bodyLocKey;

        return $this;
    }

    /**
     * Getter for bodyLocArgs.
     *
     * @return null|string
     */
    public function getBodyLocArgs()
    {
        return $this->bodyLocArgs;
    }

    /**
     * Setter for bodyLocArgs.
     *
     * @param string $bodyLocArgs String value to replace format specifiers in the
     * body string for localization.
     * @return $this
     * @throws \ker0x\Push\Adapter\Fcm\Message\Exception\InvalidNotificationException
     */
    public function setBodyLocArgs($bodyLocArgs)
    {
        $this->isString($bodyLocArgs, 'body_loc_args');
        $this->bodyLocArgs = $bodyLocArgs;

        return $this;
    }

    /**
     * Getter for titleLocKey.
     *
     * @return null|string
     */
    public function getTitleLocKey()
    {
        return $this->titleLocKey;
    }

    /**
     * Setter for titleLocKey.
     *
     * @param string $titleLocKey Key to the title string for localization.
     * @return $this
     * @throws \ker0x\Push\Adapter\Fcm\Message\Exception\InvalidNotificationException
     */
    public function setTitleLocKey($titleLocKey)
    {
        $this->isString($titleLocKey, 'title_loc_key');
        $this->titleLocKey = $titleLocKey;

        return $this;
    }

    /**
     * Getter for titleLocArgs
     *
     * @return null|string
     */
    public function getTitleLocArgs()
    {
        return $this->titleLocArgs;
    }

    /**
     * Setter for titleLocArgs
     *
     * @param string $titleLocArgs String value to replace format specifiers in
     * the title string for localization.
     * @return $this
     * @throws \ker0x\Push\Adapter\Fcm\Message\Exception\InvalidNotificationException
     */
    public function setTitleLocArgs($titleLocArgs)
    {
        $this->isString($titleLocArgs, 'title_loc_args');
        $this->titleLocArgs = $titleLocArgs;

        return $this;
    }

    /**
     * Test if $value is a string.
     *
     * @param string $value The value to test.
     * @param string $key The key of the value.
     * @return void
     * @throws \ker0x\Push\Adapter\Fcm\Message\Exception\InvalidNotificationException
     */
    private function isString($value, $key)
    {
        if (!is_string($value)) {
            throw InvalidNotificationException::mustBeString($key);
        }
    }
}