ดาวน์โหลด phpdoc parser - ดาวน์โหลดซอร์สโค้ด phpdoc parser

phpdoc parser

หมวดหมู่อื่นๆ

2.0.0

ดาวน์โหลด

PHPDoc Parser สำหรับ PHPStan

ไลบรารีนี้ phpstan/phpdoc-parser แสดงถึง PHPDocs ด้วย AST (Abstract Syntax Tree) รองรับการแยกวิเคราะห์และแก้ไข PHPDocs

สำหรับรายการคุณสมบัติ PHPDoc ที่รองรับทั้งหมด โปรดดูเอกสารประกอบของ PHPStan PHPStan เป็นผู้ใช้หลัก (แต่ไม่ใช่เพียงคนเดียว) ของไลบรารีนี้

ข้อมูลพื้นฐานเกี่ยวกับ PHPDoc (รายการแท็ก PHPDoc)
ประเภท PHPDoc (รายการประเภท PHPDoc)
การอ้างอิง phpdoc-parser API พร้อมโหนด AST ทุกประเภท ฯลฯ

parser นี้ยังสนับสนุนการแยกวิเคราะห์คำอธิบายประกอบหลักคำสอนด้วย โหนด 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 */'