Go to file
2018-12-10 11:53:23 +02:00
errors #67: skip unexpected character in input 2018-11-05 16:56:27 +02:00
meta remove meta.*CastToken 2018-12-10 11:53:23 +02:00
node remove StringVar attribute from expr.Variable 2018-10-24 17:04:13 +03:00
parser #33 comment package has renamed to meta and parser now saves whitespaces 2018-06-30 23:23:19 +03:00
php5 remove meta.*CastToken 2018-12-10 11:53:23 +02:00
php7 remove meta.*CastToken 2018-12-10 11:53:23 +02:00
position refactor tokenString 2018-06-05 15:20:23 +03:00
printer remove meta.*CastToken 2018-12-10 11:53:23 +02:00
scanner Merge branch 'master' into dev 2018-11-05 17:14:09 +02:00
visitor remove meta.NamespaceToken 2018-12-10 11:53:22 +02:00
walker #31 dump to native golang struct 2018-06-19 22:56:52 +03:00
.gitignore trace profiling added 2018-07-11 17:01:31 +03:00
.travis.yml update .travis.yml 2018-08-07 00:57:30 +03:00
CODE_OF_CONDUCT.md update CODE_OF_CONDUCT.md 2018-01-05 19:49:29 +02:00
CONTRIBUTING.md create CONTRIBUTING.md 2018-01-05 19:37:08 +02:00
doc.go issue #8: update readme 2018-04-10 15:51:05 +03:00
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md 2018-07-09 21:19:33 +03:00
LICENSE Create LICENSE 2018-01-02 14:37:19 +02:00
main.go #51 saving optional tokes and tokens that have different representation as meta 2018-08-09 11:46:56 +03:00
Makefile #13: the printer prints nodes with meta(comments and whitespaces) saved by the parser 2018-07-08 01:48:52 +03:00
parser.jpg #5 update logo 2018-05-16 09:08:16 +03:00
README.md Merge branch 'master' into dev 2018-11-05 17:14:09 +02:00

PHP Parser written in Go

PHP Parser written in Go

GoDoc Build Status Go Report Card Maintainability Test Coverage

This project uses goyacc and golex libraries to parse PHP sources into AST. It can be used to write static analysis, refactoring, metrics, code style formatting tools.

Try it online: demo

Features:

  • Fully support PHP 5 and PHP 7 syntax
  • Abstract syntax tree (AST) representation
  • Traversing AST
  • Namespace resolver
  • Able to parse syntax-invalid PHP files

Roadmap

  • Pretty printer
  • Control Flow Graph (CFG)
  • PhpDocComment parser
  • Stabilize api

Install

go get github.com/z7zmey/php-parser

CLI

php-parser [flags] <path> ...
flag type description
-d string dump format: [custom, go, json, pretty-json]
-p bool show positions
-r bool resolve names
-prof string start profiler: [cpu, mem, trace]
-meta bool show meta info
-php5 bool parse as PHP5

Dump AST to stdout.

Example

package main

import (
	"fmt"
	"bytes"
	"os"

	"github.com/z7zmey/php-parser/php7"
	"github.com/z7zmey/php-parser/visitor"
)

func main() {
	src := bytes.NewBufferString(`<? echo "Hello world";`)

	parser := php7.NewParser(src, "example.php")
	parser.Parse()

	for _, e := range parser.GetErrors() {
		fmt.Println(e)
	}

	visitor := visitor.Dumper{
		Writer:    os.Stdout,
		Indent:    "",
		Comments:  parser.GetComments(),
		Positions: parser.GetPositions(),
	}

	rootNode := parser.GetRootNode()
	rootNode.Walk(visitor)
}

Namespace resolver

Namespace resolver is a visitor that resolves nodes fully qualified name and saves into map[node.Node]string structure

  • For Class, Interface, Trait, Function, Constant nodes it saves name with current namespace.
  • For Name, Relative, FullyQualified nodes it resolves use aliases and saves a fully qualified name.

Parsing syntax-invalid PHP files

If we try to parse $a$b; then the parser triggers error 'syntax error: unexpected T_VARIABLE'. Token $b is unexpected, but parser recovers parsing process and returns $b; statement to AST, because it is syntactically correct.

Pretty printer [work in progress]

nodes := &stmt.StmtList{
	Stmts: []node.Node{
		&stmt.Namespace{
			NamespaceName: &name.Name{
				Parts: []node.Node{
					&name.NamePart{Value: "Foo"},
				},
			},
		},
		&stmt.Class{
			Modifiers: []node.Node{
				&node.Identifier{Value: "abstract"},
			},
			ClassName: &name.Name{
				Parts: []node.Node{
					&name.NamePart{Value: "Bar"},
				},
			},
			Extends: &stmt.ClassExtends{
				ClassName: &name.Name{
					Parts: []node.Node{
						&name.NamePart{
							Value: "Baz"
						},
					},
				},
			},
			Stmts: []node.Node{
				&stmt.ClassMethod{
					Modifiers: []node.Node{
						&node.Identifier{Value: "public"},
					},
					MethodName: &node.Identifier{Value: "greet"},
					Stmt: &stmt.StmtList{
						Stmts: []node.Node{
							&stmt.Echo{
								Exprs: []node.Node{
									&scalar.String{Value: "'Hello world'"},
								},
							},
						},
					},
				},
			},
		},
	},
}

file := os.Stdout
p := printer.NewPrinter(file, "    ")
p.Print(nodes)

It prints to stdout:

<?php
namespace Foo;
abstract class Bar extends Baz
{
	public function greet()
	{
		echo 'Hello world';
	}
}