PHP Class yii\apidoc\models\BaseDoc

Since: 2.0
Author: Carsten Brandt ([email protected])
Inheritance: extends yii\base\Object
Afficher le fichier Open project: yiisoft/yii2-apidoc Class Usage Examples

Méthodes publiques

Свойство Type Description
$deprecatedReason
$deprecatedSince
$description
$endLine
$name
$phpDocContext phpDocumentor\Reflection\DocBlock\Context
$shortDescription
$since
$sourceFile
$startLine
$tags phpDocumentor\Reflection\DocBlock\Tag[]

Méthodes publiques

Méthode Description
__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

Méthodes protégées

Méthode Description
mbUcFirst ( $string ) Multibyte version of ucfirst()

Method Details

__construct() public méthode

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

extractFirstSentence() public static méthode

Extracts first sentence out of text
public static extractFirstSentence ( string $text ) : string
$text string
Résultat string

getFirstTag() public méthode

Get the first tag of a given name
Since: 2.0.5
public getFirstTag ( string $name ) : Tag
$name string
Résultat phpDocumentor\Reflection\DocBlock\Tag

hasTag() public méthode

Checks if doc has tag of a given name
public hasTag ( string $name ) : boolean
$name string tag name
Résultat boolean if doc has tag of a given name

mbUcFirst() protected static méthode

Multibyte version of ucfirst()
Since: 2.0.6
protected static mbUcFirst ( $string )

removeTag() public méthode

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

Property Details

$deprecatedReason public_oe property

public $deprecatedReason

$deprecatedSince public_oe property

public $deprecatedSince

$description public_oe property

public $description

$endLine public_oe property

public $endLine

$name public_oe property

public $name

$phpDocContext public_oe property

public Context,phpDocumentor\Reflection\DocBlock $phpDocContext
Résultat phpDocumentor\Reflection\DocBlock\Context

$shortDescription public_oe property

public $shortDescription

$since public_oe property

public $since

$sourceFile public_oe property

public $sourceFile

$startLine public_oe property

public $startLine

$tags public_oe property

public Tag[],phpDocumentor\Reflection\DocBlock $tags
Résultat phpDocumentor\Reflection\DocBlock\Tag[]