<?php

declare(strict_types=1);

/**
 * Hoa
 *
 *
 * @license
 *
 * New BSD License
 *
 * Copyright © 2007-2017, Hoa community. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Hoa nor the names of its contributors may be
 *       used to endorse or promote products derived from this software without
 *       specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

namespace Kitab\Compiler\IntermediateRepresentation;

/**
 * An interface intermediate representation.
 *
 * An interface is one of the major entity in PHP. It exposes methods. An
 * interface can inherit from other interfaces.
 *
 * # Examples
 *
 * In this example, a new interface `I` is built, with 1 method: `f`.
 *
 * ```php
 * $interface            = new Kitab\Compiler\IntermediateRepresentation\Interface_('I');
 * $interface->methods[] = new Kitab\Compiler\IntermediateRepresentation\Method('f');
 * ```
 */
class Interface_ extends Entity implements HasMethods
{
    /**
     * Type of the entity. See parent.
     */
    const TYPE = 'interface';

    /**
     * Collection of fully-qualified names of the interfaces it extends if any.
     */
    public $parents = [];

    /**
     * Collection of `Kitab\Compiler\IntermediateRepresentation\Method` instances.
     */
    public $methods = [];

    /**
     * Allocate an interface with a fully-qualified name. This is the only
     * mandatory information.
     */
    public function __construct(string $name)
    {
        $this->name = $name;
    }

    /**
     * Return all methods declared for this entity.
     */
    public function getMethods(): array
    {
        return $this->methods;
    }
}