solitweb / laravel-directadmin
Laravel 5 DirectAdmin API 包装器
1.0.13
2024-03-20 08:37 UTC
Requires
- php: ~5.6|~7.0|~7.1|~7.2|~7.3|~7.4|~8.0|~8.1|~8.2|~8.3
- illuminate/support: ^5.0|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
- solitweb/directadmin: ^3.0.1
Requires (Dev)
- mockery/mockery: ^0.9.4
- phpunit/phpunit: ^4.8
README
安装
您可以通过 Composer 使用以下命令安装此包
composer require solitweb/laravel-directadmin
Laravel 5.5 使用包自动发现,因此不需要您手动添加 ServiceProvider。
Laravel 5.5+
如果您不使用自动发现,请将 ServiceProvider 添加到 config/app.php 文件中的 providers 数组中
// config/app.php 'providers' => [ ... Solitweb\LaravelDirectAdmin\LaravelDirectAdminServiceProvider::class, ];
可选地,注册 facade
// config/app.php 'aliases' => [ ... 'DirectAdmin' => Solitweb\LaravelDirectAdmin\LaravelDirectAdminFacade::class, ];
要发布配置文件到 app/config/laravel-directadmin.php,运行以下命令
php artisan vendor:publish --provider="Solitweb\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()
。
JSON 支持
可以使用 JSON 支持,这允许使用 HTTP 状态码进行反馈。不再会有因无效登录参数而引起的讨厌的登录屏幕错误。
$data = DirectAdmin::get()->requestJson('SHOW_USERS'); $response = DirectAdmin::get_status_code();
还增加了魔术方法支持
$data = DirectAdmin::getJsonShowUsers();
运行时更改用户
还可以在运行时更改用户,如下所示
DirectAdmin::set_login('username', 'password')
致谢
许可证
MIT 许可证(MIT)。有关更多信息,请参阅 许可证文件。