phpDocumentor\Reflection\DocBlock Class Reference

Public Member Functions
	__construct (string $summary='', ?DocBlock\Description $description=null, array $tags=[], ?Types\Context $context=null, ?Location $location=null, bool $isTemplateStart=false, bool $isTemplateEnd=false)
	getSummary ()
	getDescription ()
	getContext ()
	getLocation ()
	isTemplateStart ()
	isTemplateEnd ()
	getTags ()
	getTagsByName (string $name)
	hasTag (string $name)
	removeTag (Tag $tagToRemove)

Constructor & Destructor Documentation

__construct()

phpDocumentor\Reflection\DocBlock::__construct	(	string	$summary = '',
		?DocBlock\Description	$description = null,
		array	$tags = [],
		?Types\Context	$context = null,
		?Location	$location = null,
		bool	$isTemplateStart = false,
		bool	$isTemplateEnd = false
	)

Parameters

DocBlock\Tag[]	$tags
Types\Context	$context	The context in which the DocBlock occurs.
Location	$location	The location within the file that this DocBlock occurs in.

Member Function Documentation

getContext()

phpDocumentor\Reflection\DocBlock::getContext

(

)

Returns the current context.

getLocation()

phpDocumentor\Reflection\DocBlock::getLocation

(

)

Returns the current location.

getTags()

phpDocumentor\Reflection\DocBlock::getTags

(

)

Returns the tags for this DocBlock.

Returns

Tag[]

getTagsByName()

phpDocumentor\Reflection\DocBlock::getTagsByName

(

string

$name

)

Returns an array of tags matching the given name. If no tags are found an empty array is returned.

Parameters

string

$name

String to search by.

Returns

Tag[]

hasTag()

phpDocumentor\Reflection\DocBlock::hasTag

(

string

$name

)

Checks if a tag of a certain type is present in this DocBlock.

Parameters

string

$name

Tag name to check for.

isTemplateEnd()

phpDocumentor\Reflection\DocBlock::isTemplateEnd

(

)

Returns whether this DocBlock is the end of a Template section.

See also

self::isTemplateStart() for a more complete description of the Docblock Template functionality.

isTemplateStart()

phpDocumentor\Reflection\DocBlock::isTemplateStart

(

)

Returns whether this DocBlock is the start of a Template section.

A Docblock may serve as template for a series of subsequent DocBlocks. This is indicated by a special marker (#@+) that is appended directly after the opening /** of a DocBlock.

An example of such an opening is:

The description and tags (not the summary!) are copied onto all subsequent DocBlocks and also applied to all elements that follow until another DocBlock is found that contains the closing marker (#@-).

See also

self::isTemplateEnd() for the check whether a closing marker was provided.

removeTag()

phpDocumentor\Reflection\DocBlock::removeTag

(

Tag

$tagToRemove

)

Remove a tag from this DocBlock.

Parameters

Tag

$tagToRemove

The tag to remove.

---

The documentation for this class was generated from the following file:

• vendor/phpdocumentor/reflection-docblock/src/DocBlock.php