php-di/phpdoc-reader

PhpDocReader parses @var and @param values in PHP docblocks (supports namespaced class names with the same resolution rules as PHP)

Sunday, February 18, 2018
by mnapoli
Repository
1 Watchers
37 Stars
1,455,953 Installations

PHP
17 Dependents
2 Suggesters
8 Forks
4 Open issues
9 Versions
13 % Grown

The README.md

PhpDocReader

, _(*1)

This project is used by:, _(*2)

Fork the README to add your project here., _(*3)

Features

PhpDocReader parses @var and @param values in PHP docblocks:, _(*4)


use My\Cache\Backend;

class Cache
{
    /**
     * @var Backend
     */
    protected $backend;

    /**
     * @param Backend $backend
     */
    public function __construct($backend)
    {
    }
}

It supports namespaced class names with the same resolution rules as PHP:, _(*5)

fully qualified name (starting with \)
imported class name (eg. use My\Cache\Backend;)
relative class name (from the current namespace, like SubNamespace\MyClass)
aliased class name (eg. use My\Cache\Backend as FooBar;)

Primitive types (@var string) are ignored (returns null), only valid class names are returned., _(*6)

Usage

$reader = new PhpDocReader();

// Read a property type (@var phpdoc)
$property = new ReflectionProperty($className, $propertyName);
$propertyClass = $reader->getPropertyClass($property);

// Read a parameter type (@param phpdoc)
$parameter = new ReflectionParameter([$className, $methodName], $parameterName);
$parameterClass = $reader->getParameterClass($parameter);