135 lines
3.1 KiB
Markdown
135 lines
3.1 KiB
Markdown
<!--
|
|
Title: PHP Parser
|
|
Description: A Parser for PHP written in Go.
|
|
Author: Slizov Vadim
|
|
Keywords: go golang php php-parser ast
|
|
-->
|
|
|
|
<img src="./parser.jpg" alt="A parser for PHP written in Go" width="980"/>
|
|
|
|
[](https://goreportcard.com/report/github.com/z7zmey/php-parser)
|
|
[](https://exago.io/project/github.com/z7zmey/php-parser)
|
|
[](https://exago.io/project/github.com/z7zmey/php-parser)
|
|
[](https://godoc.org/github.com/z7zmey/php-parser)
|
|
|
|
#### Try it online: [demo](https://php-parser.com)
|
|
|
|
## Features:
|
|
- Fully support PHP5 and PHP7 syntax
|
|
- Abstract syntax tree representation
|
|
- Traversing AST
|
|
- Namespace resolver
|
|
|
|
## Install
|
|
|
|
```
|
|
go get github.com/z7zmey/php-parser
|
|
```
|
|
|
|
## Example
|
|
```Golang
|
|
package main
|
|
|
|
import (
|
|
"bytes"
|
|
"os"
|
|
|
|
"github.com/z7zmey/php-parser/php7"
|
|
"github.com/z7zmey/php-parser/visitor"
|
|
)
|
|
|
|
func main() {
|
|
src := bytes.NewBufferString(`<? echo "Hello world";`)
|
|
nodes, comments, positions, errors := php7.Parse(src, "example.php")
|
|
|
|
_ = errors
|
|
|
|
visitor := visitor.Dumper{
|
|
Writer: os.Stdout,
|
|
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
|
|
|
|
```Golang
|
|
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
|
|
<?php
|
|
namespace Foo;
|
|
abstract class Bar extends Baz
|
|
{
|
|
public function greet()
|
|
{
|
|
echo 'Hello world';
|
|
}
|
|
}
|
|
```
|
|
|
|
## Roadmap
|
|
- [X] Lexer
|
|
- [x] PHP 7 syntax analyzer
|
|
- [x] AST nodes
|
|
- [x] AST visitor
|
|
- [x] AST dumper
|
|
- [x] node position
|
|
- [x] handling comments
|
|
- [x] PHP 5 syntax analyzer
|
|
- [x] Tests
|
|
- [x] Namespace resolver
|
|
- [x] Pretty printer
|
|
- [ ] PhpDocComment parser
|
|
- [ ] Error handling
|
|
- [ ] Stabilize api
|
|
- [ ] Documentation
|
|
- [ ] Code flow graph
|