How to rename all variables in a PHP file using PHP-Parser?

Use a NodeVisitor to traverse the AST and modify Expr_Variable nodes. The library's quick start shows how to traverse and change nodes, such as by cleaning function bodies, which can be adapted for variable renaming.

PHP-Parser vs PHP-CS-Fixer: which is better for code refactoring?

PHP-Parser is a low-level library for custom analysis and manipulation, allowing fine-grained control. PHP-CS-Fixer is a pre-built tool for automated code style fixing. Choose PHP-Parser if you need custom transformations beyond formatting.

Does PHP-Parser support PHP 8.3 attributes and enums?

Yes, version 5.x supports parsing PHP up to 8.4, including modern features like attributes and enums. It's designed for the newest supported versions, as noted in the documentation.

How to handle syntax errors when parsing code with PHP-Parser?

PHP-Parser can parse invalid code into a partial AST using error recovery. Catch PhpParser\Error exceptions and use the partial AST for analysis where possible, as mentioned in the error handling component.

Can I generate PHP code from scratch without parsing existing code?

Yes, use the AST builders provided by PHP-Parser to construct nodes programmatically. Then, convert the AST to code with the pretty printer, as shown in the code generation examples.

What are best practices for improving PHP-Parser performance?

Disable Xdebug, reuse parser and traverser objects, and manage garbage collection. The performance documentation section provides specific tips to optimize resource usage.

Open-Awesome

PHP Parser

BSD-3-ClausePHPv5.8.0

A PHP parser written in PHP for static code analysis and manipulation via an abstract syntax tree (AST).

GitHub

17.5k stars1.1k forks0 contributors

What is PHP Parser?

PHP-Parser is a library written in PHP that parses PHP source code into an abstract syntax tree (AST). It enables developers to programmatically analyze, traverse, and manipulate PHP code for tasks like static analysis, refactoring, and custom tooling. The tool supports modern PHP versions and handles invalid code gracefully with partial ASTs.

Target Audience

PHP developers building static analysis tools, code refactoring utilities, linters, or any application requiring programmatic inspection or modification of PHP source code.

Value Proposition

Developers choose PHP-Parser for its accuracy, comprehensive feature set, and active maintenance. It provides a reliable foundation for code manipulation with support for modern PHP versions, name resolution, and AST-to-code conversion, all within a pure PHP environment.

Overview

A PHP parser written in PHP

Use Cases

Best For

Building custom static analysis tools for PHP codebases
Creating automated code refactoring or migration scripts
Developing linters or coding standard enforcement utilities
Generating PHP code programmatically via AST builders
Implementing custom IDE features or code intelligence tools
Analyzing code structure for documentation or visualization purposes

Not Ideal For

Projects requiring only basic code formatting or linting without custom analysis
Teams seeking out-of-the-box refactoring tools without development overhead
Applications needing real-time, lightweight syntax checking in web interfaces
Developers extensively working with legacy PHP 5.2 code requiring full parsing accuracy

Pros & Cons

Pros

Accurate Modern Parsing

Supports PHP 7.0 to 8.4 with precise location information and can parse invalid code into partial ASTs, as highlighted in the features list.

Flexible AST Manipulation

Provides traversal infrastructure and node visitors for easy code modifications, demonstrated in the quick start example for stripping function bodies.

Format-Preserving Generation

Converts ASTs back to PHP code while maintaining original formatting for unmodified parts, enabling incremental changes without style disruption.

Built-in Name Resolution

Resolves namespaced names within the AST, essential for accurate static analysis without runtime execution, as documented in the components.

Cons

Steep Learning Curve

Requires deep understanding of AST structures and node types, making it inaccessible for developers needing simple, quick solutions.

Performance Overheads

Parsing and traversing large codebases can be resource-intensive, with documentation advising optimizations like disabling Xdebug.

Version Fragmentation

Maintains multiple active branches (e.g., 4.x and 5.x) with differing PHP version support, which can confuse users about compatibility.

Frequently Asked Questions

Related Projects

TypeScript ESLint

:sparkles: Monorepo for all the tooling which enables ESLint to support TypeScript

Stars16,320

Forks2,952

Last commit21 hours ago

pyright

Static Type Checker for Python

Stars15,545

Forks1,797

Last commit2 days ago

Rector

Instant Upgrades and Automated Refactoring of any PHP 5.3+ code

Stars10,379

Forks740

Last commit9 hours ago

Reviewdog

🐶 Automated code review tool integrated with any code analysis tools regardless of programming language

Stars9,474

Forks490

Last commit5 hours ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub