Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 1,783 Commits
.github/workflows		.github/workflows
bin		bin
doc		doc
grammar		grammar
lib/PhpParser		lib/PhpParser
test		test
test_old		test_old
tools		tools
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
.php-cs-fixer.dist.php		.php-cs-fixer.dist.php
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
UPGRADE-1.0.md		UPGRADE-1.0.md
UPGRADE-2.0.md		UPGRADE-2.0.md
UPGRADE-3.0.md		UPGRADE-3.0.md
UPGRADE-4.0.md		UPGRADE-4.0.md
UPGRADE-5.0.md		UPGRADE-5.0.md
composer.json		composer.json
phpstan-baseline.neon		phpstan-baseline.neon
phpstan.neon.dist		phpstan.neon.dist
phpunit.xml.dist		phpunit.xml.dist

Repository files navigation

PHP Parser

This is a PHP parser written in PHP. Its purpose is to simplify static code analysis andmanipulation.

Documentation for version 5.x (current; for running on PHP >= 7.4; for parsing PHP 7.0 to PHP 8.4, with limited support for parsing PHP 5.x).

Documentation for version 4.x (supported; for running on PHP >= 7.0; for parsing PHP 5.2 to PHP 8.3).

Features

The main features provided by this library are:

Parsing PHP 7, and PHP 8 code into an abstract syntax tree (AST).
- Invalid code can be parsed into a partial AST.
- The AST contains accurate location information.
Dumping the AST in human-readable form.
Converting an AST back to PHP code.
- Formatting can be preserved for partially changed ASTs.
Infrastructure to traverse and modify ASTs.
Resolution of namespaced names.
Evaluation of constant expressions.
Builders to simplify AST construction for code generation.
Converting an AST into JSON and back.

Quick Start

Install the library usingcomposer:

php composer.phar require nikic/php-parser

Parse some PHP code into an AST and dump the result in human-readable form:

<?phpusePhpParser\Error;usePhpParser\NodeDumper;usePhpParser\ParserFactory;$code = <<<'CODE'<?phpfunction test($foo){    var_dump($foo);}CODE;$parser = (newParserFactory())->createForNewestSupportedVersion();try {$ast =$parser->parse($code);}catch (Error$error) {echo"Parse error:{$error->getMessage()}\n";return;}$dumper =newNodeDumper;echo$dumper->dump($ast) ."\n";

This dumps an AST looking something like this:

array(    0: Stmt_Function(        attrGroups: array(        )        byRef: false        name: Identifier(            name: test        )        params: array(            0: Param(                attrGroups: array(                )                flags: 0                type: null                byRef: false                variadic: false                var: Expr_Variable(                    name: foo                )                default: null            )        )        returnType: null        stmts: array(            0: Stmt_Expression(                expr: Expr_FuncCall(                    name: Name(                        name: var_dump                    )                    args: array(                        0: Arg(                            name: null                            value: Expr_Variable(                                name: foo                            )                            byRef: false                            unpack: false                        )                    )                )            )        )    ))

Let's traverse the AST and perform some kind of modification. For example, drop all function bodies:

usePhpParser\Node;usePhpParser\Node\Stmt\Function_;usePhpParser\NodeTraverser;usePhpParser\NodeVisitorAbstract;$traverser =newNodeTraverser();$traverser->addVisitor(newclassextends NodeVisitorAbstract {publicfunctionenterNode(Node$node) {if ($nodeinstanceof Function_) {// Clean out the function body$node->stmts = [];        }    }});$ast =$traverser->traverse($ast);echo$dumper->dump($ast) ."\n";

This gives us an AST where theFunction_::$stmts are empty:

array(    0: Stmt_Function(        attrGroups: array(        )        byRef: false        name: Identifier(            name: test        )        params: array(            0: Param(                attrGroups: array(                )                type: null                byRef: false                variadic: false                var: Expr_Variable(                    name: foo                )                default: null            )        )        returnType: null        stmts: array(        )    ))

Finally, we can convert the new AST back to PHP code:

usePhpParser\PrettyPrinter;$prettyPrinter =newPrettyPrinter\Standard;echo$prettyPrinter->prettyPrintFile($ast);

This gives us our original code, minus thevar_dump() call inside the function:

<?phpfunctiontest($foo){}

For a more comprehensive introduction, see the documentation.

Documentation

Component documentation:

Walking the AST
- Node visitors
- Modifying the AST from a visitor
- Short-circuiting traversals
- Interleaved visitors
- Simple node finding API
- Parent and sibling references
Name resolution
- Name resolver options
- Name resolution context
Pretty printing
- Converting AST back to PHP code
- Customizing formatting
- Formatting-preserving code transformations
AST builders
- Fluent builders for AST nodes
Lexer
- Emulation
- Tokens, positions and attributes
Error handling
- Column information for errors
- Error recovery (parsing of syntactically incorrect code)
Constant expression evaluation
- Evaluating constant/property/etc initializers
- Handling errors and unsupported expressions
JSON representation
- JSON encoding and decoding of ASTs
Performance
- Disabling Xdebug
- Reusing objects
- Garbage collection impact
Frequently asked questions
- Parent and sibling references