README

使用 PHP 通过 API 执行 WHM 和 Cpanel 操作

安装

使用以下命令安装最新版本

$ composer require  alaa-hany/awhm

要求

• 需要 PHP 7.0 或更高版本

目前支持的操作

• WHM
  • 账户
    • 获取所有 Cpanel 账户
    • 创建新的 Cpanel 用户
    • 删除 Cpanel 用户
    • 获取暂停的 Cpanel 用户
    • 暂停 Cpanel 用户
    • 取消暂停 Cpanel 用户
  • 服务
    • 重启服务
    • 启用服务
    • 禁用服务
    • 获取服务状态
    • 获取服务配置
  • 邮件
    • 获取 Cpanel 用户的电子邮件账户
• Cpanel
  • 目前不支持的操作

基本用法

// All API Calls made throw HTTPS 
use \Alaa\Awhm\base\WHMClient ;
$ipOrDomain = "YOUR_IP_OR_DOMAIN"; // IP is preferred , we take care of get Domain
$user  = 'root' ; //  for example
$token = "YOUR_TOKEN" ; //
$whmClient = new WHMClient($ipOrDomain , $user , $token);

//--------- Accounts ---------//

// get All Cpanel users
var_dump($whmClient->accountsManagementInstance()->all());

// Create Cpanel users
$diskSizeInMegaBytes = 500; // Default unlimited
var_dump ($whmClient->accountsManagementInstance()->create("USER_NAME" , "PASSWORD" , $diskSizeInMegaBytes));
 
// get All suspended Cpanel users
var_dump ($whmClient->accountsManagementInstance()->suspensions());

// suspend Cpanel user
var_dump ($whmClient->accountsManagementInstance()->suspendCpanelUser("CPANEL_USER_NAME"));

// suspend Cpanel users
var_dump ($whmClient->accountsManagementInstance()->unsuspendCpanelUser("CPANEL_USER_NAME"));

// delete Cpanel users
var_dump ($whmClient->accountsManagementInstance()->delete("CPANEL_USER_NAME"));

//----------- Services -----------//

/**
*  \Alaa\Awhm\whm\services\Services class contain some service name , You can use it or pass service's Name 
 */

// restart service
var_dump ($whmClient->servicesManagementInstance()->restartService(\Alaa\Awhm\whm\services\Services::HTTP));

// Disable Service
var_dump ($whmClient->servicesManagementInstance()->disableService(\Alaa\Awhm\whm\services\Services::FTP));

// Enable Service
var_dump ($whmClient->servicesManagementInstance()->enableService(\Alaa\Awhm\whm\services\Services::FTP));

// Get Service Config
var_dump ($whmClient->servicesManagementInstance()->getServiceConfig(\Alaa\Awhm\whm\services\Services::FTP));

// Get Service Status
var_dump ($whmClient->servicesManagementInstance()->getServiceStatus(\Alaa\Awhm\whm\services\Services::FTP));

//------- Mail --------//

// Get email accounts of Cpanel user
var_dump ($whmClient->mailManagementInstance()->getEmailAccountsOfCpanelUser("CPANEL_USER_NAME"));

注意

如果您需要任何不存在的操作，欢迎订购。
联系我：
  电子邮件：elboray.alaa1@gmail.com
  whatsapp：+201063745208

许可证

alaa-hany/awhm 在 MIT 许可证下授权。