mfn/docblock-normalize

Extracts doc blocks and normalizes the references classes based on the current namespace and use-aliases

Docblock Type Normalizer

Homepage: https://github.com/mfn/php-docblock-normalize, _(*1)

Blurb

This library extracts docblocks from source files and normalizes all type descriptions within. That is, they're turned into full qualified symbol names taking the current namespace and use-aliases into consideration., _(*2)

Requirements

PHP 5.6, _(*3)

Install

Using composer: composer.phar require mfn/docblock-normalize 0.1, _(*4)

Example

sample.php:, _(*5)

<?php namespace Foo;
use Bar as Baz;
/**
 * @param Foo $param1
 * @param Bar $param2
 * @param Baz $param3
 * @param \Foo $param4
 * @param string $param5
 */

Parse and output the docblock with its types normalized:, _(*6)

$parser = new \Mfn\DocblockNormalize\Parser(
    new \Mfn\DocblockNormalize\TokenParser
);

$docblocks = $parser->parseFile('sample.php');

echo $docblocks[0]->getNormalizedContent();

Will return:, _(*7)

/**
 * @param Foo\Foo $param1
 * @param Foo\Bar $param2
 * @param Bar $param3
 * @param Foo $param4
 * @param string $param5
 */

Note: namespace and use statements for the docblock must appear before it!, _(*8)

Note 2: the normalization also removes leading backslashes, this is expected!, _(*9)

Contribute

Fork it, hack on a feature branch, create a pull request, be awesome!, _(*10)

No developer is an island so adhere to these standards:, _(*11)

• PSR 4 Autoloader
• PSR 2 Coding Style Guide
• PSR 1 Coding Standards

© Markus Fischer markus@fischer.name, _(*12)