README

库名：Laravel CPanel API

此库提供了一种方便的方式，使用 Laravel 与 cPanel API 进行交互。它允许您执行各种 cPanel 功能，如创建子域名、管理数据库、处理电子邮件账户以及管理磁盘使用情况。

安装

要在您的 Laravel 项目中使用此库，您可以通过 Composer 安装它。在终端中运行以下命令：


composer require mhasnainjafri/cpanel

用法

要开始使用，您需要创建一个新的 Cpanel 类实例。有两种初始化类的方式

无任何参数

$cpanel = new Cpanel();

带参数（如果未在 .env 文件中定义）

$cpanel = new Cpanel($cpanel_domain, $cpanel_api_token, $cpanel_username, 'https', 2083);

或者，您可以在 .env 文件中设置 cPanel 凭据

CPANEL_DOMAIN=domain e.g : xyz.com
CPANEL_PORT=cpanel port (mostly is) 2083
CPANEL_API_TOKEN= Cpanel api token (To get api token view step 3)
CPANEL_USERNAME= Cpanel username

获取 Cpanel Api 的步骤

在 cpanel 搜索栏中搜索 api
点击 管理 api 令牌
给令牌命名并点击创建
复制您获得的令牌

子域名功能

要创建子域名，请使用 createSubDomain() 方法

$cpanel->createSubDomain('Sub domain e.g: web', 'domain e.g: xyz.com', 'Path where subdomain points e.g: /home/domain/public_html/subdomain');

数据库功能

要列出所有数据库，请使用 listDatabases() 方法

$cpanel->listDatabases();

要创建新数据库，请使用 createDatabase() 方法

$cpanel->createDatabase('Database Name');

要删除数据库，请使用 deleteDatabase() 方法

$cpanel->deleteDatabase('Database Name');

要创建数据库用户，请使用 createDatabaseUser() 方法

$cpanel->createDatabaseUser('Database username', 'password');

要删除数据库用户，请使用 deleteDatabaseUser() 方法

$cpanel->deleteDatabaseUser('Database username');

要为用户设置数据库的所有权限，请使用 setAllPrivilegesOnDatabase() 方法

$cpanel->setAllPrivilegesOnDatabase('Database username', 'Database Name');

邮件功能

要创建 POP 电子邮件账户，请使用 createPopEmailAccount() 方法

$cpanel->createPopEmailAccount('mail@domain.com', 'password');

要删除 POP 电子邮件账户，请使用 deletePopEmailAccount() 方法

$cpanel->deletePopEmailAccount('mail@domain.com');

要编辑电子邮件账户的邮箱配额，请使用 editMailboxQuota() 方法

$cpanel->editMailboxQuota($email, $domain, $quota);

要分派电子邮件账户的客户端设置，请使用 dispatchClientSettings() 方法

$cpanel->dispatchClientSettings('mail@domain.com', 'account');

要获取 POP 电子邮件数量，请使用 getPopEmailCount() 方法

$cpanel->getPopEmailCount();

cPanel 磁盘管理

要获取 cPanel 统计条带宽使用或磁盘使用的统计信息，请使用 getCpanelStatsBarStats() 方法

$cpanel->getCpanelStatsBarStats('bandwidthusage|diskusage');

要获取 cPanel 磁盘配额信息，请使用 getCpanelDiskQuotaInfo() 方法

$cpanel->getCpanelDiskQuotaInfo();

其他 API 功能

要调用任何其他 cPanel API 功能，请使用 callUAPI() 方法

$cpanel->callUAPI($Module, $function, $parameters_array = array());

将 $Module 替换为所需的模块，将 $function 替换为函数名称，将 $parameters_array 替换为 API 函数所需的任何附加参数。

就是这样！您现在可以利用 Laravel CPanel API 库的力量，在 Laravel 应用程序中无缝地与 cPanel API 交互。

测试

composer test

变更日志

有关最近更改的更多信息，请参阅 CHANGELOG。

贡献

有关详细信息，请参阅 CONTRIBUTING。

安全

如果您发现任何与安全相关的问题，请通过电子邮件 mhasnainjafri0099@gmail.com 而不是使用问题跟踪器来联系。

鸣谢

许可证

麻省理工学院许可证（MIT）。请参阅许可证文件获取更多信息。

Laravel 包模板

本包是使用Laravel 包模板生成的。

mhasnainjafri / cpanel

维护者

详细信息