unbug4120 / directadmin-api
directadmin api的简单封装。
dev-master
2021-09-21 17:17 UTC
Requires
- guzzlehttp/guzzle: ^7.1@dev
This package is not auto-updated.
Last update: 2024-10-03 05:40:05 UTC
README
支持Laravel 7.x
安装
步骤 1. 安装包
composer require unbug4120/directadmin-api
步骤 2. 发布配置文件
使用以下命令发布配置文件
php artisan vendor:publish --provider="Unbug4120\LaravelDirectAdmin\DirectAdminServiceProvider"
步骤 3. 在.env文件上添加您的directadmin凭证
DIRECTADMIN_HOSTNAME=your-directadmin-hostname DIRECTADMIN_PORT=2222 DIRECTADMIN_USERNAME=your-username DIRECTADMIN_PASSWORD="your-directadmin-password" DIRECTADMIN_SERVERIP=your-server-ip
步骤 4. 清除配置缓存
然后不要忘记使用以下命令清除配置缓存文件
php artisan config:cache
用法
代码示例
获取用户列表
use Unbug4120\LaravelDirectAdmin\Facades\DirectAdmin; $result = DirectAdmin::getUserList(); dd($result);
创建新账户
要创建新账户,您必须为传递新账户参数添加 Unbug4120\LaravelDirectAdmin\NewAccountParameter 类。
use Unbug4120\LaravelDirectAdmin\Facades\DirectAdmin; use Unbug4120\LaravelDirectAdmin\NewAccountParameter; $newAccount = new NewAccountParameter(); $newAccount->domain = 'new-domain.com'; $newAccount->username = 'new-username'; $newAccount->passwd = 'new-userpass'; $newAccount->package = 'yourhostpackage'; $newAccount->email = 'usermail@gmail.com'; $result = DirectAdmin::createNewAccount($newAccount); dd($result);
删除账户
use Unbug4120\LaravelDirectAdmin\Facades\DirectAdmin; $userToDelete = 'usertodelete'; $result = DirectAdmin::deleteAccount($userToDelete); dd($result);
挂起账户
use Unbug4120\LaravelDirectAdmin\Facades\DirectAdmin; $userToSuspend = 'usertosuspend'; $result = DirectAdmin::suspendAccount($userToSuspend); dd($result);
取消挂起账户
use Unbug4120\LaravelDirectAdmin\Facades\DirectAdmin; $userToUnsuspend = 'usertounsuspend'; $result = DirectAdmin::unsuspendAccount($userToUnsuspend); dd($result);
贡献
随着DirectAdmin API的不断扩展,欢迎提出拉取请求,也欢迎提出特定功能的需求。拉取请求应包括实现或修正功能的适当单元测试。
有关单元测试的更多信息,请参阅测试文件夹中的 README.md。
法律
此软件是为内部使用开发的。它在MIT许可的宽松条款下向公众共享,不保证适合任何特定用途。有关详细信息,请参阅附带的LICENSE文件。
此项目与JBMC Software及其员工没有任何关联。