barryvdh / reflection-docblock
Requires
- php: >=5.3.3
Requires (Dev)
- phpunit/phpunit: ^8.5.14|^9
Suggests
- dflydev/markdown: ~1.0
- erusev/parsedown: ~1.0
This package is auto-updated.
Last update: 2024-07-06 20:36:12 UTC
README
The ReflectionDocBlock Component ![Build Status](https://camo.githubusercontent.com/248244440447665c42ee480443ba56f51cc45593a24d692ba2feb19ca026de0e/68747470733a2f2f7365637572652e7472617669732d63692e6f72672f706870446f63756d656e746f722f5265666c656374696f6e446f63426c6f636b2e706e67)
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 theReflectionClass
and theReflectionMethod
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);