AlecRabbit\Tools\Internal\BenchmarkFunction

Complexity

Total Complexity

15

Size/Duplication

Total Lines	171
Duplicated Lines	0 %

Test Coverage

Coverage

95.12%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	1
A	getException()	0	3	1
A	enumeratedName()	0	3	1
A	getResult()	0	3	1
A	getIndexedName()	0	3	1
A	getCallable()	0	3	1
A	getTimer()	0	3	1
A	getHumanReadableName()	0	3	1
A	setException()	0	4	1
A	setRank()	0	4	1
A	getComment()	0	3	1
A	getIndex()	0	3	1
A	getArgs()	0	3	1
A	setResult()	0	3	1
A	getRank()	0	3	1

<?php
/**
 * User: alec
 * Date: 03.12.18
 * Time: 22:24
 */

namespace AlecRabbit\Tools\Internal;

use AlecRabbit\Tools\Timer;
use AlecRabbit\Traits\GettableName;
use function AlecRabbit\brackets;
use function AlecRabbit\str_decorate;
use const AlecRabbit\Helpers\Constants\BRACKETS_ANGLE;

/**
 * Class BenchmarkFunction
 * @package AlecRabbit
 * @internal
 */
class BenchmarkFunction
{
    use GettableName;

    /** @var callable */
    private $func;

    /** @var int */
    private $index;

    /** @var array */
    private $args;

    /** @var mixed */
    private $result;

    /** @var null|string */
    private $comment;

    /** @var null|string */
    private $humanReadableName;

    /** @var \Throwable|null */
    private $exception;

    /** @var Timer */
    private $timer;

    /** @var null|int */
    private $rank;

    /**
     * BenchmarkFunction constructor.
     * @param callable $func
     * @param string $name
     * @param int $index
     * @param array $args
     * @param null|string $comment
     * @param null|string $humanReadableName
     */
    public function __construct(
        $func,
        string $name,
        int $index,
        array $args,
        ?string $comment = null,
        ?string $humanReadableName = null
    ) {
        $this->func = $func;
        $this->name = $name;
        $this->index = $index;
        $this->args = $args;
        $this->comment = $comment;
        $this->humanReadableName = $humanReadableName;
        $this->timer = new Timer($this->getIndexedName());
    }

    /**
     * @return string
     */
    public function getIndexedName(): string
    {
        return "⟨{$this->getIndex()}⟩ {$this->getName()}";
    }

    /**
     * @return int
     */
    public function getIndex(): int
    {
        return $this->index;
    }

    /**
     * @return string
     */
    public function getComment(): string
    {
        return $this->comment;

The expression return $this->comment could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

//        return $this->comment ? str_decorate($this->comment, '"') : '';
    }

    /**
     * @return array
     */
    public function getArgs(): array
    {
        return $this->args;
    }

    /**
     * @return callable
     */
    public function getCallable(): callable
    {
        return $this->func;
    }

    public function enumeratedName(): string
    {
        return $this->getIndexedName();
//        return
//            brackets((string)$this->index, BRACKETS_ANGLE) . ' ' . $this->name;
    }

    /**
     * @return mixed
     */
    public function getResult()
    {
        return $this->result;
    }

    /**
     * @param mixed $result
     */
    public function setResult($result): void
    {
        $this->result = $result;
    }

    /**
     * @return Timer
     */
    public function getTimer(): Timer
    {
        return $this->timer;
    }

    /**
     * @return null|string
     */
    public function getHumanReadableName(): ?string
    {
        return $this->humanReadableName ?? $this->getIndexedName();
    }

    /**
     * @return null|\Throwable
     */
    public function getException(): ?\Throwable
    {
        return $this->exception;
    }

    /**
     * @param \Throwable $exception
     * @return BenchmarkFunction
     */
    public function setException(\Throwable $exception): BenchmarkFunction
    {
        $this->exception = $exception;
        return $this;
    }

    /**
     * @return null|int
     */
    public function getRank(): ?int
    {
        return $this->rank;
    }

    /**
     * @param null|int $rank
     * @return BenchmarkFunction
     */
    public function setRank(?int $rank): BenchmarkFunction
    {
        $this->rank = $rank;
        return $this;
    }
}