SmsGate\Result

Complexity

Total Complexity

8

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	successfully()	0	4	1
A	failed()	0	4	1
A	isSuccessfully()	0	4	1
A	isFailed()	0	4	1
A	getPhone()	0	4	1
A	getMessageId()	0	4	1
A	getError()	0	4	1

<?php

declare(strict_types = 1);

/*
 * This file is part of the SmsGate package
 *
 * (c) SmsGate
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code
 */

namespace SmsGate;

/**
 * The value object for store result of sending SMS
 *
 * @author Vitaliy Zhuk <zhuk2205@gmail.com>
 */
class Result
{
    /**
     * @var Phone
     */
    private $phone;

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

    /**
     * @var string
     */
    private $messageId;

    /**
     * @var Error
     */
    private $error;

    /**
     * Constructor.
     *
     * @param Phone  $phone
     * @param bool   $status
     * @param string $messageId
     * @param Error  $error
     */
    public function __construct(Phone $phone, bool $status, string $messageId = null, Error $error = null)
    {
        $this->phone = $phone;
        $this->status = $status;
        $this->messageId = $messageId;
        $this->error = $error;
    }

    /**
     * Create successfully result
     *
     * @param Phone  $phone
     * @param string $messageId
     *
     * @return Result
     */
    public static function successfully(Phone $phone, string $messageId = null): Result
    {
        return new self($phone, true, $messageId);
    }

    /**
     * Create failed result
     *
     * @param Phone  $phone
     * @param Error  $error
     * @param string $messageId
     *
     * @return Result
     */
    public static function failed(Phone $phone, Error $error, string $messageId = null): Result
    {
        return new self($phone, false, $messageId, $error);
    }

    /**
     * Is success send SMS?
     *
     * @return bool
     */
    public function isSuccessfully(): bool
    {
        return $this->status === true;
    }

    /**
     * Is failure send SMS?
     *
     * @return bool
     */
    public function isFailed(): bool
    {
        return $this->status === false;
    }

    /**
     * Get the phone
     *
     * @return Phone
     */
    public function getPhone(): Phone
    {
        return $this->phone;
    }

    /**
     * Get the identifier of message
     *
     * @return string
     */
    public function getMessageId(): ?string
    {
        return $this->messageId;
    }

    /**
     * Get the reason of error
     *
     * @return Error
     */
    public function getError(): ?Error
    {
        return $this->error;
    }
}