PHP Parser written in Go

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
Resolving namespaced names
Parsing syntax-invalid PHP files
Saving and printing free-floating comments and whitespaces

Who Uses

VKCOM/noverify - NoVerify is a pretty fast linter for PHP

Usage 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)
}

Roadmap

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]
-r	bool	resolve names
-ff	bool	parse and show free floating strings
-prof	string	start profiler: [cpu, mem, trace]
-php5	bool	parse as PHP5

Dump AST to stdout.

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.

3.1 KiB Raw Blame History