PHP 클래스 phpDocumentor\Reflection\DocBlock\Tag

링크 보기: http://phpdoc.org
저자: Mike van Riel ([email protected])
상속: implements Reflector
파일 보기 프로젝트 열기: explodybits/hookr-plugin 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$content Content of the tag. When set to NULL, it means it needs to be regenerated.
$description Description of the content of this tag
$docblock The DocBlock which this tag belongs to.
$location Location of the tag.
$parsedDescription The description, as an array of strings and Tag objects. When set to NULL, it means it needs to be regenerated.
$tag Name of the tag

공개 메소드들

메소드 설명
__construct ( string $name, string $content, DocBlock $docblock = null, phpDocumentor\Reflection\DocBlock\Location $location = null ) Parses a tag and populates the member variables.
__toString ( ) : string Returns the exported information (we should use the export static method BUT this throws an exception at this point).
createInstance ( string $tag_line, DocBlock $docblock = null, phpDocumentor\Reflection\DocBlock\Location $location = null ) : static Factory method responsible for instantiating the correct sub type.
export ( ) : void Builds a string representation of this object.
getContent ( ) : string Gets the content of this tag.
getDescription ( ) : string Gets the description component of this tag.
getDocBlock ( ) : DocBlock Gets the docblock this tag belongs to.
getLocation ( ) : phpDocumentor\Reflection\DocBlock\Location Gets the location of the tag.
getName ( ) : string Gets the name of this tag.
getParsedDescription ( ) : array Gets the parsed text of this description.
registerTagHandler ( string $tag, string | null $handler ) : boolean Registers a handler for tags.
setContent ( string $content ) Sets the content of this tag.
setDescription ( string $description ) Sets the description component of this tag.
setDocBlock ( DocBlock $docblock = null ) Sets the docblock this tag belongs to.
setLocation ( phpDocumentor\Reflection\DocBlock\Location $location = null ) Sets the location of the tag.
setName ( string $name ) Sets the name of this tag.

메소드 상세

__construct() 공개 메소드

Parses a tag and populates the member variables.
public __construct ( string $name, string $content, DocBlock $docblock = null, phpDocumentor\Reflection\DocBlock\Location $location = null )
$name string Name of the tag.
$content string The contents of the given tag.
$docblock phpDocumentor\Reflection\DocBlock The DocBlock which this tag belongs to.
$location phpDocumentor\Reflection\DocBlock\Location Location of the tag.

__toString() 공개 메소드

Returns the exported information (we should use the export static method BUT this throws an exception at this point).
public __toString ( ) : string
리턴 string

createInstance() 최종 공개 정적인 메소드

Factory method responsible for instantiating the correct sub type.
final public static createInstance ( string $tag_line, DocBlock $docblock = null, phpDocumentor\Reflection\DocBlock\Location $location = null ) : static
$tag_line string The text for this tag, including description.
$docblock phpDocumentor\Reflection\DocBlock The DocBlock which this tag belongs to.
$location phpDocumentor\Reflection\DocBlock\Location Location of the tag.
리턴 static A new tag object.

export() 공개 정적인 메소드

Builds a string representation of this object.
public static export ( ) : void
리턴 void

getContent() 공개 메소드

Gets the content of this tag.
public getContent ( ) : string
리턴 string

getDescription() 공개 메소드

Gets the description component of this tag.
public getDescription ( ) : string
리턴 string

getDocBlock() 공개 메소드

Gets the docblock this tag belongs to.
public getDocBlock ( ) : DocBlock
리턴 phpDocumentor\Reflection\DocBlock The docblock this tag belongs to.

getLocation() 공개 메소드

Gets the location of the tag.
public getLocation ( ) : phpDocumentor\Reflection\DocBlock\Location
리턴 phpDocumentor\Reflection\DocBlock\Location The tag's location.

getName() 공개 메소드

Gets the name of this tag.
public getName ( ) : string
리턴 string The name of this tag.

getParsedDescription() 공개 메소드

Gets the parsed text of this description.
public getParsedDescription ( ) : array
리턴 array An array of strings and tag objects, in the order they occur within the description.

registerTagHandler() 최종 공개 정적인 메소드

Registers a handler for tags. The class specified is autoloaded if it's not available. It must inherit from this class.
final public static registerTagHandler ( string $tag, string | null $handler ) : boolean
$tag string Name of tag to regiser a handler for. When registering a namespaced tag, the full name, along with a prefixing slash MUST be provided.
$handler string | null FQCN of handler. Specifing NULL removes the handler for the specified tag, if any.
리턴 boolean TRUE on success, FALSE on failure.

setContent() 공개 메소드

Sets the content of this tag.
public setContent ( string $content )
$content string The new content of this tag.

setDescription() 공개 메소드

Sets the description component of this tag.
public setDescription ( string $description )
$description string The new description component of this tag.

setDocBlock() 공개 메소드

Sets the docblock this tag belongs to.
public setDocBlock ( DocBlock $docblock = null )
$docblock phpDocumentor\Reflection\DocBlock The new docblock this tag belongs to. Setting NULL removes any association.

setLocation() 공개 메소드

Sets the location of the tag.
public setLocation ( phpDocumentor\Reflection\DocBlock\Location $location = null )
$location phpDocumentor\Reflection\DocBlock\Location The new location of the tag.

setName() 공개 메소드

Sets the name of this tag.
public setName ( string $name )
$name string The new name of this tag.

프로퍼티 상세

$content 보호되어 있는 프로퍼티

Content of the tag. When set to NULL, it means it needs to be regenerated.
protected $content

$description 보호되어 있는 프로퍼티

Description of the content of this tag
protected $description

$docblock 보호되어 있는 프로퍼티

The DocBlock which this tag belongs to.
protected $docblock

$location 보호되어 있는 프로퍼티

Location of the tag.
protected $location

$parsedDescription 보호되어 있는 프로퍼티

The description, as an array of strings and Tag objects. When set to NULL, it means it needs to be regenerated.
protected $parsedDescription

$tag 보호되어 있는 프로퍼티

Name of the tag
protected $tag