Download phpdoc parser - download do código-fonte phpdoc parser

phpdoc parser

Outras categorias

2.0.0

Baixar

Analisador PHPDoc para PHPStan

Esta biblioteca phpstan/phpdoc-parser representa PHPDocs com uma AST (Abstract Syntax Tree). Suporta análise e modificação de PHPDocs.

Para obter a lista completa de recursos PHPDoc suportados, consulte a documentação do PHPStan. PHPStan é o principal (mas não o único) usuário desta biblioteca.

Noções básicas de PHPDoc (lista de tags PHPDoc)
Tipos PHPDoc (lista de tipos PHPDoc)
Referência da API phpdoc-parser com todos os tipos de nós AST, etc.

Este analisador também suporta a análise de Anotações de Doutrina. Os nós AST residem no namespace PHPStanPhpDocParserAstPhpDocDoctrine.

Instalação

 composer require phpstan/phpdoc-parser

Uso básico

 <?php

require_once __DIR__ . ' /vendor/autoload.php ' ;

use PHPStan  PhpDocParser  Ast  PhpDoc  ParamTagValueNode ;
use PHPStan  PhpDocParser  Ast  PhpDoc  PhpDocNode ;
use PHPStan  PhpDocParser  Ast  Type  IdentifierTypeNode ;
use PHPStan  PhpDocParser  Lexer  Lexer ;
use PHPStan  PhpDocParser  ParserConfig ;
use PHPStan  PhpDocParser  Parser  ConstExprParser ;
use PHPStan  PhpDocParser  Parser  PhpDocParser ;
use PHPStan  PhpDocParser  Parser  TokenIterator ;
use PHPStan  PhpDocParser  Parser  TypeParser ;

// basic setup

$ config = new ParserConfig (usedAttributes: []);
$ lexer = new Lexer ( $ config );
$ constExprParser = new ConstExprParser ( $ config );
$ typeParser = new TypeParser ( $ config , $ constExprParser );
$ phpDocParser = new PhpDocParser ( $ config , $ typeParser , $ constExprParser );

// parsing and reading a PHPDoc string

$ tokens = new TokenIterator ( $ 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'

Impressora com preservação de formato

Este componente pode ser usado para modificar o AST e imprimi-lo novamente o mais próximo possível do original.

É fortemente inspirado no componente de impressora que preserva o formato no nikic/PHP-Parser.

 <?php

require_once __DIR__ . ' /vendor/autoload.php ' ;

use PHPStan  PhpDocParser  Ast  NodeTraverser ;
use PHPStan  PhpDocParser  Ast  NodeVisitor  CloningVisitor ;
use PHPStan  PhpDocParser  Ast  PhpDoc  PhpDocNode ;
use PHPStan  PhpDocParser  Ast  Type  IdentifierTypeNode ;
use PHPStan  PhpDocParser  Lexer  Lexer ;
use PHPStan  PhpDocParser  ParserConfig ;
use PHPStan  PhpDocParser  Parser  ConstExprParser ;
use PHPStan  PhpDocParser  Parser  PhpDocParser ;
use PHPStan  PhpDocParser  Parser  TokenIterator ;
use PHPStan  PhpDocParser  Parser  TypeParser ;
use PHPStan  PhpDocParser  Printer  Printer ;

// basic setup with enabled required lexer attributes

$ config = new ParserConfig (usedAttributes: [ ' lines ' => true , ' indexes ' => true ]);
$ lexer = new Lexer ( $ config );
$ constExprParser = new ConstExprParser ( $ config );
$ typeParser = new TypeParser ( $ config , $ constExprParser );
$ phpDocParser = new PhpDocParser ( $ config , $ typeParser , $ constExprParser );

$ tokens = new TokenIterator ( $ lexer -> tokenize ( ' /** @param Lorem $a */ ' ));
$ phpDocNode = $ phpDocParser -> parse ( $ tokens ); // PhpDocNode

$ cloningTraverser = new NodeTraverser ([ new CloningVisitor ()]);

/** @var PhpDocNode $newPhpDocNode */
[ $ newPhpDocNode ] = $ cloningTraverser -> traverse ([ $ phpDocNode ]);

// change something in $newPhpDocNode
$ newPhpDocNode -> getParamTagValues ()[ 0 ]-> type = new IdentifierTypeNode ( ' Ipsum ' );

// print changed PHPDoc
$ printer = new Printer ();
$ newPhpDoc = $ printer -> printFormatPreserving ( $ newPhpDocNode , $ phpDocNode , $ tokens );
echo $ newPhpDoc ; // '/** @param Ipsum $a */'