loot/phpdoc-reader

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Package can parse phpdoc comments

v1.1 2021-02-19 16:24 UTC

This package is auto-updated.

Last update: 2021-09-19 17:49:59 UTC


README

usage

$class = \App\Models\User::class;
$method = 'getChild';
$comment = (new \ReflectionMethod($class, $method))->getDocComment();
$res = new Loot\PhpDocReader\PhpDocReader($comment);

var_dump($res->getAnnotationsByName('@param'));

or just

$comment = '
/**
 * @param int $var Description
 */';
$res = new Loot\PhpDocReader\PhpDocReader($comment);

var_dump($res->getAnnotation('@param')->getDescription());

Classes

Class PhpDocReader

Method getAnnotation

Получить первую аннотацию по названию.

$res = new Loot\PhpDocReader\PhpDocReader('
/**
  * @return int
  */');

var_dump($res->getAnnotation('@return')->getType());

Method getAnnotationsByName

Получить все аннотации по названию.

$res = new Loot\PhpDocReader\PhpDocReader('
/**
  * @param int $int
  * @param string $string
  */');

var_dump($res->getAnnotationsByName('@param'));

Method getAnnotations

Получить первую аннотацию.

$res = new Loot\PhpDocReader\PhpDocReader('
/**
  * @param int $int
  * @param string $string
  */');

var_dump($res->getAnnotations());

Class PhpDocLine

Method getName()

Возвращает название аннотации.

Method getType()

Возвращает тип аннотации.

Method getDescription()

Возвращает описание аннотации.

Method getVariable()

Возвращает переменную в аннотации.