mirror of
https://github.com/danog/PHP-Parser.git
synced 2024-11-30 04:19:30 +01:00
100 lines
2.9 KiB
Markdown
100 lines
2.9 KiB
Markdown
PHP Parser
|
|
==========
|
|
|
|
[](https://travis-ci.org/nikic/PHP-Parser) [](https://coveralls.io/github/nikic/PHP-Parser?branch=master)
|
|
|
|
This is a PHP 5.2 to PHP 7.2 parser written in PHP. Its purpose is to simplify static code analysis and
|
|
manipulation.
|
|
|
|
[**Documentation for version 3.x**][doc_3_x] (stable; for running on PHP >= 5.5; for parsing PHP 5.2 to PHP 7.2).
|
|
|
|
[Documentation for version 4.x][doc_master] (development; for running on PHP >= 7.0; for parsing PHP 5.2 to PHP 7.2).
|
|
|
|
In a Nutshell
|
|
-------------
|
|
|
|
The parser turns PHP source code into an abstract syntax tree. For example, if you pass the following code into the
|
|
parser:
|
|
|
|
```php
|
|
<?php
|
|
echo 'Hi', 'World';
|
|
hello\world('foo', 'bar' . 'baz');
|
|
```
|
|
|
|
You'll get a syntax tree looking roughly like this:
|
|
|
|
```php
|
|
array(
|
|
0: Stmt_Echo(
|
|
exprs: array(
|
|
0: Scalar_String(
|
|
value: Hi
|
|
)
|
|
1: Scalar_String(
|
|
value: World
|
|
)
|
|
)
|
|
)
|
|
1: Expr_FuncCall(
|
|
name: Name(
|
|
parts: array(
|
|
0: hello
|
|
1: world
|
|
)
|
|
)
|
|
args: array(
|
|
0: Arg(
|
|
value: Scalar_String(
|
|
value: foo
|
|
)
|
|
byRef: false
|
|
)
|
|
1: Arg(
|
|
value: Expr_Concat(
|
|
left: Scalar_String(
|
|
value: bar
|
|
)
|
|
right: Scalar_String(
|
|
value: baz
|
|
)
|
|
)
|
|
byRef: false
|
|
)
|
|
)
|
|
)
|
|
)
|
|
```
|
|
|
|
You can then work with this syntax tree, for example to statically analyze the code (e.g. to find
|
|
programming errors or security issues).
|
|
|
|
Additionally, you can convert a syntax tree back to PHP code. This allows you to do code preprocessing
|
|
(like automatedly porting code to older PHP versions).
|
|
|
|
Installation
|
|
------------
|
|
|
|
The preferred installation method is [composer](https://getcomposer.org):
|
|
|
|
php composer.phar require nikic/php-parser
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
1. [Introduction](doc/0_Introduction.markdown)
|
|
2. [Usage of basic components](doc/2_Usage_of_basic_components.markdown)
|
|
3. [Other node tree representations](doc/3_Other_node_tree_representations.markdown)
|
|
4. [Code generation](doc/4_Code_generation.markdown)
|
|
5. [Frequently asked questions](doc/5_FAQ.markdown)
|
|
|
|
Component documentation:
|
|
|
|
* [Name resolution](doc/component/Name_resolution.markdown)
|
|
* [Pretty printing](doc/component/Pretty_printing.markdown)
|
|
* [Lexer](doc/component/Lexer.markdown)
|
|
* [Error handling](doc/component/Error_handling.markdown)
|
|
|
|
[doc_3_x]: https://github.com/nikic/PHP-Parser/tree/3.x/doc
|
|
[doc_master]: https://github.com/nikic/PHP-Parser/tree/master/doc
|