syntaxevolution/laravel-directadmin

Laravel 6 DirectAdmin API 包装器

1.1.5 2020-12-20 21:16 UTC

This package is auto-updated.

Last update: 2024-09-21 06:05:58 UTC


README

Latest Version Software License Build Status Total Downloads

安装

您可以通过Composer使用以下命令安装此包:

composer require syntaxevolution/laravel-directadmin

Laravel 6 使用包自动发现,因此不需要您手动添加 ServiceProvider。

Laravel 6+

如果您不使用自动发现,请将 ServiceProvider 添加到 config/app.php 中的 providers 数组中

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

可选地,注册 facade

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

要发布配置文件到 app/config/laravel-directadmin.php,请运行

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

用法

在文件顶部导入 facade。

use DirectAdmin;

示例

这将返回一个数组,其中包含当前由代理商拥有的所有用户

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

这将返回用户的用量数组

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

有关更多命令,请参阅 DirectAdmin API 文档。您必须复制命令,但不能包含 CMD_API_

魔术方法

还可以使用以下示例所示的方式利用魔术方法从 API 获取数据

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

在使用魔术方法时也支持参数

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

魔术方法以方法名(get/post)后跟不带 CMD_API_ 的命令,并以驼峰式命名。因此,如果您想使用 CMD_API_SHOW_ALL_USERS 命令进行 GET 请求,魔术方法将是 getShowAllUsers()

致谢

许可

MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件