alxmsl\Google\GCM\Response\Status

Complexity

Total Complexity

10

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setError()	0	4	1
A	getError()	0	3	1
A	setMessageId()	0	4	1
A	getMessageId()	0	3	1
A	setCanonicalId()	0	4	1
A	getCanonicalId()	0	3	1
A	hasCanonicalId()	0	3	1
A	mustRemove()	0	3	1
A	canRetry()	0	4	2

<?php
/*
 * Copyright 2015 Alexey Maslov <alexey.y.maslov@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace alxmsl\Google\GCM\Response;

/**
 * Class for message delivery status
 * @author alxmsl
 * @date 5/28/13
 */ 
final class Status {
    /**
     * Error constants
     */
    const STATUS_UNAVAILABLE           = 'Unavailable',
          STATUS_NOT_REGISTERED        = 'NotRegistered',
          STATUS_MISSING_REGISTRATION  = 'MissingRegistration',
          STATUS_INVALID_REGISTRATION  = 'InvalidRegistration',
          STATUS_MISMATCH_SENDER_ID    = 'MismatchSenderId',
          STATUS_MESSAGE_TOO_BIG       = 'MessageTooBig',
          STATUS_INVALID_DATA_KEY      = 'InvalidDataKey',
          STATUS_INVALID_TTL           = 'InvalidTtl',
          STATUS_INTERNAL_SERVER_ERROR = 'InternalServerError';

    /**
     * @var string message identifier
     */
    private $messageId = '';

    /**
     * @var string canonical device identifier
     */
    private $canonicalId = '';

    /**
     * @var string error code
     */
    private $error = '';

    /**
     * Error code setter
     * @param string $error error code
     * @return Status self
     */
    public function setError($error) {
        $this->error = (string) $error;
        return $this;
    }

    /**
     * Error code getter
     * @return string error code
     */
    public function getError() {
        return $this->error;
    }

    /**
     * Message identifier setter
     * @param string $messageId message identifier
     * @return Status self
     */
    public function setMessageId($messageId) {
        $this->messageId = (string) $messageId;
        return $this;
    }

    /**
     * Message identifier getter
     * @return string message identifier
     */
    public function getMessageId() {
        return $this->messageId;
    }

    /**
     * Canonical identifier setter
     * @param string $registrationId canonical identifier
     * @return Status self
     */
    public function setCanonicalId($registrationId) {
        $this->canonicalId = (string) $registrationId;
        return $this;
    }

    /**
     * Canonical identifier getter
     * @return string canonical identifier
     */
    public function getCanonicalId() {
        return $this->canonicalId;
    }

    /**
     * Check status for new device registration identifier
     * @return bool true when status has new device registration identifier
     */
    public function hasCanonicalId() {
        return !empty($this->canonicalId);
    }

    /**
     * Check status for need to remove device registration identifier
     * @return bool true when need to remove device registration identifier
     */
    public function mustRemove() {
        return $this->getError() == self::STATUS_NOT_REGISTERED;
    }

    /**
     * Check status for can to retry message sending
     * @return bool true when can to retry message sending
     */
    public function canRetry() {
        return $this->getError() == self::STATUS_UNAVAILABLE
            || $this->getError() == self::STATUS_INTERNAL_SERVER_ERROR;
    }
}