Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/niklasvh/php.js

PHP to JavaScript converter and VM written in JavaScript
https://github.com/niklasvh/php.js

Last synced: 3 days ago
JSON representation

PHP to JavaScript converter and VM written in JavaScript

Awesome Lists containing this project

README

        

php.js
======

### PHP VM in JavaScript ###

This library reads PHP code and transforms it into JavaScript code which can be run in the PHP VM in this library, resulting in same results as with PHP. It starts by tokenizing the PHP code into tokens, which it then uses to build an AST tree. Once the tree has been constructed, the script compiles it into JavaScript that can be interpreted by the VM and then executes it. Any additional unconverted code that gets executed within the VM, such as eval or lambda functions will go through the same process before being executed.

The code can be directly run in your browser, meaning you can execute php code straight out of your browser! It can also be run on node.js, but strongly recommend not to, due to potential security issues.

## Some examples ##

- Magic methods (2, 3)
- ArrayAccess
- Lamba functions
- Engine execution orders (2,3)
- foreach with references
- tokenizer

## Usage ##
var engine = new PHP ('', options);
console.log(engine.vm.OUTPUT_BUFFER); // the outputted buffer from the script

The code is by default run synchronously so the output will be immidiately readable upon the engine finishing execution. Alternatively, the VM can be set to run under a web worker as well, in which case a callback function will need to be provided.

## Status ##

This project was purely for my personal learning. If it isn't obvious, this shouldn't be incorporated in any type of application, and the only reason it is open source is that if someone would find useful information or parts from it. I took a test driven approach to developing this library, which means that I have been mostly focusing on getting the php unit tests (which PHP uses itself) to work correctly. If a certain functionality hasn't been a part of the base unit tests (around 670 in total), it most likely won't work or only works partially. Additionally, only a fraction of module functions have been implemented, and even for the ones that have been, many of them are only partially implemented (i.e. signature checks haven't really been implemented to any functions, although user created functions support them). However, additional functions can easily be added, as they can be written in PHP and have them compiled into JavaScript.

The current status of the passing tests can be seen here. I'll be the first admit that there are still a lot of bugs, but considering the complexity of the language, it is well on its way.

## Building ##
npm install
grunt

## License ##
JavaScript code licensed under MIT license
PHP Files and tests under The PHP License, version 3.01

## Credits ##
- Test cases from php-src - The PHP License, version 3.01
- Grammar parser adapted from PHP-Parser - by Nikita Popov

## Questions & Comments ##

If you encounter a bug, please feel free to post it on GitHub. For questions or comments, you can contact me at Twitter @niklasvh or Google Plus