gnu-social/vendor/nikic/php-parser/README.md
2020-08-07 23:42:38 +01:00

88 lines
2.2 KiB
Markdown

PHP Parser
==========
This is a PHP 5.2 to PHP 5.6 parser written in PHP. Its purpose is to simplify static code analysis and
manipulation.
[**Documentation for version 1.x**][doc_1_x] (stable; for running on PHP >= 5.3).
[Documentation for version 0.9.x][doc_0_9] (unsupported; for running on PHP 5.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).
Documentation
-------------
1. [Introduction](doc/0_Introduction.markdown)
2. [Installation](doc/1_Installation.markdown)
3. [Usage of basic components](doc/2_Usage_of_basic_components.markdown)
4. [Other node tree representations](doc/3_Other_node_tree_representations.markdown)
5. [Code generation](doc/4_Code_generation.markdown)
Component documentation:
1. [Lexer](doc/component/Lexer.markdown)
[doc_0_9]: https://github.com/nikic/PHP-Parser/tree/0.9/doc
[doc_1_x]: https://github.com/nikic/PHP-Parser/tree/1.x/doc