112 lines
2.3 KiB
Markdown
112 lines
2.3 KiB
Markdown
|
## Installation
|
||
|
|
|
||
|
|
You can use the LonaDB PHP Client by including it in your project. Simply download the `LonaDB.php` file and include it in your PHP project.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
To use the `LonaDB` PHP Client, follow these steps:
|
||
|
|
|
||
|
|
1. Include the `LonaDB` class in your PHP file:
|
||
|
|
|
||
|
|
```php
|
||
|
|
require_once('path/to/LonaDB.php');
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Create an instance of the `LonaDB` class by providing the required connection details:
|
||
|
|
|
||
|
|
```php
|
||
|
|
$client = new LonaDB($host, $port, $name, $password);
|
||
|
|
```
|
||
|
|
|
||
|
|
Replace `$host`, `$port`, `$name`, and `$password` with the appropriate values for your LonaDB Server.
|
||
|
|
|
||
|
|
3. Use the provided methods to interact with the server:
|
||
|
|
|
||
|
|
```php
|
||
|
|
// Example: Get a list of tables
|
||
|
|
$tables = $client->getTables("username");
|
||
|
|
|
||
|
|
// Display the list of tables
|
||
|
|
print_r($tables);
|
||
|
|
```
|
||
|
|
|
||
|
|
## Available Methods
|
||
|
|
|
||
|
|
### `getTables(username)`
|
||
|
|
|
||
|
|
Retrieves a list of tables available in the database.
|
||
|
|
|
||
|
|
### `getTableData(table)`
|
||
|
|
|
||
|
|
Retrieves data from a specified table.
|
||
|
|
|
||
|
|
### `deleteTable(name)`
|
||
|
|
|
||
|
|
Deletes a table by its name.
|
||
|
|
|
||
|
|
### `createTable(name)`
|
||
|
|
|
||
|
|
Creates a new table with the given name.
|
||
|
|
|
||
|
|
### `set(table, name, value)`
|
||
|
|
|
||
|
|
Sets a variable within a table to the specified value.
|
||
|
|
|
||
|
|
### `delete(table, name)`
|
||
|
|
|
||
|
|
Deletes a variable from a table.
|
||
|
|
|
||
|
|
### `get(table, name)`
|
||
|
|
|
||
|
|
Retrieves the value of a variable from a table.
|
||
|
|
|
||
|
|
### `getUsers()`
|
||
|
|
|
||
|
|
Retrieves a list of users in the database.
|
||
|
|
|
||
|
|
### `createUser(name, password)`
|
||
|
|
|
||
|
|
Creates a new user with the given name and password.
|
||
|
|
|
||
|
|
### `deleteUser(name)`
|
||
|
|
|
||
|
|
Deletes a user by their name.
|
||
|
|
|
||
|
|
### `checkPassword(name, password)`
|
||
|
|
|
||
|
|
Checks if the provided password is correct for a given user.
|
||
|
|
|
||
|
|
### `checkPermission(user, permission)`
|
||
|
|
|
||
|
|
Checks if a user has a specific permission.
|
||
|
|
|
||
|
|
### `removePermission(user, permission)`
|
||
|
|
|
||
|
|
Removes a permission from a user.
|
||
|
|
|
||
|
|
### `getPermissionsRaw(name)`
|
||
|
|
|
||
|
|
Retrieves the raw permission data for a user.
|
||
|
|
|
||
|
|
### `addPermission(user, permission)`
|
||
|
|
|
||
|
|
Adds a permission to a user.
|
||
|
|
|
||
|
|
### `createFunction(name, content)`
|
||
|
|
|
||
|
|
Create a function which can be executed whenever you want. Just like eval.
|
||
|
|
Content = string of PHP code
|
||
|
|
|
||
|
|
### `executeFunction(name)`
|
||
|
|
|
||
|
|
Executes the function
|
||
|
|
|
||
|
|
### `eval(function)`
|
||
|
|
|
||
|
|
Runs the function (must be a string of PHP code) </br>
|
||
|
|
Example: "if($abc === 1234) return 'wtf';"
|
||
|
|
Response: {"success": true, "response": "wtf", "process": processID}
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
This project is licensed under the GNU Affero General Public License version 3 (GNU AGPL-3.0).
|