phpDocumentor\Reflection\DocBlockFactory Class Reference

Inheritance diagram for phpDocumentor\Reflection\DocBlockFactory:

Public Member Functions
	__construct (DescriptionFactory $descriptionFactory, TagFactory $tagFactory)
	create ($docblock, ?Types\Context $context=null, ?Location $location=null)
	registerTagHandler (string $tagName, string $handler)

Static Public Member Functions
static	createInstance (array $additionalTags=[])

Constructor & Destructor Documentation

__construct()

phpDocumentor\Reflection\DocBlockFactory::__construct	(	DescriptionFactory	$descriptionFactory,
		TagFactory	$tagFactory
	)

Initializes this factory with the required subcontractors.

Member Function Documentation

create()

phpDocumentor\Reflection\DocBlockFactory::create	(		$docblock,
		?Types\Context	$context = null,
		?Location	$location = null
	)

Parameters

object | string

$docblock

A string containing the DocBlock to parse or an object supporting the getDocComment method (such as a ReflectionClass object).

Implements phpDocumentor\Reflection\DocBlockFactoryInterface.

createInstance()

static phpDocumentor\Reflection\DocBlockFactory::createInstance ( array  $additionalTags = [] )

static

Factory method for easy instantiation.

Parameters

array<string,class-string<Tag>>

$additionalTags

Implements phpDocumentor\Reflection\DocBlockFactoryInterface.

registerTagHandler()

phpDocumentor\Reflection\DocBlockFactory::registerTagHandler	(	string	$tagName,
		string	$handler
	)

Parameters

class-string<Tag>

$handler

---

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

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