PHP Class yii\apidoc\models\BaseDoc

Since: 2.0

Author: Carsten Brandt ([email protected])

Inheritance: extends yii\base\Object

Exibir arquivo Open project: yiisoft/yii2-apidoc Class Usage Examples

Public Properties

Property	Type	Description
$deprecatedReason
$deprecatedSince
$description
$endLine
$name
$phpDocContext	phpDocumentor\Reflection\DocBlock\Context
$shortDescription
$since
$sourceFile
$startLine
$tags	phpDocumentor\Reflection\DocBlock\Tag[]

Public Methods

Method	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

Protected Methods

Method	Description
mbUcFirst ( $string )	Multibyte version of ucfirst()

Method Details

__construct() public method

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

extractFirstSentence() public static method

Extracts first sentence out of text

public static extractFirstSentence ( string $text ) : string
$text	string
return	string

getFirstTag() public method

Get the first tag of a given name

Since: 2.0.5

public getFirstTag ( string $name ) : Tag
$name	string
return	phpDocumentor\Reflection\DocBlock\Tag

hasTag() public method

Checks if doc has tag of a given name

public hasTag ( string $name ) : boolean
$name	string	tag name
return	boolean	if doc has tag of a given name

mbUcFirst() protected static method

Multibyte version of ucfirst()

Since: 2.0.6

protected static mbUcFirst ( $string )

removeTag() public method

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
return	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
return	phpDocumentor\Reflection\DocBlock\Tag[]