App\BenchMark\Reporter\Task

Complexity

Total Complexity

13

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	memory()	0	3	1
A	average()	0	3	1
A	clear()	0	9	1
A	failed()	0	9	2
A	end()	0	6	1
A	name()	0	9	2
A	start()	0	4	1
A	duration()	0	3	1
A	repeat()	0	10	2
A	rate()	0	3	1

<?php

declare(strict_types=1);

/*
 * This file is part of DivineNii opensource projects.
 *
 * PHP version 7.4 and above required
 *
 * @author    Divine Niiquaye Ibok <divineibok@gmail.com>
 * @copyright 2019 DivineNii (https://divinenii.com/)
 * @license   https://opensource.org/licenses/BSD-3-Clause License
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace App\BenchMark\Reporter;

class Task
{
    protected string $name = '';

    protected int $repeat = 1;

    /** @var float|int Duration time (in seconds). */
    protected $duration = 0;

    /** @var float|int The average taken time per task (in seconds). */
    protected $average = 0;

    /** @var float|int The time rate. */
    protected $rate = 0;

    /** The memory usage (in bytes) */
    protected int $memory = 0;

    /** @var float Start time (in seconds). */
    protected $startTime = 0;

    /** @var int Start up memory usage (in bytes) */
    protected $startMemory = 0;

    /** @var bool Indicates if the task failed */
    protected $failed = false;

    /**
     * Starts the timer
     */
    public function start(): void
    {
        $this->startTime   = \microtime(true);

It seems like microtime(true) can also be of type string. However, the property $startTime is declared as type double. Maybe add an additional type check?

        $this->startMemory = \memory_get_usage(true);
    }

    /**
     * Stops the timer.
     */
    public function end(): void
    {
        $this->duration = \microtime(true) - $this->startTime;
        $this->average  = $this->duration / $this->repeat;
        $this->rate     = $this->repeat / $this->duration;
        $this->memory   = \memory_get_usage(true) - $this->startMemory;
    }

    /**
     * Gets/sets the name.
     *
     * @param null|string the task name to set or none the get the current one

The type App\BenchMark\Reporter\the was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @return self|string name or `$this` on set
     */
    public function name(?string $name = null)
    {
        if (null !== $name) {
            $this->name = $name;

            return $this;
        }

        return $this->name;
    }

    /**
     * Gets/sets the repeat number.
     *
     * @param int $repeat the repeat value to set or none the get the current one
     *
     * @return int|self the repeat value or `$this` on set
     */
    public function repeat(?int $repeat = null)
    {
        if (null !== $repeat) {
            $this->clear();
            $this->repeat = $repeat;

            return $this;
        }

        return $this->repeat;
    }

    /**
     * Returns the average taken time.
     *
     * @return float|int the time taken per task, in average (in seconds)
     */
    public function average()
    {
        return $this->average;
    }

    /**
     * Returns the time rate.
     *
     * @return float|int the time rate
     */
    public function rate()
    {
        return $this->rate;
    }

    /**
     * Returns the whole taken time.
     *
     * @return float|int the time taken (in seconds)
     */
    public function duration()
    {
        return $this->duration;
    }

    /**
     * Returns the memory usage.
     *
     * @return int the memory usage (in bytes)
     */
    public function memory(): int
    {
        return $this->memory;
    }

    /**
     * Indicates whether the task failed or not.
     *
     * @var null|bool the failing value
     *
     * @return bool|self
     */
    public function failed(?bool $fail = null)
    {
        if (\is_bool($fail)) {
            $this->failed = $fail;

            return $this;
        }

        return $this->failed;
    }

    /**
     * Clears the stats.
     */
    public function clear(): void
    {
        $this->repeat    = 1;
        $this->startTime = 0;
        $this->duration  = 0;
        $this->average   = 0;
        $this->rate      = 0;
        $this->startMem  = 0;

The property startMem does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->memory    = 0;
    }
}