comment | ||
errors | ||
node | ||
php5 | ||
php7 | ||
position | ||
printer | ||
scanner | ||
token | ||
visitor | ||
walker | ||
.gitignore | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
doc.go | ||
ISSUE_TEMPLATE.md | ||
LICENSE | ||
main.go | ||
Makefile | ||
parser.go | ||
parser.jpg | ||
README.md |
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 (
"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)
}
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 resolvesuse
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