AlecRabbit\Tools\Internal\BenchmarkedFunction

Complexity

Total Complexity

7

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getIndex()	0	3	1
A	getArgs()	0	3	1
A	getEnumeratedName()	0	4	1
A	getFunction()	0	3	1
A	__construct()	0	7	1
A	getComment()	0	3	2

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

namespace AlecRabbit\Tools\Internal;

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

The constant AlecRabbit\Constants\BRACKETS_ANGLE was not found. Maybe you did not declare it correctly or list all dependencies?

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

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

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

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

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

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

    /**
     * @return string
     */
    public function getComment(): string
    {
        return $this->comment ? str_decorate($this->comment, '"') : '';
    }

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

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

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

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