Go to file
2020-03-09 11:34:11 +02:00
errors remove kylelemons/godebug 2019-02-25 18:12:39 +02:00
freefloating [#82] Arrow function and assign coalesce 2019-12-28 22:33:21 +02:00
node [#82] array item unpack 2019-12-29 22:42:52 +02:00
parser [#82] handle php version 2019-12-26 17:57:56 +02:00
php5 change //line comments to fix debug information 2020-01-08 09:47:23 +02:00
php7 change //line comments to fix debug information 2020-01-08 09:47:23 +02:00
position refactor tokenString 2018-06-05 15:20:23 +03:00
positionbuilder [#82] handle php version 2019-12-26 17:57:56 +02:00
printer [#82] add support of shebang 2019-12-30 00:20:20 +02:00
scanner change //line comments to fix debug information 2020-01-08 09:47:23 +02:00
version [#82] handle php version 2019-12-26 17:57:56 +02:00
visitor [#82] handle php version 2019-12-26 17:57:56 +02:00
walker #31 dump to native golang struct 2018-06-19 22:56:52 +03:00
.gitignore init modules 2020-03-09 11:34:11 +02:00
.travis.yml remove kylelemons/godebug 2019-02-25 18:12:39 +02: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
go.mod init modules 2020-03-09 11:34:11 +02:00
go.sum init modules 2020-03-09 11:34:11 +02: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 [#82] handle php version 2019-12-26 17:57:56 +02:00
Makefile change //line comments to fix debug information 2020-01-08 09:47:23 +02:00
parser.jpg #5 update logo 2018-05-16 09:08:16 +03:00
README.md #80 implement Ragel based lexer 2019-03-20 21:06:56 +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 ragel tools to create PHP parser. It parses source code 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

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.

Example

package main

import (
	"fmt"
	"os"

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

func main() {
	src := []byte(`<? echo "Hello world";`)

	parser := php7.NewParser(src)
	parser.Parse()

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

	visitor := visitor.Dumper{
		Writer:    os.Stdout,
		Indent:    "",
	}

	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.