Descarga phpdoc parser - Descarga del código fuente phpdoc parser

phpdoc parser

Otras categorias

2.0.0

Descargar

Analizador PHPDoc para PHPStan

Esta biblioteca phpstan/phpdoc-parser representa PHPDocs con un AST (árbol de sintaxis abstracta). Admite el análisis y la modificación de PHPDocs.

Para obtener la lista completa de funciones PHPDoc compatibles, consulte la documentación de PHPStan. PHPStan es el usuario principal (pero no el único) de esta biblioteca.

Conceptos básicos de PHPDoc (lista de etiquetas PHPDoc)
Tipos de PHPDoc (lista de tipos de PHPDoc)
Referencia de API de phpdoc-parser con todos los tipos de nodos AST, etc.

Este analizador también admite el análisis de anotaciones de Doctrine. Los nodos AST viven en el espacio de nombres PHPStanPhpDocParserAstPhpDocDoctrine.

Instalación

 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'

Impresora que preserva el formato

Este componente se puede utilizar para modificar el AST e imprimirlo nuevamente lo más cerca posible del original.

Está fuertemente inspirado en el componente de impresora que preserva el formato en 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 */'

Código de conducta

Este proyecto se adhiere a un Código de conducta para colaboradores. Al participar en este proyecto y su comunidad, se espera que respete este código.