A PHP parser written in PHP
Go to file
Nikita Popov 3ad0d4b310 Add support for return type declarations [PHP 7]
This adds an additional "returnType" subnode to Stmt\Function_,
Stmt\ClassMethod and Expr\Closure, as well as the corresponding
support in the name resolver and pretty printer.
2015-03-12 22:16:12 +01:00
bin Added php shebang 2015-02-24 21:43:12 +01:00
doc Add "use" builder 2015-03-10 16:05:55 +01:00
grammar Add support for return type declarations [PHP 7] 2015-03-12 22:16:12 +01:00
lib Add support for return type declarations [PHP 7] 2015-03-12 22:16:12 +01:00
test Add support for return type declarations [PHP 7] 2015-03-12 22:16:12 +01:00
test_old Fix a number of other typos 2014-02-12 17:47:34 +01:00
.travis.yml Fix lexer tests for HHVM 2015-02-26 19:19:40 +01:00
CHANGELOG.md Add some tests for pretty printing expressions 2015-01-18 19:57:09 +01:00
composer.json Fixed branch alias 2015-01-18 11:46:36 +00:00
LICENSE fix typos 2011-06-26 18:45:19 +02:00
phpunit.xml.dist fix typo (see also issue 93 already fixed) 2014-02-12 17:39:57 +01:00
README.md Add documentation TOC to readme 2015-03-10 21:32:21 +01:00
UPGRADE-1.0.md Fix typos 2014-09-12 14:44:32 +02:00

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 (stable; for running on PHP >= 5.3).

Documentation for version 0.9.x (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
echo 'Hi', 'World';
hello\world('foo', 'bar' . 'baz');

You'll get a syntax tree looking roughly like this:

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
  2. Installation
  3. Usage of basic components
  4. Other node tree representations
  5. Code generation

Component documentation:

  1. Lexer