README

CPanel UAPI 的 Laravel 包

请考虑为项目添加星标以表示您的喜爱并支持。

此 Laravel 包允许您使用 CPanel UAPI 管理基于 CPanel 的托管。

一些实际用途包括

• 以编程方式创建数据库、子域、电子邮件或账户等
• 以编程方式创建数据库用户
• 以编程方式为任何用户的数据库设置权限

更多关于 CPanel UAPI 的信息请参阅 CPanel UAPI 指南

安装

步骤 1) 安装包

使用以下 composer 命令安装包

composer require webreinvent/laravel-cpanel  

或将 webreinvent/laravel-cpanel 添加到 composer.json 中的需求

{
    ...
    "require": {
        ...
        "webreinvent/laravel-cpanel": "dev-master"
    },
}

更新 composer

$ composer update

步骤 2) 注册 ServiceProvider

在 config/app.php 中添加以下 service provider

/*  
 * Package Service Providers...  
 */ 
 'providers' => [  
        //...  
        WebReinvent\CPanel\CPanelServiceProvider::class,   
        //...  
    ],

步骤 3) 发布配置

运行以下命令

php artisan vendor:publish --provider="WebReinvent\CPanel\CPanelServiceProvider" --tag=config

步骤 4) 在 .env 中设置 CPanel 详细信息

CPANEL_DOMAIN= 
CPANEL_PORT=
CPANEL_API_TOKEN=
CPANEL_USERNAME=

或

$cpanel = new CPanel($cpanel_domain=null, $cpanel_api_token=null, $cpanel_username=null, $protocol='https', $port=2083);

要生成 CPANEL_API_TOKEN，请登录到 CPanel >> 安全 >> 管理API令牌 >> 创建。

用法及可用方法

确保您已导入

use WebReinvent\CPanel\CPanel;

创建数据库

数据库名称应使用 cpanel 用户名作为前缀 cpanelusername_databasename

如果您的 CPanel 用户名是 foo，则您的数据库名称应为 foo_website。

$cpanel = new CPanel();
$response = $cpanel->createDatabase('cpanelusername_databasename');

更多信息请参阅 CPanel UAPI - Mysql::create_database

删除数据库

$cpanel = new CPanel();  
$response = $cpanel->deleteDatabase('cpanelusername_databasename');

CPanel UAPI - Mysql::delete_database

获取 CPanel 中所有数据库的列表

$cpanel = new CPanel();  
$response = $cpanel->listDatabases();

创建数据库用户

$cpanel = new CPanel();  
$response = $cpanel->createDatabaseUser($username, $password);

删除数据库用户

$cpanel = new CPanel();  
$response = $cpanel->deleteDatabaseUser($username);

将数据库的所有权限授予数据库用户

$cpanel = new CPanel();  
$response = $cpanel->setAllPrivilegesOnDatabase($database_user, $database_name);

这些都是可用方法，但您也可以使用以下方法调用 CPanel UAPI 中提供的所有方法

$cpanel = new CPanel();  
$response = $cpanel->callUAPI($Module, $function, $parameters_array);

示例：如果您想添加新的 ftp 账户，请参阅 CPanel UAPI - Ftp::add_ftp 中的文档，然后使用以下方法

$cpanel = new CPanel();  
$Module = 'Ftp';
$function = 'add_ftp';
$parameters_array = [
'user'=>'ftp_username',
'pass'=>'ftp_password', //make sure you use strong password
'quota'=>'42',
];
$response = $cpanel->callUAPI($Module, $function, $parameters_array);

支持我们

WebReinvent 是一家位于印度新德里的网络公司。您可以在 github 上找到我们所有开源项目的概述。

许可证

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