Arcanedev\LaravelMetrics\Results\Result

Complexity

Total Complexity

6

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	value()	0	6	1
A	prefix()	0	6	1
A	suffix()	0	6	1
A	format()	0	6	1
A	toArray()	0	9	1

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelMetrics\Results;

use Arcanedev\LaravelMetrics\Concerns\ConvertsToArray;
use Illuminate\Contracts\Support\{Arrayable, Jsonable};
use JsonSerializable;

/**
 * Class     Result
 *
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
abstract class Result implements Arrayable, Jsonable, JsonSerializable
{
    /* -----------------------------------------------------------------
     |  Traits
     | -----------------------------------------------------------------
     */

    use ConvertsToArray;

    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * The result value.
     *
     * @var mixed|null
     */
    public $value;

    /**
     * The result prefix
     *
     * @var string|null
     */
    public $prefix;

    /**
     * The result suffix.
     *
     * @var string|null
     */
    public $suffix;

    /**
     * The result format.
     *
     * @var string
     */
    public $format;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Result constructor.
     *
     * @param  mixed|null  $value
     */
    public function __construct($value = null)
    {
        $this->value($value);
    }

    /* -----------------------------------------------------------------
     |  Setters
     | -----------------------------------------------------------------
     */

    /**
     * Set the value.
     *
     * @param  mixed  $value
     *
     * @return $this
     */
    public function value($value)
    {
        $this->value = $value;

        return $this;
    }

    /**
     * Set the result prefix.
     *
     * @param  string  $prefix
     *
     * @return $this
     */
    public function prefix(string $prefix)
    {
        $this->prefix = $prefix;

        return $this;
    }

    /**
     * Set the result suffix.
     *
     * @param  string  $suffix
     *
     * @return $this
     */
    public function suffix(string $suffix)
    {
        $this->suffix = $suffix;

        return $this;
    }

    /**
     * Set the result format.
     *
     * @param  string  $format
     *
     * @return $this
     */
    public function format(string $format)
    {
        $this->format = $format;

        return $this;
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get the instance as an array.
     *
     * @return array
     */
    public function toArray(): array
    {
        return [
            'value'  => $this->value,
            'format' => $this->format,
            'prefix' => $this->prefix,
            'suffix' => $this->suffix,
        ];
    }
}