Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 780 Commits
.github		.github
examples		examples
src		src
tests		tests
.gitattributes		.gitattributes
.gitignore		.gitignore
.yamllint.yaml		.yamllint.yaml
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
composer-require-checker.json		composer-require-checker.json
composer.json		composer.json
composer.lock		composer.lock
phive.xml		phive.xml
phpcs.xml.dist		phpcs.xml.dist
phpmd.xml.dist		phpmd.xml.dist
phpstan.neon		phpstan.neon
phpunit.xml.dist		phpunit.xml.dist
psalm.xml		psalm.xml

Repository files navigation

ReflectionDocBlock

Introduction

The ReflectionDocBlock component of phpDocumentor provides a DocBlock parserthat is 100% compatible with thePHPDoc standard.

With this component, a library can provide support for annotations via DocBlocksor otherwise retrieve information that is embedded in a DocBlock.

Installation

composer require phpdocumentor/reflection-docblock

Usage

In order to parse the DocBlock one needs a DocBlockFactory that can beinstantiated using itscreateInstance factory method like this:

$factory  = \phpDocumentor\Reflection\DocBlockFactory::createInstance();

Then we can use thecreate method of the factory to interpret the DocBlock.Please note that it is also possible to provide a class that has thegetDocComment() method, such as an object of typeReflectionClass, thecreate method will read that if it exists.

$docComment =<<<DOCCOMMENT/** * This is an example of a summary. * * This is a Description. A Summary and Description are separated by either * two subsequent newlines (thus a whiteline in between as can be seen in this * example), or when the Summary ends with a dot (`.`) and some form of * whitespace. */DOCCOMMENT;$docblock =$factory->create($docComment);

Thecreate method will yield an object of type\phpDocumentor\Reflection\DocBlockwhose methods can be queried:

// Contains the summary for this DocBlock$summary =$docblock->getSummary();// Contains \phpDocumentor\Reflection\DocBlock\Description object$description =$docblock->getDescription();// You can either cast it to string$description = (string)$docblock->getDescription();// Or use the render method to get a string representation of the Description.$description =$docblock->getDescription()->render();