MontealegreLuis / phuml

src/Graphviz/Builders/ClassGraphBuilder.php

<?php declare(strict_types=1);
/**
 * This source file is subject to the license that is bundled with this package in the file LICENSE.
 */

namespace PhUml\Graphviz\Builders;

use PhUml\Code\ClassDefinition;
use PhUml\Code\Codebase;
use PhUml\Graphviz\Edge;
use PhUml\Graphviz\HasDotRepresentation;
use PhUml\Graphviz\Node;

/**
 * It produces the collection of nodes and edges related to a class
 *
 * - It creates an edge with the class it extends, if any,
 * - It creates edges from the interfaces it implements
 * - It creates a node with the class itself
 * - It, optionally, discovers associations between classes/interfaces, by inspecting both:
 *   - The class properties
 *   - The class constructor's parameters
 */
final class ClassGraphBuilder
{
    /** @var HasDotRepresentation[] */
    private array $dotElements;

    private readonly EdgesBuilder $associationsBuilder;

    public function __construct(EdgesBuilder $associationsBuilder)
    {
        $this->dotElements = [];
        $this->associationsBuilder = $associationsBuilder;

The property associationsBuilder is declared read-only in PhUml\Graphviz\Builders\ClassGraphBuilder.

    }

    /**
     * The order in which the nodes and edges are created is as follows
     *
     * 1. The edges discovered via properties inspection
     * 2. The edges discovered via the constructor parameters
     * 3. The node representing the class itself
     * 4. The parent class, if any
     * 5. The interfaces it implements, if any
     *
     * @return HasDotRepresentation[]
     */
    public function extractFrom(ClassDefinition $class, Codebase $codebase): array
    {
        $this->dotElements = [];

        $this->addAssociations($this->associationsBuilder->fromProperties($class, $codebase));
        $this->addAssociations($this->associationsBuilder->fromConstructor($class, $codebase));

        $this->dotElements[] = new Node($class);

        if ($class->hasParent()) {
            $this->dotElements[] = Edge::inheritance($codebase->get($class->parent()), $class);
        }

        foreach ($class->interfaces() as $interface) {
            $this->dotElements[] = Edge::implementation($codebase->get($interface), $class);
        }

        foreach ($class->traits() as $trait) {
            $this->dotElements[] = Edge::use($codebase->get($trait), $class);
        }

        return $this->dotElements;
    }

    /** @param Edge[] $edges */
    private function addAssociations(array $edges): void
    {
        $this->dotElements = array_merge($this->dotElements, $edges);
    }
}