Spiral\Core\Internal\Tracer

Complexity

Total Complexity

17

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

97.22%

Importance

Changes	5
Bugs	1	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	3	2
A	combineTraceMessage()	0	3	1
A	blockToStringList()	0	12	2
A	getRootAlias()	0	3	1
A	pop()	0	12	3
A	push()	0	7	6
A	renderTraceList()	0	8	2

<?php

declare(strict_types=1);

namespace Spiral\Core\Internal;

/**
 * @internal
 */
final class Tracer implements \Stringable
{
    /**
     * Trace blocks
     *
     * @var Trace[][]
     */
    private array $traces = [];

    public function __toString(): string
    {
        return $this->traces === [] ? '' : "Container trace list:\n" . $this->renderTraceList($this->traces);
    }

    /**
     * @param string $header Message before stack list
     * @param bool $lastBlock Generate trace list only for last block
     * @param bool $clear Remove touched trace list
     */
    public function combineTraceMessage(string $header, bool $lastBlock = false, bool $clear = false): string

The parameter $lastBlock is not used and could be removed.

The parameter $clear is not used and could be removed.

    {
        return "$header\n$this";
    }

    public function push(bool $nextLevel, mixed ...$details): void
    {
        $trace = $details === [] ? null : new Trace($details);
        if ($nextLevel || $this->traces === []) {
            $this->traces[] = $trace === null ? [] : [$trace];
        } elseif ($trace !== null) {
            $this->traces[\array_key_last($this->traces)][] = $trace;
        }
    }

    public function pop(bool $previousLevel = false): void
    {
        if ($this->traces === []) {
            return;
        }
        if ($previousLevel) {
            \array_pop($this->traces);
            return;
        }
        $key = \array_key_last($this->traces);
        $list = &$this->traces[$key];
        \array_pop($list);
    }

    public function getRootAlias(): string
    {
        return $this->traces[0][0]->alias ?? '';
    }

    /**
     * @param Trace[][] $blocks
     */
    private function renderTraceList(array $blocks): string
    {
        $result = [];
        $i = 0;
        foreach ($blocks as $block) {
            \array_push($result, ...$this->blockToStringList($block, $i++));
        }
        return \implode("\n", $result);
    }

    /**
     * @param Trace[] $items
     * @param int<0, max> $level
     *
     * @return string[]
     */
    private function blockToStringList(array $items, int $level = 0): array
    {
        $result = [];
        $padding = \str_repeat('  ', $level);
        $firstPrefix = "$padding- ";
        // Separator
        $s = "\n";
        $nexPrefix = "$s$padding  ";
        foreach ($items as $item) {
            $result[] = $firstPrefix . \str_replace($s, $nexPrefix, (string)$item);
        }
        return $result;
    }
}