Class yii\apidoc\models\EventDoc
Inheritance | yii\apidoc\models\EventDoc » yii\apidoc\models\ConstDoc » yii\apidoc\models\BaseDoc » yii\base\Object |
---|---|
Available since extension's version | 2.0 |
Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/models/EventDoc.php |
Represents API documentation information for an event
.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$definedBy | yii\apidoc\models\ConstDoc | ||
$deprecatedReason | yii\apidoc\models\BaseDoc | ||
$deprecatedSince | yii\apidoc\models\BaseDoc | ||
$description | yii\apidoc\models\BaseDoc | ||
$endLine | yii\apidoc\models\BaseDoc | ||
$name | yii\apidoc\models\BaseDoc | ||
$phpDocContext | \phpDocumentor\Reflection\DocBlock\Context | yii\apidoc\models\BaseDoc | |
$shortDescription | yii\apidoc\models\BaseDoc | ||
$since | yii\apidoc\models\BaseDoc | ||
$sourceFile | yii\apidoc\models\BaseDoc | ||
$startLine | yii\apidoc\models\BaseDoc | ||
$tags | \phpDocumentor\Reflection\DocBlock\Tag[] | yii\apidoc\models\BaseDoc | |
$type | yii\apidoc\models\EventDoc | ||
$types | yii\apidoc\models\EventDoc | ||
$value | yii\apidoc\models\ConstDoc |
Public Methods
Method | Description | Defined By |
---|---|---|
__construct() | yii\apidoc\models\EventDoc | |
extractFirstSentence() | Extracts first sentence out of text | yii\apidoc\models\BaseDoc |
getFirstTag() | Get the first tag of a given name | yii\apidoc\models\BaseDoc |
hasTag() | Checks if doc has tag of a given name | yii\apidoc\models\BaseDoc |
removeTag() | Removes tag of a given name | yii\apidoc\models\BaseDoc |
Protected Methods
Method | Description | Defined By |
---|---|---|
mbUcFirst() | Multibyte version of ucfirst() | yii\apidoc\models\BaseDoc |
Property Details
Method Details
public void __construct ( $reflector = null, $context = null, $config = [] ) | ||
$reflector | \phpDocumentor\Reflection\ClassReflector\ConstantReflector | |
$context | yii\apidoc\models\Context | |
$config | array |
public function __construct($reflector = null, $context = null, $config = [])
{
parent::__construct($reflector, $context, $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 = static::mbUcFirst($eventTag->getDescription());
$this->shortDescription = BaseDoc::extractFirstSentence($this->description);
unset($this->tags[$i]);
}
}
}
Defined in: yii\apidoc\models\BaseDoc::extractFirstSentence()
Extracts first sentence out of text
public static string extractFirstSentence ( $text ) | ||
$text | string |
public static function extractFirstSentence($text)
{
if (mb_strlen($text, 'utf-8') > 4 && ($pos = mb_strpos($text, '.', 4, 'utf-8')) !== false) {
$sentence = mb_substr($text, 0, $pos + 1, 'utf-8');
if (mb_strlen($text, 'utf-8') >= $pos + 3) {
$abbrev = mb_substr($text, $pos - 1, 4, 'utf-8');
if ($abbrev === 'e.g.' || $abbrev === 'i.e.') { // do not break sentence after abbreviation
$sentence .= static::extractFirstSentence(mb_substr($text, $pos + 1, mb_strlen($text, 'utf-8'), 'utf-8'));
}
}
return $sentence;
} else {
return $text;
}
}
Defined in: yii\apidoc\models\BaseDoc::getFirstTag()
Get the first tag of a given name
public \phpDocumentor\Reflection\DocBlock\Tag getFirstTag ( $name ) | ||
$name | string |
public function getFirstTag($name)
{
foreach ($this->tags as $i => $tag) {
if (strtolower($tag->getName()) == $name) {
return $this->tags[$i];
}
}
}
Defined in: yii\apidoc\models\BaseDoc::hasTag()
Checks if doc has tag of a given name
public boolean hasTag ( $name ) | ||
$name | string |
Tag name |
return | boolean |
If doc has tag of a given name |
---|
public function hasTag($name)
{
foreach ($this->tags as $tag) {
if (strtolower($tag->getName()) == $name) {
return true;
}
}
return false;
}
Defined in: yii\apidoc\models\BaseDoc::mbUcFirst()
Multibyte version of ucfirst()
protected static void mbUcFirst ( $string ) | ||
$string |
protected static function mbUcFirst($string)
{
$firstChar = mb_strtoupper(mb_substr($string, 0, 1, 'utf-8'), 'utf-8');
return $firstChar . mb_substr($string, 1, mb_strlen($string, 'utf-8'), 'utf-8');
}
Defined in: yii\apidoc\models\BaseDoc::removeTag()
Removes tag of a given name
public void removeTag ( $name ) | ||
$name | string |
public function removeTag($name)
{
foreach ($this->tags as $i => $tag) {
if (strtolower($tag->getName()) == $name) {
unset($this->tags[$i]);
}
}
}