Zbox\UnifiedPush\Message\Type\APNS

Complexity

Total Complexity

29

Size/Duplication

Total Lines	306
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	getMessageType()	0	4	1
A	getAlert()	0	4	1
A	setAlert()	0	9	2
A	getAlertDictionary()	0	4	1
A	setAlertDictionary()	0	5	1
A	getBadge()	0	4	1
A	setBadge()	0	10	2
A	getCustomPayloadData()	0	4	1
A	setCustomPayloadData()	0	4	1
A	isContentAvailable()	0	4	1
A	setContentAvailable()	0	10	2
A	getPriority()	0	4	1
A	setPriority()	0	4	1
A	getSound()	0	4	1
A	setSound()	0	9	2
A	getCategory()	0	4	1
A	setCategory()	0	9	2
A	getUrlArgs()	0	4	1
A	setUrlArgs()	0	5	1
A	isMutableContent()	0	4	1
A	setMutableContent()	0	5	1
A	validateRecipient()	0	17	3

<?php

/*
 * (c) Alexander Zhukov <zbox82@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zbox\UnifiedPush\Message\Type;

use Zbox\UnifiedPush\Message\MessageBase;
use Zbox\UnifiedPush\NotificationService\NotificationServices;
use Zbox\UnifiedPush\Exception\InvalidArgumentException;

/**
 * Class APNS
 * @package Zbox\UnifiedPush\Message\Type
 */
class APNS extends MessageBase
{
    /**
     * APNs does not support multicast sending
     */
    const MAX_RECIPIENTS_PER_MESSAGE_COUNT = 1;

    /**
     * The message’s priority. Provide one of the following values:
     * - 10 The push message is sent immediately
     * - 5 The push message is sent at a time that conserves power on the device receiving it
     *
     * @var integer
     */
    protected $priority;

    /**
     * Message text of an alert
     *
     * @var string
     */
    private $alert;

    /**
     * Alert dictionary
     *
     * @var APNSAlert|null
     */
    private $alertDictionary;

    /**
     * The number to display as the badge of the application icon
     *
     * @var integer
     */
    private $badge;

    /**
     * The name of a sound file in the application bundle
     *
     * @var string
     */
    private $sound;

    /**
     * Category option for custom notification actions (iOS 8+)
     *
     * @var string
     */
    private $category;

    /**
     * Provide this key with a value of 1 to indicate that new content is available
     *
     * @var bool
     */
    private $contentAvailable;

    /**
     * Custom properties
     *
     * @var array
     */
    private $customPayloadData = array();

    /**
     * Safari url args
     *
     * @var array
     */
    private $urlArgs;

    /**
     * @var bool
     */
    private $mutableContent;

    /**
     * Gets message type
     *
     * @return string
     */
    public function getMessageType()
    {
        return NotificationServices::APPLE_PUSH_NOTIFICATIONS_SERVICE;
    }

    /**
     * @return string
     */
    public function getAlert()
    {
        return $this->alert;
    }

    /**
     * @param string $alert
     * @return $this
     */
    public function setAlert($alert)
    {
        if (!is_scalar($alert)) {
            $this->invalidArgumentException('Alert', 'a string');
        }
        $this->alert = $alert;

        return $this;
    }

    /**
     * @return APNSAlert|null
     */
    public function getAlertDictionary()
    {
        return $this->alertDictionary;
    }

    /**
     * @param APNSAlert $alertDictionary
     * @return APNS
     */
    public function setAlertDictionary(APNSAlert $alertDictionary)
    {
        $this->alertDictionary = $alertDictionary;
        return $this;
    }

    /**
     * @return int
     */
    public function getBadge()
    {
        return $this->badge;
    }

    /**
     * @param int $badge
     * @return $this
     */
    public function setBadge($badge)
    {
        if (!is_int($badge)) {
            $this->invalidArgumentException('Badge', 'an integer');
        }

        $this->badge = $badge;

        return $this;
    }

    /**
     * @return array
     */
    public function getCustomPayloadData()
    {
        return $this->customPayloadData;
    }

    /**
     * @param array $customPayloadData
     */
    public function setCustomPayloadData($customPayloadData)
    {
        $this->customPayloadData = $customPayloadData;
    }

    /**
     * @return boolean
     */
    public function isContentAvailable()
    {
        return $this->contentAvailable;
    }

    /**
     * @param boolean $contentAvailable
     * @return $this
     */
    public function setContentAvailable($contentAvailable)
    {
        if (!is_bool($contentAvailable)) {
            $this->invalidArgumentException('ContentAvailable', 'a boolean');
        }

        $this->contentAvailable = $contentAvailable;

        return $this;
    }

    /**
     * @return int
     */
    public function getPriority()
    {
        return $this->priority;
    }

    /**
     * @param int $priority
     */
    public function setPriority($priority)
    {
        $this->priority = $priority;
    }

    /**
     * @return string
     */
    public function getSound()
    {
        return $this->sound;
    }

    /**
     * @param string $sound
     * @return $this
     */
    public function setSound($sound)
    {
        if (!is_scalar($sound)) {
            $this->invalidArgumentException('Sound', 'an string');
        }
        $this->sound = $sound;

        return $this;
    }

    /**
     * @return string
     */
    public function getCategory()
    {
        return $this->category;
    }

    /**
     * @param string $category
     * @return $this
     */
    public function setCategory($category)
    {
        if (!is_scalar($category)) {
            $this->invalidArgumentException('Category', 'an string');
        }
        $this->category = $category;

        return $this;
    }

    /**
     * @return array
     */
    public function getUrlArgs()
    {
        return $this->urlArgs;
    }

    /**
     * @param array $urlArgs
     * @return $this
     */
    public function setUrlArgs($urlArgs)
    {
        $this->urlArgs = $urlArgs;
        return $this;
    }

    /**
     * @return boolean
     */
    public function isMutableContent()
    {
        return $this->mutableContent;
    }

    /**
     * @param boolean $mutableContent
     * @return $this
     */
    public function setMutableContent($mutableContent)
    {
        $this->mutableContent = (bool) $mutableContent;
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function validateRecipient($token)
    {
        if (!ctype_xdigit($token)) {
            throw new InvalidArgumentException(sprintf(
                'Device token must be a hexadecimal digit. Token given: "%s"',
                $token
            ));
        }

        if (strlen($token) != 64) {
            throw new InvalidArgumentException(sprintf(
                'Device token must be a 64 charsets, Token length given: %d.',
                mb_strlen($token)
            ));
        }
        return true;
    }
}