php-parser

README

Try it online: demo

Features:

• Fully support PHP5 and PHP7 syntax
• Abstract syntax tree representation
• Traversing AST
• Namespace resolver

Install

go get github.com/z7zmey/php-parser

Example

package main

import (
	"bytes"

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

func main() {
	src := bytes.NewBufferString(`<? echo "Hello world";`)
	nodes, comments, positions := php7.Parse(src, "example.php")

	visitor := visitor.Dumper{
		Indent:    "",
		Comments:  comments,
		Positions: positions,
	}
	nodes.Walk(visitor)
}

CLI dumper

$GOPATH/bin/php-parser /path/to/file/or/dir

Namespace resolver

Namespace resolver is a visitor that traverses nodes and resolves nodes fully qualified name. It does not change AST but collects resolved names into map[node.Node]string

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

Pretty printer

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: &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"},
					Stmts: []node.Node{
						&stmt.Echo{
							Exprs: []node.Node{
								&scalar.String{Value: "'Hello world'"},
							},
						},
					},
				},
			},
		},
	},
}

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

Output:

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

Roadmap

• Lexer
• PHP 7 syntax analyzer
• AST nodes
• AST visitor
• AST dumper
• node position
• handling comments
• PHP 5 syntax analyzer
• Tests
• Namespace resolver
• Pretty printer
• PhpDocComment parser
• Error handling
• Stabilize api
• Documentation
• Code flow graph

Documentation

Overview

A Parser for PHP written in Go

Features:

• Fully support PHP5 and PHP7 syntax
• Abstract syntax tree representation
• Traversing AST

Install:

go get github.com/z7zmey/php-parser

CLI dumper:

$GOPATH/bin/php-parser -php5 /path/to/file/or/dir

Package usage example:

package main

import (
	"bytes"

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

func main() {
	src := bytes.NewBufferString(`<? echo "Hello world";`)
	nodes, comments, positions := php7.Parse(src, "example.php")

	visitor := visitor.Dumper{
		Indent:    "",
		Comments:  comments,
		Positions: positions,
	}
	nodes.Walk(visitor)
}