Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trollhunters501/phpenginenk
Run PHP on Nukkit!
https://github.com/trollhunters501/phpenginenk
jsenginenk nukkit php pocketmine
Last synced: 7 days ago
JSON representation
Run PHP on Nukkit!
- Host: GitHub
- URL: https://github.com/trollhunters501/phpenginenk
- Owner: Trollhunters501
- License: gpl-3.0
- Created: 2024-01-29T05:33:28.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-17T14:25:38.000Z (6 months ago)
- Last Synced: 2024-09-26T10:20:10.982Z (7 days ago)
- Topics: jsenginenk, nukkit, php, pocketmine
- Language: JavaScript
- Homepage: https://cloudburstmc.org/resources/phpenginenk.968/
- Size: 80.1 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHPEngineNK
Run PHP on Nukkit!
## Requirements:
JSEngineNK Plugin: https://cloudburstmc.org/resources/jsenginenk.939/
PHPLib Plugin: https://github.com/Trollhunters501/PHPLib
Know Basic JavaScript.
## IMPORTANT
### Why did I do it in JSEngineNK?
Because in PHP classes and non-object functions are not saved, that means that PHP functions cannot be called and only global objects set by the function (put) or (setNnClassLoader) are maintained.
To use PHP you can register a JavaScript function in the manager that then returns PHP code
```js
manager.createCommand("name", "description", "functionUsed", "usage", ["aliase1", "aliase2"], "perm.nk");
//TestPHP return new PHPEngineNK().build();
function functionUsed(sender, args, label, manageCMD){
TestPHP.put("sender", sender);
TestPHP.put("args", args);
TestPHP.put("label", label);
TestPHP.put("manageCMD", manageCMD);
TestPHP.eval("sendMessage("Hello world!"); ?>");
}
```
## Installation:
First create a script in JSEngineNK as said in your example.
Check if the Library is installed as follows:
```js
if(!script.getScriptByName("PHPEngineNK")){ //If it is not installed, we install it:
load("https://cdn.jsdelivr.net/gh/Trollhunters501/PHPEngineNK/src/Creadores%20Program/PHPEngineNK.js");
}
```
Then create an instance of the Engine:
```js
var TestPHP = new PHPEngineNK().build();
```
and then you can run PHP in Nukkit!
## Default objects globals:
server and getServer = returns the class cn.nukkit.Server
logger and getLogger = returns the JSEngineNK logger
plugin = returns the JSEngineNK main class
manager = returns the manager class JSEngineNK
## Examples:
### eval:
run PHP with string or reader!
```js
TestPHP.eval("info('hello world!'); ?>");
```
### put:
establish a global object that returns a java class or function (not compatible with javascript functions!)
```js
TestPHP.put("exampleName", ExampleJavaClass); //call in php: $exampleName->exampleFunction("hello world!");
```
### getEngineName:
returns the name of the engine (quercus) and the lib
```js
console.info("engine: " + TestPHP.getEngineName());
```
### setNnClassLoader:
set global objects of classes obtained from the Nnclassloader API
```js
//first parameter Nnclassloader API code second a json that the variable name is set as global object and the content of the variable is the class obtained from the API
TestPHP.setNnClassLoader({ urls: ["https://testurl.com/test.jar"] }, {
objectName: "class.package.example"
}); //PHP: $objectName->testFunctionInClass("hello world!");
```
### getLanguageVersion:
return PHP version
PHP versión default: 5.3.2
### getManager:
return manager engine (quercus)
### getEngine:
returns the original engine without the extra functions added by the library (quercus)
### getClass:
returns the JS library class
### getEngineClass:
returns the original engine class (quercus)
### ArrayToCode:
returns PHP code in string separated by lines without needing to put ";" nor the php tag
```js
TestPHP.eval(TestPHP.ArrayToCode(["$getLogger->info('hello world!')", "$getServer->getLogger()->info('hello world 2!')"]));
```
### printPHPCode:
returns PHP code in string to print a message in the console
Do not use in ArrayToCode
```js
TestPHP.eval("");
```
### ConvertPHP:
returns PHP code in string that converts the arguments into PHP code
Do not use in ArrayToCode
```js
TestPHP.eval("");
```
### evalFile:
run PHP in a PHP file (remember to create the file first)
```js
TestPHP.evalFile(manager.getFile("TestPHP", "Main.php"));
```
#### In plugins/JSEngineNK/TestPHP/Main.php:
```php
info("hello world!");
?>
```
### Call Java classes from PHP:
Call Java classes from PHP similar to JSEngineNK's Java.type
```php
$test = java_class("cn.nukkit.Server");
//or
import cn.nukkit.Server;
//with import you can extend the Java class with PHP!
```
Same as Java.type!
Creadores Program © 2024