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

8
namespace yii\apidoc\models;
9 10 11 12

/**
 * Class ClassDoc
 */
13
class ClassDoc extends TypeDoc
14 15 16 17 18 19 20 21
{
	public $parentClass;

	public $isAbstract;
	public $isFinal;

	public $interfaces = [];
	public $traits = [];
22 23
	// will be set by Context::updateReferences()
	public $subclasses = [];
24

25 26 27
	/**
	 * @var EventDoc[]
	 */
28
	public $events = [];
29 30 31
	/**
	 * @var ConstDoc[]
	 */
32 33 34 35 36 37 38
	public $constants = [];


	/**
	 * @param \phpDocumentor\Reflection\ClassReflector $reflector
	 * @param array $config
	 */
39
	public function __construct($reflector, $config = [])
40
	{
41
		parent::__construct($reflector, $config);
42 43 44 45 46 47 48 49 50 51 52 53 54 55

		$this->parentClass = ltrim($reflector->getParentClass(), '\\');
		if (empty($this->parentClass)) {
			$this->parentClass = null;
		}
		$this->isAbstract = $reflector->isAbstract();
		$this->isFinal = $reflector->isFinal();

		foreach($reflector->getInterfaces() as $interface) {
			$this->interfaces[] = ltrim($interface, '\\');
		}
		foreach($reflector->getTraits() as $trait) {
			$this->traits[] = ltrim($trait, '\\');
		}
56 57 58 59
		foreach($reflector->getConstants() as $constantReflector) {
			if (strncmp($constantReflector->getShortName(), 'EVENT_', 6) == 0) {
				$event = new EventDoc($constantReflector);
				$event->definedBy = $this->name;
60
				$this->events[$event->name] = $event;
61 62 63
			} else {
				$constant = new ConstDoc($constantReflector);
				$constant->definedBy = $this->name;
64
				$this->constants[$constant->name] = $constant;
65 66
			}
		}
67 68
	}
}