Chris@0: PHP Parser
Chris@0: ==========
Chris@0: 
Chris@0: [![Build Status](https://travis-ci.org/nikic/PHP-Parser.svg?branch=master)](https://travis-ci.org/nikic/PHP-Parser) [![Coverage Status](https://coveralls.io/repos/github/nikic/PHP-Parser/badge.svg?branch=master)](https://coveralls.io/github/nikic/PHP-Parser?branch=master)
Chris@0: 
Chris@0: This is a PHP 5.2 to PHP 7.1 parser written in PHP. Its purpose is to simplify static code analysis and
Chris@0: manipulation.
Chris@0: 
Chris@0: [**Documentation for version 3.x**][doc_master] (stable; for running on PHP >= 5.5; for parsing PHP 5.2 to PHP 7.1).
Chris@0: 
Chris@0: [Documentation for version 2.x][doc_2_x] (stable; for running on PHP >= 5.4; for parsing PHP 5.2 to PHP 7.0).
Chris@0: 
Chris@0: [Documentation for version 1.x][doc_1_x] (unsupported; for running on PHP >= 5.3; for parsing PHP 5.2 to PHP 5.6).
Chris@0: 
Chris@0: In a Nutshell
Chris@0: -------------
Chris@0: 
Chris@0: The parser turns PHP source code into an abstract syntax tree. For example, if you pass the following code into the
Chris@0: parser:
Chris@0: 
Chris@0: ```php
Chris@0: <?php
Chris@0: echo 'Hi', 'World';
Chris@0: hello\world('foo', 'bar' . 'baz');
Chris@0: ```
Chris@0: 
Chris@0: You'll get a syntax tree looking roughly like this:
Chris@0: 
Chris@0: ```php
Chris@0: array(
Chris@0:     0: Stmt_Echo(
Chris@0:         exprs: array(
Chris@0:             0: Scalar_String(
Chris@0:                 value: Hi
Chris@0:             )
Chris@0:             1: Scalar_String(
Chris@0:                 value: World
Chris@0:             )
Chris@0:         )
Chris@0:     )
Chris@0:     1: Expr_FuncCall(
Chris@0:         name: Name(
Chris@0:             parts: array(
Chris@0:                 0: hello
Chris@0:                 1: world
Chris@0:             )
Chris@0:         )
Chris@0:         args: array(
Chris@0:             0: Arg(
Chris@0:                 value: Scalar_String(
Chris@0:                     value: foo
Chris@0:                 )
Chris@0:                 byRef: false
Chris@0:             )
Chris@0:             1: Arg(
Chris@0:                 value: Expr_Concat(
Chris@0:                     left: Scalar_String(
Chris@0:                         value: bar
Chris@0:                     )
Chris@0:                     right: Scalar_String(
Chris@0:                         value: baz
Chris@0:                     )
Chris@0:                 )
Chris@0:                 byRef: false
Chris@0:             )
Chris@0:         )
Chris@0:     )
Chris@0: )
Chris@0: ```
Chris@0: 
Chris@0: You can then work with this syntax tree, for example to statically analyze the code (e.g. to find
Chris@0: programming errors or security issues).
Chris@0: 
Chris@0: Additionally, you can convert a syntax tree back to PHP code. This allows you to do code preprocessing
Chris@0: (like automatedly porting code to older PHP versions).
Chris@0: 
Chris@0: Installation
Chris@0: ------------
Chris@0: 
Chris@0: The preferred installation method is [composer](https://getcomposer.org):
Chris@0: 
Chris@0:     php composer.phar require nikic/php-parser
Chris@0: 
Chris@0: Documentation
Chris@0: -------------
Chris@0: 
Chris@0:  1. [Introduction](doc/0_Introduction.markdown)
Chris@0:  2. [Usage of basic components](doc/2_Usage_of_basic_components.markdown)
Chris@0:  3. [Other node tree representations](doc/3_Other_node_tree_representations.markdown)
Chris@0:  4. [Code generation](doc/4_Code_generation.markdown)
Chris@0: 
Chris@0: Component documentation:
Chris@0: 
Chris@0:  1. [Error handling](doc/component/Error_handling.markdown)
Chris@0:  2. [Lexer](doc/component/Lexer.markdown)
Chris@0: 
Chris@0:  [doc_1_x]: https://github.com/nikic/PHP-Parser/tree/1.x/doc
Chris@0:  [doc_2_x]: https://github.com/nikic/PHP-Parser/tree/2.x/doc
Chris@0:  [doc_master]: https://github.com/nikic/PHP-Parser/tree/master/doc