InterfaceDoc.php 909 Bytes
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
{
	public $parentInterfaces = [];

20
	// will be set by Context::updateReferences()
21 22 23 24 25 26
	public $implementedBy = [];

	/**
	 * @param \phpDocumentor\Reflection\InterfaceReflector $reflector
	 * @param array $config
	 */
27
	public function __construct($reflector = null, $config = [])
28
	{
29
		parent::__construct($reflector, $config);
30

31 32 33 34
		if ($reflector === null) {
			return;
		}

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

39 40
		// interface can not have properties
		$this->properties = null;
41 42
	}
}