ReliQArts\Docweaver\VO\Result

Complexity

Total Complexity

15

Size/Duplication

Total Lines	180
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	0

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
A	isSuccess()	0	4	1
A	setSuccess()	0	7	1
A	getError()	0	4	1
A	setError()	0	8	1
A	getData()	0	4	1
A	setData()	0	7	1
A	getMessage()	0	4	2
A	setMessage()	0	4	1
A	getMessages()	0	4	1
A	setMessages()	0	7	1
A	addMessage()	0	7	1
A	toArray()	0	4	1
A	toJson()	0	4	1

<?php

declare(strict_types=1);

namespace ReliQArts\Docweaver\VO;

use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;
use stdClass;

class Result implements Arrayable, Jsonable
{
    /**
     * @var bool
     */
    private $success;

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

    /**
     * @var string[]
     */
    private $messages;

    /**
     * @var null|stdClass
     */
    private $data;

    /**
     * Result constructor.
     *
     * @param bool     $success
     * @param string   $error
     * @param string[] $messages
     * @param mixed    $extra
     */
    public function __construct(
        bool $success = true,
        string $error = '',
        array $messages = [],
        $extra = null
    ) {
        $this->success = $success;
        $this->error = $error;
        $this->messages = $messages;
        $this->data = $extra;
    }

    /**
     * @return bool
     */
    public function isSuccess(): bool
    {
        return $this->success;
    }

    /**
     * @param bool $success
     *
     * @return self
     */
    public function setSuccess(bool $success): self
    {
        $clone = clone $this;
        $clone->success = $success;

        return $clone;
    }

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

    /**
     * @param string $error
     *
     * @return self
     */
    public function setError(string $error): self
    {
        $clone = clone $this;
        $clone->error = $error;
        $clone->success = false;

        return $clone;
    }

    /**
     * @return null|stdClass
     */
    public function getData(): ?stdClass
    {
        return $this->data;
    }

    /**
     * @param stdClass $data
     *
     * @return self
     */
    public function setData(stdClass $data): self
    {
        $clone = clone $this;
        $clone->data = $data;

        return $clone;
    }

    /**
     * @return string
     */
    public function getMessage(): string
    {
        return empty($this->messages) ? '' : current($this->messages);
    }

    /**
     * @param string $message
     *
     * @return self
     */
    public function setMessage(string $message): self
    {
        return $this->addMessage($message);
    }

    /**
     * @return string[]
     */
    public function getMessages(): array
    {
        return $this->messages;
    }

    /**
     * @param string ...$messages
     *
     * @return self
     */

Should the type for parameter $messages not be string[]?

    public function setMessages(string ...$messages): self
    {
        $clone = clone $this;
        $clone->messages = $messages;

        return $clone;
    }

    /**
     * @param string $message
     *
     * @return self
     */
    public function addMessage(string $message): self
    {
        $clone = clone $this;
        $clone->messages[] = $message;

        return $clone;
    }

    /**
     * {@inheritdoc}
     *
     * @return array
     */
    public function toArray()
    {
        return (array)$this;
    }

    /**
     * {@inheritdoc}
     *
     * @param int $options
     *
     * @return string
     */
    public function toJson($options = 0)
    {
        return json_encode($this->toArray());
    }
}