• 홈
• phpDocumentor
• Reflection
• DocBlock

PHP 클래스 phpDocumentor\Reflection\DocBlock

파일 보기 프로젝트 열기: explodybits/hookr-plugin 1 사용 예제들

보호된 프로퍼티들

프로퍼티	타입	설명
$context		Information about the context of this DocBlock.
$location		Information about the location of this DocBlock.
$long_description		The actual description for this docblock.
$short_description		The opening line for this docblock.
$tags		An array containing all the tags in this docblock; except inline.

공개 메소드들

메소드	설명
__construct ( Reflector | string $docblock, phpDocumentor\Reflection\DocBlock\Context $context = null, phpDocumentor\Reflection\DocBlock\Location $location = null )	Parses the given docblock and populates the member fields.
__toString ( ) : string	Returns the exported information (we should use the export static method BUT this throws an exception at this point).
appendTag ( Tag $tag ) : Tag	Appends a tag at the end of the list of tags.
export ( ) : string	Builds a string representation of this object.
getContext ( ) : phpDocumentor\Reflection\DocBlock\Context	Returns the current context.
getLocation ( ) : phpDocumentor\Reflection\DocBlock\Location	Returns the current location.
getLongDescription ( ) : Description	Returns the full description or also known as long description.
getShortDescription ( ) : string	Returns the opening line or also known as short description.
getTags ( ) : Tag[]	Returns the tags for this DocBlock.
getTagsByName ( string $name ) : Tag[]	Returns an array of tags matching the given name. If no tags are found an empty array is returned.
hasTag ( string $name ) : boolean	Checks if a tag of a certain type is present in this DocBlock.

보호된 메소드들

메소드	설명
cleanInput ( string $comment ) : string	Strips the asterisks from the DocBlock comment.
parseTags ( string $tags ) : void	Creates the tag objects.
splitDocBlock ( string $comment ) : string[]	Splits the DocBlock into a short description, long description and block of tags.

메소드 상세

프로퍼티 상세