PHP Класс yii\apidoc\models\BaseDoc

С версии: 2.0
Автор: Carsten Brandt ([email protected])
Наследование: extends yii\base\Object
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$deprecatedReason
$deprecatedSince
$description
$endLine
$name
$phpDocContext phpDocumentor\Reflection\DocBlock\Context
$shortDescription
$since
$sourceFile
$startLine
$tags phpDocumentor\Reflection\DocBlock\Tag[]

Открытые методы

Метод Описание
__construct ( phpDocumentor\Reflection\BaseReflector $reflector = null, Context $context = null, array $config = [] )
extractFirstSentence ( string $text ) : string Extracts first sentence out of text
getFirstTag ( string $name ) : Tag Get the first tag of a given name
hasTag ( string $name ) : boolean Checks if doc has tag of a given name
removeTag ( string $name ) Removes tag of a given name

Защищенные методы

Метод Описание
mbUcFirst ( $string ) Multibyte version of ucfirst()

Описание методов

__construct() публичный Метод

public __construct ( phpDocumentor\Reflection\BaseReflector $reflector = null, Context $context = null, array $config = [] )
$reflector phpDocumentor\Reflection\BaseReflector
$context Context
$config array

extractFirstSentence() публичный статический Метод

Extracts first sentence out of text
public static extractFirstSentence ( string $text ) : string
$text string
Результат string

getFirstTag() публичный Метод

Get the first tag of a given name
С версии: 2.0.5
public getFirstTag ( string $name ) : Tag
$name string
Результат phpDocumentor\Reflection\DocBlock\Tag

hasTag() публичный Метод

Checks if doc has tag of a given name
public hasTag ( string $name ) : boolean
$name string tag name
Результат boolean if doc has tag of a given name

mbUcFirst() защищенный статический Метод

Multibyte version of ucfirst()
С версии: 2.0.6
protected static mbUcFirst ( $string )

removeTag() публичный Метод

Removes tag of a given name
public removeTag ( string $name )
$name string

Описание свойств

$deprecatedReason публичное свойство

public $deprecatedReason

$deprecatedSince публичное свойство

public $deprecatedSince

$description публичное свойство

public $description

$endLine публичное свойство

public $endLine

$name публичное свойство

public $name

$phpDocContext публичное свойство

public Context,phpDocumentor\Reflection\DocBlock $phpDocContext
Результат phpDocumentor\Reflection\DocBlock\Context

$shortDescription публичное свойство

public $shortDescription

$since публичное свойство

public $since

$sourceFile публичное свойство

public $sourceFile

$startLine публичное свойство

public $startLine

$tags публичное свойство

public Tag[],phpDocumentor\Reflection\DocBlock $tags
Результат phpDocumentor\Reflection\DocBlock\Tag[]