You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
51 lines
1.3 KiB
51 lines
1.3 KiB
11 years ago
|
<?php
|
||
|
/**
|
||
|
* @link http://www.yiiframework.com/
|
||
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
||
|
* @license http://www.yiiframework.com/license/
|
||
|
*/
|
||
|
|
||
|
namespace yii\apidoc\models;
|
||
|
|
||
11 years ago
|
use phpDocumentor\Reflection\DocBlock\Tag\ParamTag;
|
||
|
use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag;
|
||
|
|
||
11 years ago
|
/**
|
||
11 years ago
|
* Represents API documentation information for an `event`.
|
||
11 years ago
|
*
|
||
|
* @author Carsten Brandt <mail@cebe.cc>
|
||
|
* @since 2.0
|
||
|
*/
|
||
11 years ago
|
class EventDoc extends ConstDoc
|
||
11 years ago
|
{
|
||
11 years ago
|
public $type;
|
||
|
public $types;
|
||
|
|
||
|
/**
|
||
|
* @param \phpDocumentor\Reflection\ClassReflector\ConstantReflector $reflector
|
||
|
* @param array $config
|
||
|
*/
|
||
|
public function __construct($reflector = null, $config = [])
|
||
|
{
|
||
|
parent::__construct($reflector, $config);
|
||
|
|
||
|
if ($reflector === null) {
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
foreach($this->tags as $i => $tag) {
|
||
|
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]);
|
||
|
}
|
||
|
}
|
||
|
}
|
||
11 years ago
|
}
|