Zbox\UnifiedPush\Message\Type\GCM

Complexity

Total Complexity

18

Size/Duplication

Total Lines	210
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	6
Bugs	2	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	getMessageType()	0	4	1
A	getCollapseKey()	0	4	1
A	setCollapseKey()	0	5	1
A	isDelayWhileIdle()	0	4	1
A	setDelayWhileIdle()	0	5	1
A	isDryRun()	0	4	1
A	setDryRun()	0	5	1
A	getPackageName()	0	4	1
A	setPackageName()	0	5	1
A	getPayloadData()	0	4	1
A	setPayloadData()	0	5	1
A	createPayload()	0	19	2
A	packPayload()	0	4	1
A	validateRecipient()	0	11	2
A	checkIfDryRun()	0	8	2

<?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;
use Zbox\UnifiedPush\Utils\JsonEncoder;

/**
 * Class GCM
 * @package Zbox\UnifiedPush\Message\Type
 */
class GCM extends MessageBase
{
    /**
     * The maximum size allowed for an Android notification payload is 4096 bytes
     */
    const PAYLOAD_MAX_LENGTH = 4096;

    /**
     * It`s possible to send the same message to up to 1000 registration IDs in one request
     */
    const MAX_RECIPIENTS_PER_MESSAGE_COUNT = 1000;

    /**
     * Allow test the request without actually sending the message
     *
     * @var boolean
     */
    private $dryRun = false;

    /**
     * If there is already a message with the same collapse key (and registration ID)
     * stored and waiting for delivery, the old message will be discarded
     * and the new message will take its place
     *
     * @var string
     */
    private $collapseKey;

    /**
     * Message payload data
     *
     * @var array
     */
    private $payloadData;

    /**
     * If the device is connected but idle, the message will still be delivered right away
     * unless the delay_while_idle flag is set to true
     *
     * @var boolean
     */
    private $delayWhileIdle;

    /**
     * Package name of you application
     *
     * @var string
     */
    private $packageName;

    /**
     * @return string
     */
    public function getMessageType()
    {
        return NotificationServices::GOOGLE_CLOUD_MESSAGING;
    }

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

    /**
     * @param string $collapseKey
     * @return $this
     */
    public function setCollapseKey($collapseKey)
    {
        $this->collapseKey = $collapseKey;
        return $this;
    }

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

    /**
     * @param boolean $delayWhileIdle
     * @return $this
     */
    public function setDelayWhileIdle($delayWhileIdle)
    {
        $this->delayWhileIdle = $delayWhileIdle;
        return $this;
    }

    /**
     * @return boolean
     */
    public function isDryRun()
    {
        return (bool) $this->dryRun;
    }

    /**
     * @param boolean $dryRun
     * @return $this
     */
    public function setDryRun($dryRun)
    {
        $this->dryRun = $dryRun;
        return $this;
    }

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

    /**
     * @param string $packageName
     * @return $this
     */
    public function setPackageName($packageName)
    {
        $this->packageName = $packageName;
        return $this;
    }

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

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

    /**
     * @return array
     */
    public function createPayload()
    {
        $registrationIds = array();

        foreach ($this->getRecipientCollection() as $recipient) {
            $registrationIds[] = $recipient->getIdentifier();
        }

        $payload =
            array(
                'collapse_key'      => $this->getCollapseKey(),
                'delay_while_idle'  => $this->isDelayWhileIdle(),
                'registration_ids'  => $registrationIds,
                'data'              => $this->getPayloadData(),
                'time_to_live'      => $this->getExpirationTime()->format('U') - time()
            );

        return $this->checkIfDryRun($payload);
    }

    /**
     * Pack message body into a json representation
     *
     * @param array $payload
     * @return string
     */
    public function packPayload($payload)
    {
        return JsonEncoder::jsonEncode($payload);
    }

    /**
     * {@inheritdoc}
     */
    public function validateRecipient($token)
    {
        if (!preg_match('#^[0-9a-z\-\_]+$#i', $token)) {
            throw new InvalidArgumentException(sprintf(
                'Device token must be mask "%s". Token given: "%s"',
                '^[0-9a-z\-\_]+$#i',
                $token
            ));
        }
        return true;
    }

    /**
     * @param array $payload
     * @return array
     */
    protected function checkIfDryRun($payload)
    {
        if ($this->isDryRun()) {
            $payload['dry_run'] = $this->isDryRun();
        }

        return $payload;
    }
}