Go to file
2019-02-25 17:59:06 +02:00
errors #67: skip unexpected character in input 2018-11-05 16:56:27 +02:00
freefloating rename meta to freefloating; refactoring 2019-02-25 15:01:57 +02:00
node rename meta to freefloating; refactoring 2019-02-25 15:01:57 +02:00
parser rename flag -meta to -ff 2019-02-25 16:52:47 +02:00
php5 rename flag -meta to -ff 2019-02-25 16:52:47 +02:00
php7 rename flag -meta to -ff 2019-02-25 16:52:47 +02:00
position refactor tokenString 2018-06-05 15:20:23 +03:00
printer rename flag -meta to -ff 2019-02-25 16:52:47 +02:00
scanner rename flag -meta to -ff 2019-02-25 16:52:47 +02:00
visitor rename flag -meta to -ff 2019-02-25 16:52:47 +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 2019-02-25 17:59:06 +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
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 rename flag -meta to -ff 2019-02-25 16:52:47 +02: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 update README.md 2019-02-25 17:16:24 +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
  • 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"
	"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.