README

将文档注释类型或类型规范转换为更易用的类型对象树。

PHP Integrator 项目的一部分。https://gitlab.com/php-integrator/core

安装

composer require "php-integrator/docblock-type-parser" "^0.2"

使用方法

<?php

use PhpIntegrator\DocblockTypeParser\DocblockTypeParser;
use PhpIntegrator\DocblockTypeParser\CompoundDocblockType;

$parser = new DocblockTypeParser();
$type = $parser->parse('(int|bool)[]|string[]|array|null');

assert($type instanceof CompoundDocblockType);
assert($type->toString() === '(int|bool)[]|string[]|array|null');

文档注释类型...？

文档注释类型是 您在文档注释内指定的类型，例如参数、返回值等。它们允许缩小参数类型，这在 PHP 本身中可能无法实现，因此其语法更为复杂。

文档注释类型可以被各种工具解释，例如 PHP Integrator 或文档生成器。

<?php

/**
 * @param (int|bool)[]|string[]|array|null $test
 */
public function foo(array $test)
{

}