MontealegreLuis / phuml

src/Code/InterfaceDefinition.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\Code;

use PhUml\Code\Methods\Method;
use PhUml\Code\Properties\Constant;
use PhUml\Code\Properties\HasConstants;
use PhUml\Code\Properties\WithConstants;

/**
 * It represents an interface definition
 */
final class InterfaceDefinition extends Definition implements HasConstants
{
    use WithConstants;

    /** @var Name[] */
    private readonly array $parents;

    /**
     * @param Method[] $methods
     * @param Constant[] $constants
     * @param Name[] $parents
     */
    public function __construct(
        Name $name,
        array $methods = [],
        array $constants = [],
        array $parents = []
    ) {
        parent::__construct($name, $methods);
        $this->constants = $constants;
        $this->parents = $parents;

The property parents is declared read-only in PhUml\Code\InterfaceDefinition.

    }

    /**
     * It is used by the `InterfaceGraphBuilder` to create the edge to represent inheritance
     *
     * @return Name[]
     * @see \PhUml\Graphviz\Builders\InterfaceGraphBuilder::extractFrom() for more details
     */
    public function parents(): array
    {
        return $this->parents;
    }

    /**
     * It is used by the `InterfaceGraphBuilder` to determine if an inheritance association should be
     * created
     *
     * @see \PhUml\Graphviz\Builders\InterfaceGraphBuilder::extractFrom() for more details
     */
    public function hasParent(): bool
    {
        return $this->parents !== [];
    }

    /**
     * This method is used when the commands are called with the option `hide-empty-blocks`
     *
     * It only counts the constants of an interface, since interfaces are not allowed to have
     * properties
     *
     * @see Definition::hasProperties() for more details
     */
    public function hasProperties(): bool
    {
        return $this->constants !== [];
    }
}