gossi/docblock

PHP Docblock parser and generator. An API to read and write Docblocks.

Docblock

, _(*1)

PHP Docblock parser and generator. An API to read and write Docblocks., _(*2)

WARNING: starting from version 4.0 the library has moved to phpowermove organization and the namespace is phpowermove\docblock., _(*3)

Installation

Install via Composer:, _(*4)

composer require phpowermove/docblock

Usage

1. Generate a Docblock instance

a) Simple:, _(*5)

use phpowermove\docblock\Docblock;

$docblock = new Docblock();

b) Create from string:, _(*6)

use phpowermove\docblock\Docblock;

$docblock = new Docblock('/**
 * Short Description.
 *
 * Long Description.
 *
 * @author gossi
 */');

c) Create from reflection:, _(*7)

use phpowermove\docblock\Docblock;

$docblock = new Docblock(new \ReflectionClass('MyClass'));

2. Manipulate tags

Get the tags:, _(*8)

$tags = $docblock->getTags();

Get tags by name:, _(*9)

$tags = $docblock->getTags('author');

Append a tag:, _(*10)

use phpowermove\docblock\tags\AuthorTag;

$author = new AuthorTag();
$author->setName('gossi');
$docblock->appendTag($author);

or with fluent API:, _(*11)

use phpowermove\docblock\tags\AuthorTag;

$docblock->appendTag(AuthorTag::create()
    ->setName('gossi')
);

Check tag existence:, _(*12)

$docblock->hasTag('author');

3. Get back the string

Call toString():, _(*13)

$docblock->toString();

or if you are in a write-context, the magical __toString() will take care of it:, _(*14)

echo $docblock;

Documentation Api

See https://phpowermove.github.io/docblock, _(*15)

Contributing

Feel free to fork and submit a pull request (don't forget the tests) and I am happy to merge., _(*16)

References

• This project uses the parsers from phpDocumentor/ReflectionDocBlock

Changelog

Refer to Releases, _(*17)