PHP 클래스 yii\apidoc\models\BaseDoc

부터: 2.0
저자: Carsten Brandt ([email protected])
상속: extends yii\base\Object
파일 보기 프로젝트 열기: yiisoft/yii2-apidoc 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$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[]