Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 504 Commits
.github		.github
apigen		apigen
doc/grammars		doc/grammars
src		src
tests		tests
tmp		tmp
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
UPGRADING.md		UPGRADING.md
build-abnfgen.sh		build-abnfgen.sh
composer.json		composer.json
phpcs.xml		phpcs.xml
phpstan-baseline.neon		phpstan-baseline.neon
phpstan.neon		phpstan.neon
phpunit.xml		phpunit.xml

Repository files navigation

PHPDoc Parser for PHPStan

This libraryphpstan/phpdoc-parser represents PHPDocs with an AST (Abstract Syntax Tree). It supports parsing and modifying PHPDocs.

For the complete list of supported PHPDoc features check out PHPStan documentation. PHPStan is the main (but not the only) user of this library.

PHPDoc Basics (list of PHPDoc tags)
PHPDoc Types (list of PHPDoc types)
phpdoc-parser API Reference with all the AST node types etc.

This parser also supports parsingDoctrine Annotations. The AST nodes live in thePHPStan\PhpDocParser\Ast\PhpDoc\Doctrine namespace.

Installation

composer require phpstan/phpdoc-parser

Basic usage

<?phprequire_once__DIR__ .'/vendor/autoload.php';usePHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;usePHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode;usePHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;usePHPStan\PhpDocParser\Lexer\Lexer;usePHPStan\PhpDocParser\ParserConfig;usePHPStan\PhpDocParser\Parser\ConstExprParser;usePHPStan\PhpDocParser\Parser\PhpDocParser;usePHPStan\PhpDocParser\Parser\TokenIterator;usePHPStan\PhpDocParser\Parser\TypeParser;// basic setup$config =newParserConfig(usedAttributes: []);$lexer =newLexer($config);$constExprParser =newConstExprParser($config);$typeParser =newTypeParser($config,$constExprParser);$phpDocParser =newPhpDocParser($config,$typeParser,$constExprParser);// parsing and reading a PHPDoc string$tokens =newTokenIterator($lexer->tokenize('/** @param Lorem $a */'));$phpDocNode =$phpDocParser->parse($tokens);// PhpDocNode$paramTags =$phpDocNode->getParamTagValues();// ParamTagValueNode[]echo$paramTags[0]->parameterName;// '$a'echo$paramTags[0]->type;// IdentifierTypeNode - 'Lorem'

Format-preserving printer

This component can be used to modify the ASTand print it again as close as possible to the original.

It's heavily inspired by format-preserving printer component innikic/PHP-Parser.

<?phprequire_once__DIR__ .'/vendor/autoload.php';usePHPStan\PhpDocParser\Ast\NodeTraverser;usePHPStan\PhpDocParser\Ast\NodeVisitor\CloningVisitor;usePHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode;usePHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;usePHPStan\PhpDocParser\Lexer\Lexer;usePHPStan\PhpDocParser\ParserConfig;usePHPStan\PhpDocParser\Parser\ConstExprParser;usePHPStan\PhpDocParser\Parser\PhpDocParser;usePHPStan\PhpDocParser\Parser\TokenIterator;usePHPStan\PhpDocParser\Parser\TypeParser;usePHPStan\PhpDocParser\Printer\Printer;// basic setup with enabled required lexer attributes$config =newParserConfig(usedAttributes: ['lines' =>true,'indexes' =>true,'comments' =>true]);$lexer =newLexer($config);$constExprParser =newConstExprParser($config);$typeParser =newTypeParser($config,$constExprParser);$phpDocParser =newPhpDocParser($config,$typeParser,$constExprParser);$tokens =newTokenIterator($lexer->tokenize('/** @param Lorem $a */'));$phpDocNode =$phpDocParser->parse($tokens);// PhpDocNode$cloningTraverser =newNodeTraverser([newCloningVisitor()]);/** @var PhpDocNode $newPhpDocNode */[$newPhpDocNode] =$cloningTraverser->traverse([$phpDocNode]);// change something in $newPhpDocNode$newPhpDocNode->getParamTagValues()[0]->type =newIdentifierTypeNode('Ipsum');// print changed PHPDoc$printer =newPrinter();$newPhpDoc =$printer->printFormatPreserving($newPhpDocNode,$phpDocNode,$tokens);echo$newPhpDoc;// '/** @param Ipsum $a */'