php-di/phpdoc-reader

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

2.2.1 2020-10-12 12:39 UTC

Requires

• php: >=7.2.0

Requires (Dev)

• mnapoli/hard-mode: ~0.3.0
• phpunit/phpunit: ^8.5|^9.0

MIT

• phpdoc
• reflection

README

This project is used by:

• PHP-DI 6
• Woohoo Labs. Zen

Fork the README to add your project here.

Features

PhpDocReader parses @var and @param values in PHP docblocks:

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:

• 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.

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