Mediact\DependencyGuard\Php\Symbol

Complexity

Total Complexity

6

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	jsonSerialize()	0	6	1
A	__toString()	0	3	1
A	getLine()	0	3	1
A	getFile()	0	3	1
A	getName()	0	3	1
A	__construct()	0	4	1

<?php
/**
 * Copyright MediaCT. All rights reserved.
 * https://www.mediact.nl
 */

namespace Mediact\DependencyGuard\Php;

use PhpParser\Node\Name;
use SplFileInfo;

class Symbol implements SymbolInterface
{
    /** @var SplFileInfo */
    private $file;

    /** @var Name */
    private $node;

    /**
     * Constructor.
     *
     * @param SplFileInfo $file
     * @param Name        $node
     */
    public function __construct(SplFileInfo $file, Name $node)
    {
        $this->file = $file;
        $this->node = $node;
    }

    /**
     * Get the name of the symbol.
     *
     * @return string
     */
    public function getName(): string
    {
        return $this->node->__toString();
    }

    /**
     * Get the path of the file in which the symbol is encountered.
     *
     * @return string
     */
    public function getFile(): string
    {
        return $this->file->getRealPath();
    }

    /**
     * Get the line on which the symbol is encountered.
     *
     * @return int
     */
    public function getLine(): int
    {
        return $this->node->getLine();
    }

    /**
     * Specify data that should be serialized to JSON.
     *
     * @return array
     */
    public function jsonSerialize(): array
    {
        return [
            'name' => $this->getName(),
            'file' => $this->getFile(),
            'line' => $this->getLine()
        ];
    }

    /**
     * Convert the symbol to a string.
     *
     * @return string
     */
    public function __toString(): string
    {
        return $this->getName();
    }
}