solitweb/laravel-directadmin

Laravel 5 DirectAdmin API wrapper

Laravel 5 DirectAdmin API wrapper

, _(*1)

Installation

You can install this package via Composer using:, _(*2)

composer require solitweb/laravel-directadmin

Laravel 5.5 uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider., _(*3)

Laravel 5.5+:

If you don't use auto-discovery, add the ServiceProvider to the providers array in config/app.php, _(*4)

// config/app.php
'providers' => [
    ...
    Solitweb\LaravelDirectAdmin\LaravelDirectAdminServiceProvider::class,
];

Optionally, register the facade:, _(*5)

// config/app.php
'aliases' => [
    ...
    'DirectAdmin' => Solitweb\LaravelDirectAdmin\LaravelDirectAdminFacade::class,
];

To publish the config file to app/config/laravel-directadmin.php run:, _(*6)

php artisan vendor:publish --provider="Solitweb\LaravelDirectAdmin\LaravelDirectAdminServiceProvider"

Usage

Import the facade at the top of your file., _(*7)

use DirectAdmin;

Examples

This will return an array of all users currently owned the reseller:, _(*8)

return DirectAdmin::get()->request('SHOW_USERS');

This will return an array of the user's usages:, _(*9)

return DirectAdmin::get()->request('SHOW_USER_USAGE', ['user' => 'john']);

For more commands check the DirectAdmin API docs. You have to copy the command without the CMD_API_., _(*10)

Magic Methods

It's also possible to make use of magic methods to get the data from the API as shown below:, _(*11)

$users = DirectAdmin::getShowAllUsers();
// Translates to DirectAdmin->get()->request('SHOW_ALL_USERS');

Arguments are also supported when using a magic method:, _(*12)

return DirectAdmin::postAccountAdmin([
    'action' => 'create',
    'username' => 'New Admin',
    ....
]);
// Translates to DirectAdmin->post()->request('ACCOUNT_ADMIN', [arguments]);

Magic Methods are named after the method (get/post) followed by the command without CMD_API_ in CamelCase. So, if you want to make a GET request with the CMD_API_SHOW_ALL_USERS command, the magic method would be getShowAllUsers()., _(*13)

JSON Support

It's possible to use JSON support, this allows using the HTTP code for feedback. No more annoying login screen errors on invalid login parameters., _(*14)

$data = DirectAdmin::get()->requestJson('SHOW_USERS');
$response = DirectAdmin::get_status_code();

Also added magic methods support:, _(*15)

$data = DirectAdmin::getJsonShowUsers();

Change user during runtime

It's also possible to change the user during runtime as shown below:, _(*16)

DirectAdmin::set_login('username', 'password')

Credits

• Phi1 'l0rdphi1' Stier
• Joshua de Gier / Pendo

License

The MIT License (MIT). Please see License File for more information., _(*17)