https://github.com/11ways/doen
A bridge between PHP & Node.js
https://github.com/11ways/doen
Last synced: 6 months ago
JSON representation
A bridge between PHP & Node.js
- Host: GitHub
- URL: https://github.com/11ways/doen
- Owner: 11ways
- License: mit
- Created: 2021-03-18T20:46:53.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-23T13:34:40.000Z (almost 3 years ago)
- Last Synced: 2024-10-02T20:16:15.236Z (9 months ago)
- Language: PHP
- Size: 31.3 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/contributing.md
- License: LICENSE
- Code of conduct: .github/code_of_conduct.md
Awesome Lists containing this project
README
elevenways/doen
Asynchronously call JavaScript code from within PHP
## Introduction
Have you ever needed to use the functionality of a node.js package in your PHP project, but don't want to spend hours writing a wrapper? Well now you can.
Thanks to ReactPHP it was quite a simple script to get working.
## Installation
Installation is easy via [Composer](https://getcomposer.org/):
```bash
$ composer require elevenways/doen
```
Or you can add it manually to your `composer.json` file.
## Usage
### Simple `require()` example
```php
// You will need an event loop instance.
// If this looks weird to you, you should lookup ReactPHP
$loop = \React\EventLoop\Factory::create();
// Now we can create a Doen instance
$doen = new \Elevenways\Doen\Doen($loop);
// Lets get our first, simple reference
// $libpath is now an \Elevenways\Doen\Reference instance
$libpath = $doen->evaluateToRef('require("path")');
// Even though the code is happening asynchronously, we can already act upon it
// This will return yet another \Elevenways\Doen\Reference instance
$str = $libpath->join('a', 'b', 'c');
// Now we can get the value
$str->getValue()->then(function ($value) {
// This will print out a/b/c
echo $value;
});
// This, again, is part of ReactPHP.
// It starts the event loop and will BLOCK the rest of the code!
$loop->run();
```
## API
### Doen
#### new Doen(\React\EventLoop\LoopInterface $loop, array $options = [])
Create a new Doen instance, which always creates a new Node.js instance too.
By default it'll use the `node` binary, but this can be overridden with the `node_path` option.
#### require(string $name) ⇒ `\Elevenways\Doen\Reference`
Require a node.js module and return a reference to it.
```php
$libpath = $doen->require('path');
```
#### evaluate(string $code) ⇒ `\React\Promise\Promise`
Execute an expression and return its value.
```php
$promise = $doen->evaluate('1 + 1');
```
#### evaluateFunction(string $function, $args = []) ⇒ `\React\Promise\Promise`
Execute a function with the supplied arguments and return its value.
```php
$promise = $doen->evaluate('function(a, b) {return a * b}', [3, 2]);
```
#### evaluateToRef(string $code, $args = null) ⇒ `\Elevenways\Doen\Reference`
Execute an expression or a function and return a reference to its value.
```php
$libpath = $doen->evaluateToRef('require("path")');
```
#### close() ⇒ `void`
Close the node.js process
```php
$doen->close();
```
### Reference
#### getValue(callable $on_fulfilled = null, callable $on_rejected = null) ⇒ `\React\Promise\Promise`
Get the actual value of the reference
```php
$ref = $doen->evaluateToRef('1 + 1');
$ref->getValue(function($result) {
// Outputs: 2
echo $result;
});
```
#### then(callable $on_fulfilled = null, callable $on_rejected = null) ⇒ `\React\Promise\Promise`
Execute the callables when this reference resolves.
It will **not** resolve to its value, but to its type for primitives and to its class for objects.
```php
$ref = $doen->evaluateToRef('1 + 1');
$ref->then(function($type) {
// Outputs: "number"
echo $type;
});
$array = $doen->evaluateToRef('[]');
$ref->then(function($type) {
// Outputs: "Array"
echo $type;
});
```
#### __monkeyPatch($method_name, Closure $fnc) ⇒ `void`
Add a method to this instance on-the-fly
```php
$ref = $doen->evaluateToRef('1 + 1');
$ref->__monkeyPatch('weird', function() {
return 'weird';
});
// Returns "weird"
$ref->weird();
```
## Contributing
Contributions are REALLY welcome.
Please check the [contributing guidelines](.github/contributing.md) for more details. Thanks!
## Authors
- **Jelle De Loecker** - *Follow* me on *Github* ([:octocat:@skerit](https://github.com/skerit)) and on *Twitter* ([🐦@skeriten](http://twitter.com/intent/user?screen_name=skeriten))
See also the list of [contributors](https://github.com/11ways/doen/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/11ways/doen/LICENSE) file for details.