README

Installation

You can install this package via Composer using:

composer require syntaxevolution/laravel-directadmin

Laravel 6 uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.

Laravel 6+:

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

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

Optionally, register the facade:

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

To publish the config file to app/config/laravel-directadmin.php run:

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

Usage

Import the facade at the top of your file.

use DirectAdmin;

Examples

This will return an array of all users currently owned the reseller:

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

This will return an array of the user's usages:

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_.

Magic Methods

It's also possible to make use of magic methods to get the data from the API as shown below:

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

Arguments are also supported when using a magic method:

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().

Credits

License

The MIT License (MIT). Please see License File for more information.

syntaxevolution / laravel-directadmin

Maintainers

Details