zanysoft/cpanel-api

v3.2 2023-02-16 05:42 UTC

This package is auto-updated.

Last update: 2024-09-16 09:01:42 UTC


README

Laravel 的 Cpanel API 1 和 2

内容

安装指南

在 composer.json 中包含此包并更新 composer,这将下载此包。

composer require zanysoft/cpanel-api

如果使用 < Laravel 5.5,请将 ServiceProvider 和 Aliases 添加到 config/app.php

'providers' => [
    '...',
    ZanySoft\Cpanel\CpanelServiceProvider::class,
];

'aliases' => [
    '...',
    'Cpanel' => ZanySoft\Cpanel\Facades\Cpanel::class,
];

配置

默认配置设置在 config/cpanel.php 中。将此文件复制到您的配置目录以修改值。您可以使用此命令发布配置

php artisan vendor:publish --provider="ZanySoft\Cpanel\CpanelServiceProvider"

使用

您可以创建一个新的 Cpanel 实例。

$cpanel = Cpanel::make();
$cpanel->setHost($host_ip);
$cpanel->setAuth($username, $password) //if you don't want to set in config file
return $cpanel->api2($user, $module, $function, $args = array());

或者使用外观

return Cpanel::api2($user, $module, $function, $args = array());

您可以使用外观通过链式调用方法

return Cpanel::setHost($host_ip)->setAuth($username, $password)->api2($user, $module, $function, $args = array());

如果您不想在 config/cpanel.php 文件中设置此配置,可以在链式调用之前设置认证。

return Cpanel::setAuth($username, $password)->api2($user, $module, $function, $args = array());

如果您不想在 config/cpanel.php 文件中设置此配置,可以在创建实例时设置主机、用户名和密码。

$cpanel = new \ZanySoft\Cpanel\Cpanel($host,$username, $password);
// OR
$cpanel = Cpanel::make($host,$username, $password);

函数

这是您想要定义配置时的示例

  <?php
    $cpanel = App::make('cpanel');
    $cpanel->setHost($host_ip);
    $cpanel->setAuth($username, $password)
    return $cpanel->api2($user, $module, $function, $args = array());

如果您想从 cPanel/WHM 获取一些帐户列表

	<?php

	$accounts = $cpanel->listaccts();
	// passing parameters
	$accounts = $cpanel->listaccts($searchtype, $search);
	

如果您想创建新的子域名

	<?php
	
	// createSubdomain(Domain Name, Username, Dubdomain Directory, Main Domain)
         $cpanel->createSubdomain('subdomain', 'username', '/public_html/subdomain', 'example.com')

要访问 cPanel API 2,可以使用此方法。

	<?php
	
	return $cpanel->api2($user, $module, $function, $args = array());

要访问 cPanel API 1,可以使用此方法。

	<?php
	
	return $cpanel->api1($user, $module, $function, $args = array());

文档

访问此链接获取 api2 选项: https://documentation.cpanel.net/display/SDK/Guide+to+cPanel+API+2

访问此链接获取 api1 选项: https://documentation.cpanel.net/display/SDK/Guide+to+cPanel+API+1