InterfaceDoc.php 1.13 KB
Newer Older
1 2
<?php
/**
3 4 5
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
6 7
 */

8
namespace yii\apidoc\models;
9

10
/**
11
 * Represents API documentation information for an `interface`.
12 13 14 15
 *
 * @author Carsten Brandt <mail@cebe.cc>
 * @since 2.0
 */
16
class InterfaceDoc extends TypeDoc
17
{
18 19 20 21
    public $parentInterfaces = [];
    // will be set by Context::updateReferences()
    public $implementedBy = [];

22

23 24
    /**
     * @param \phpDocumentor\Reflection\InterfaceReflector $reflector
25 26
     * @param Context $context
     * @param array $config
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
     */
    public function __construct($reflector = null, $context = null, $config = [])
    {
        parent::__construct($reflector, $context, $config);

        if ($reflector === null) {
            return;
        }

        foreach ($reflector->getParentInterfaces() as $interface) {
            $this->parentInterfaces[] = ltrim($interface, '\\');
        }

        foreach ($this->methods as $method) {
            $method->isAbstract = true;
        }

        // interface can not have properties
        $this->properties = null;
    }
AlexGx committed
47
}