php-parser
This javascript library parses PHP code and convert it to AST.
Installation
This library is distributed with npm :
npm install php-parser-indent --save
Usage
// initialize the php parser factory classvar fs = ;var path = ;var engine = ; // initialize a new parser instancevar parser = // some options : parser: extractDoc: true php7: true ast: withPositions: true ; // Retrieve the AST from the specified sourcevar eval = parser; // Retrieve an array of tokens (same as php function token_get_all)var tokens = parser; // Load a static file (Note: this file should exist on your computer)var phpFile = fs; // Log out resultsconsole;console;console;
Sample AST output
'kind': 'program' 'children': 'kind': 'echo' 'arguments': 'kind': 'string' 'isDoubleQuote': true 'value': 'Hello World'
- Try it online (demo) : http://glayzzle.com/php-parser/#demo
- Or from AST Explorer : https://astexplorer.net/
API Overview
The main API exposes a class with the following methods :
- parseEval(String|Buffer) : parse a PHP code in eval style mode (without php open tags)
- parseCode(String|Buffer, String filename) : parse a PHP code by using php open tags.
- tokenGetAll(String|Buffer) : retrieves a list of all tokens from the specified input.
You can also pass options that change the behavior of the parser/lexer.
Documentation
Related projects
- babel-preset-php : Babel preset for converting PHP syntax to JavaScript. It can run subset of PHP in the browser or in Node.js. .
- php-unparser : Produce code that uses the style format recommended by PSR-1 and PSR-2.
- php-writer : Update PHP scripts from their AST
- ts-php-inspections : Provide PHP code inspections written in typescript
- php-reflection : Reflection API for PHP files
- wp-pot : Generate pot file for WordPress plugins and themes
- crane : PHP Intellisense/code-completion for VS Code
You can add here your own project by opening an issue request.
Misc
This library is released under BSD-3 license clause.
If you want to contribute please visit this repository https://github.com/glayzzle/php-parser-dev.