AbstractHierarchicalObject.php

<?php declare(strict_types=1);
/*
 * This file is part of "irstea/ng-model-generator-bundle".
 *
 * "irstea/ng-model-generator-bundle" generates Typescript interfaces for Angular using api-platform metadata.
 * Copyright (C) 2018 IRSTEA
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any
 * later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License and the GNU
 * Lesser General Public License along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */

namespace Irstea\NgModelGeneratorBundle\Models\Types\Objects;

use Irstea\NgModelGeneratorBundle\Models\Declaration;
use Irstea\NgModelGeneratorBundle\Models\DeclarationTrait;
use Irstea\NgModelGeneratorBundle\Models\Types\Type;
use Irstea\NgModelGeneratorBundle\TypescriptHelper;

/**
 * Class AbstractHierarchicalObject.
 */
abstract class AbstractHierarchicalObject extends AnonymousObject implements Declaration
{
    use DeclarationTrait;

    /** @var Type|null */
    protected $parent;

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

    /**
     * ObjectClass constructor.
     *
     * @param string     $name
     * @param Type|null  $parent
     * @param Property[] $properties
     * @param string     $description
     * @param array      $children
     */
    public function __construct(string $name, ?Type $parent, array $properties = [], string $description = '', array $children = [])
    {
        parent::__construct($properties);

        $this->name = $name;
        $this->description = $description;
        $this->parent = $parent;
        $this->children = $children;
    }

    /**
     * {@inheritdoc}
     */
    final protected function getDeclarationHeader(): string
    {
        $parts = [];

        $comment = $this->getComment();