barryvdh/reflection-docblock

v2.3.0 2024-12-30 10:35 UTC

Requires

• php: >=7.1

Requires (Dev)

• phpunit/phpunit: ^8.5.14|^9

Suggests

• dflydev/markdown: ~1.0
• erusev/parsedown: ~1.0

MIT

• Mike van Riel

README

This is a fork of phpDocumentor/ReflectionDocBlock 2.x combined with bits of phpDocumentor/TypeResolver and various tweaks. The main reason for this fork is to add functionality for https://github.com/barryvdh/laravel-ide-helper Any other use of this library is discouraged. You are probably better of using https://github.com/phpDocumentor/ReflectionDocBlock directly.

Introduction

The ReflectionDocBlock component of phpDocumentor provides a DocBlock parser that is 100% compatible with the PHPDoc standard.

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

Note: this is a core component of phpDocumentor and is constantly being optimized for performance.

Installation

You can install the component in the following ways:

• Use the official Github repository (https://github.com/phpDocumentor/ReflectionDocBlock)
• Via Composer (http://packagist.org/packages/phpdocumentor/reflection-docblock)

Usage

The ReflectionDocBlock component is designed to work in an identical fashion to PHP's own Reflection extension (http://php.net/manual/en/book.reflection.php).

Parsing can be initiated by instantiating the \phpDocumentor\Reflection\DocBlock() class and passing it a string containing a DocBlock (including asterisks) or by passing an object supporting the getDocComment() method.

Examples of objects having the getDocComment() method are the ReflectionClass and the ReflectionMethod classes of the PHP Reflection extension

Example:

$class = new ReflectionClass('MyClass');
$phpdoc = new \phpDocumentor\Reflection\DocBlock($class);

or

$docblock = <<<DOCBLOCK
/**
 * This is a short description.
 *
 * This is a *long* description.
 *
 * @return void
 */
DOCBLOCK;

$phpdoc = new \phpDocumentor\Reflection\DocBlock($docblock);