phpdoc parser 다운로드 - phpdoc parser 소스 코드 다운로드

phpdoc parser

기타 카테고리

2.0.0

다운로드

PHPStan용 PHPDoc 파서

이 라이브러리 phpstan/phpdoc-parser AST(추상 구문 트리)가 있는 PHPDoc을 나타냅니다. PHPDoc 구문 분석 및 수정을 지원합니다.

지원되는 PHPDoc 기능의 전체 목록을 보려면 PHPStan 설명서를 확인하세요. PHPStan은 이 라이브러리의 주요(유일한 사용자는 아님) 사용자입니다.

PHPDoc 기본(PHPDoc 태그 목록)
PHPDoc 유형(PHPDoc 유형 목록)
모든 AST 노드 유형 등을 포함한 phpdoc-parser API 참조

이 파서는 교리 주석 구문 분석도 지원합니다. AST 노드는 PHPStanPhpDocParserAstPhpDocDoctrine 네임스페이스에 있습니다.

설치

 composer require phpstan/phpdoc-parser

기본 사용법

 <?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'

형식 보존 프린터

이 구성 요소는 AST를 수정하고 원본에 최대한 가깝게 다시 인쇄하는 데 사용할 수 있습니다.

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 */'