Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asmblah/uniter
🎉 PHP in the browser and Node.js => Docs: https://phptojs.com/
https://github.com/asmblah/uniter
javascript php transpiler
Last synced: 1 day ago
JSON representation
🎉 PHP in the browser and Node.js => Docs: https://phptojs.com/
- Host: GitHub
- URL: https://github.com/asmblah/uniter
- Owner: asmblah
- License: other
- Created: 2013-08-03T17:07:13.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-09-19T06:14:51.000Z (over 1 year ago)
- Last Synced: 2025-01-29T06:29:05.014Z (8 days ago)
- Topics: javascript, php, transpiler
- Language: JavaScript
- Homepage: https://asmblah.github.io/uniter/
- Size: 6.31 MB
- Stars: 446
- Watchers: 28
- Forks: 42
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE.txt
Awesome Lists containing this project
README
======
[](https://github.com/asmblah/uniter/actions?query=workflow%3ACI) [](https://gitter.im/asmblah/uniter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Run PHP client-side in the browser or in Node.js.
[
](https://asmblah.github.io/uniter/demo/interactive.html)
[Try it now](https://asmblah.github.io/uniter/demo/interactive.html)
Demos
-----
- [jQuery + PHP + Browserify (with PHPUnit)](https://uniter.github.io/uniter-jquery)
- [Interactive demo (above)](https://asmblah.github.io/uniter/demo/interactive.html)
- [Simple REPL](https://codepen.io/jcubic/pen/VGYBVj?editors=0010)
Packages
--------
Uniter is split into several NPM packages, each with a separate repository:
| Package | Version | Dependencies |
|--------|-------|------------|
| [`uniter`](https://github.com/asmblah/uniter) | [](https://www.npmjs.com/package/uniter) | [](https://david-dm.org/asmblah/uniter) |
| [`phptoast`](https://github.com/uniter/phptoast) | [](https://www.npmjs.com/package/phptoast) | [](https://david-dm.org/uniter/phptoast) |
| [`phptojs`](https://github.com/uniter/phptojs) | [](https://www.npmjs.com/package/phptojs) | [](https://david-dm.org/uniter/phptojs) |
| [`phpcore`](https://github.com/uniter/phpcore) | [](https://www.npmjs.com/package/phpcore) | [](https://david-dm.org/uniter/phpcore) |
| [`phpruntime`](https://github.com/uniter/phpruntime) | [](https://www.npmjs.com/package/phpruntime) | [](https://david-dm.org/uniter/phpruntime) |
| [`phpcommon`](https://github.com/uniter/phpcommon) | [](https://www.npmjs.com/package/phpcommon) | [](https://david-dm.org/uniter/phpcommon) |
| [`phpify`](https://github.com/uniter/phpify) | [](https://www.npmjs.com/package/phpify) | [](https://david-dm.org/uniter/phpify) |
| [`dotphp`](https://github.com/uniter/dotphp) | [](https://www.npmjs.com/package/dotphp) | [](https://david-dm.org/uniter/dotphp) |
[`uniter`](https://github.com/asmblah/uniter) is the main Uniter library (this repository).
It pulls in all the required components (below) to take a string of PHP code, evaluate it and return the result
with a simple API.
[`phptoast`](https://github.com/uniter/phptoast) is the parser for Uniter. It takes PHP code as a string
and returns an AST comprised of plain JavaScript objects.
[`phptojs`](https://github.com/uniter/phptojs) is the transpiler. It takes an AST (such as the one returned by `phptoast`)
and translates it into JavaScript
that can then be executed.
[`phpcore`](https://github.com/uniter/phpcore) is the minimal runtime library required for code transpiled by `phptojs` to execute.
It contains some builtin PHP classes and functions, but only those that are required
(eg. the `Closure` class or `spl_autoload_register(...)` function).
[`phpruntime`](https://github.com/uniter/phpruntime) is the extended "full" runtime library.
After pulling in `phpcore`, it installs the remaining builtin classes and functions, such as `array_merge(...)`.
Only a small subset of PHP's standard library has been implemented so far - please open a GitHub issue
in the `phpruntime` repository if you would like to request something that is missing.
[`phpcommon`](https://github.com/uniter/phpcommon) contains various tools that are shared between the different
packages, such as the `PHPFatalError` class used by both the parser (`phptoast`) and runtime (`phpcore`).
[`phpify`](https://github.com/uniter/phpify) is a Browserify transform that can be used to require PHP modules
(and entire libraries) from JavaScript.
For an example of compiling a PHP library down to JavaScript,
see the [Uniter Symfony EventDispatcher demo](https://github.com/uniter/event-dispatcher-demo).
[`dotphp`](https://github.com/uniter/dotphp) allows for easily including PHP files from Node.js.
A `require(...)` extension may be installed by using the `/register` script or PHP files may simply be required
with the exported `.require(...)` method. Stderr and stdout are mapped to the process' stderr and stdout respectively,
and the filesystem/ `include/require/_once(...)` access is mapped to the real filesystem.
Getting started
---------------
```shell
$ npm install uniter
$ node
```
```javascript
> var php = require('uniter').createEngine('PHP');
> php.getStdout().on('data', function (text) { console.log(text); });
> php.execute('` operator)
- Static class property/method access (`::` operator), `self::` construct
- `use` statement for `class`, `namespace` and `function` importing and aliasing
- Magic `__autoload(...)` function
- Magic `__DIR__`, `__FILE__` and `__LINE__` constants
- Ternary operator
- Loose equality `==` and inequality `!=` comparison operators
- Strict equality `===` and inequality `!==` comparison operators
And others... see [the `Engine` integration tests](https://github.com/asmblah/uniter/tree/master/tests/bdd/integration/languages/PHP/engine) for more info.
Using on the command line
-------------------------
You can use Uniter from the command line after installing it via NPM, eg.:
```sh
# Install Uniter globally
$ npm install -g uniter
# Execute PHP code
$ uniter -r 'echo 7 + 2;'
9
# Parse PHP but just dump the AST as JSON, don't attempt to execute
$ uniter -r 'echo 7 + 2;' --dump-ast
{
"statements": [
{
"expression": {
"left": {
"number": "7",
"name": "N_INTEGER"
},
"right": [
{
"operator": "+",
"operand": {
"number": "2",
"name": "N_INTEGER"
}
}
],
"name": "N_EXPRESSION"
},
"name": "N_ECHO_STATEMENT"
}
],
"name": "N_PROGRAM"
}
```
Keeping up to date
------------------
- [Follow me on Twitter](https://twitter.com/@asmblah) for updates: [https://twitter.com/@asmblah](https://twitter.com/@asmblah)
Running the tests
-----------------
There are two supported ways of running the Mocha test suite:
1. Run the tests in Node.js from the command line:
cd uniter/
npm test
2. Run the tests in a browser by starting a Node.js server:
npm run-script webtest
You should then be able to run the tests by visiting http://127.0.0.1:6700 in a supported web browser.
License
-------
[MIT](/MIT-LICENSE.txt)
Contributors
-------
[Pharaoh Tools](https://github.com/PharaohTools)