phpdoc parserダウンロード - phpdoc parserソースコードのダウンロード

phpdoc parser

その他のカテゴリー

2.0.0

ダウンロード

PHPStan 用の PHPDoc パーサー

このライブラリphpstan/phpdoc-parser PHPDoc を AST (抽象構文ツリー) で表します。 PHPDoc の解析と変更をサポートします。

サポートされている PHPDoc 機能の完全なリストについては、PHPStan のドキュメントを参照してください。 PHPStan は、このライブラリの主要な (ただし唯一ではない) ユーザーです。

PHPDoc の基本 (PHPDoc タグのリスト)
PHPDoc タイプ (PHPDoc タイプのリスト)
すべての AST ノードタイプなどを含む phpdoc-parser API リファレンス。

このパーサーは Doctrine 注釈の解析もサポートしています。 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 */'