mpociot/reflection-docblock

Maintainers

Details

github.com/mpociot/reflection-docblock

Source

Issues

Installs: 9 897 322

Dependents: 57

Suggesters: 0

Security: 0

Stars: 86

Watchers: 3

Forks: 4

Open Issues: 1

1.0.1 2016-06-20 20:53 UTC

Requires

  • php: >=5.3.3

Requires (Dev)

Suggests

MIT c8b2e2b1f5cebbb06e2b5ccbf2958f2198867587

  • Mike van Riel <mike.vanriel.woop@naenius.com>

This package is auto-updated.

Last update: 2024-11-24 10:44:14 UTC

README

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:

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);