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

namespace yii\apidoc\models;

10 11 12
use phpDocumentor\Reflection\DocBlock\Tag\ParamTag;
use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag;

13
/**
14
 * Represents API documentation information for an `event`.
15 16 17 18
 *
 * @author Carsten Brandt <mail@cebe.cc>
 * @since 2.0
 */
19
class EventDoc extends ConstDoc
20
{
21 22 23 24 25
	public $type;
	public $types;

	/**
	 * @param \phpDocumentor\Reflection\ClassReflector\ConstantReflector $reflector
26
	 * @param Context $context
27 28
	 * @param array $config
	 */
29
	public function __construct($reflector = null, $context = null, $config = [])
30
	{
31
		parent::__construct($reflector, $context, $config);
32 33 34 35 36

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

AlexGx committed
37
		foreach ($this->tags as $i => $tag) {
38 39 40 41 42 43 44 45 46 47 48 49 50 51
			if ($tag->getName() == 'event') {
				$eventTag = new ReturnTag('event', $tag->getContent(), $tag->getDocBlock(), $tag->getLocation());
				$this->type = $eventTag->getType();
				$this->types = $eventTag->getTypes();
				$this->description = ucfirst($eventTag->getDescription());
				if (($pos = strpos($this->description, '.')) !== false) {
					$this->shortDescription = substr($this->description, 0, $pos);
				} else {
					$this->shortDescription = $this->description;
				}
				unset($this->tags[$i]);
			}
		}
	}
AlexGx committed
52
}