swalker2/cpanel

为Laravel提供的cpanel版本2 API最简单的PHP实现

v1.1 2017-02-03 20:36 UTC

This package is not auto-updated.

Last update: 2024-09-28 20:14:45 UTC


README

#swalker2 - Cpanel

为Laravel提供的cpanel版本2 API最简单的PHP实现

目前仅支持区域编辑和电子邮件模块

如果您想深入了解,可以编写自己的模块,参考以下cPanel API 2指南

安装

使用以下命令使用composer安装此包

composer require swalker2/cpanel

更新composer后,将服务提供者添加到config/app.php文件中的providers数组中

Swalker2\Cpanel\CpanelServiceProvider::class,

此外,使用以下命令发布配置文件

php artisan vendor:publish --tag=swalker2.cpanel

最后,添加.env变量

CPANEL_HOST=https://domain.com
CPANEL_PORT=2083
CPANEL_USERNAME=yourname
CPANEL_PASSWORD=yourpass

但是如何使用它呢?

完成安装步骤后,您只需创建一个cpanel实例,如下所示

	$cpanel = app()->make(Cpanel::class);

然后您可以调用模块实现

	dd(
		$cpanel->zoneEdit('mydomain.com')->fetch()
	);

请注意,您创建的模块可以单独实例化

	$mymodule = new MyCpanelModule();
	dd(
		$mymodule->doSomething()
	);

编写模块

要编写模块,您需要扩展类Swalker2\CpanelFunction,如下所示

namespace App;


use Swalker2\Cpanel\CpanelBaseModule;

class CpanelModule extends CpanelBaseModule
{
    
    function __construct()
    {
        parent::__construct();
        $this->cpanel->mergeFields([
            'cpanel_jsonapi_module' => 'ModuleName', //reference this from the Guide to cPanel API 2
        ]);
    }
    
    public function someAction()
    {
        $this->cpanel->mergeFields([
            'cpanel_jsonapi_func' => 'some_action',
        ]);
                
        $response = $this->getApiData();
        
        //do something with the response
    }
}

贡献

请随意发送pull请求,不仅仅是错误报告。

“错误报告”也可以以包含失败测试的pull请求的形式发送。

但是,如果您提交错误报告,您的问题应包含标题和对问题的清晰描述。您还应该尽可能多地包含相关信息和一个展示问题的代码示例。错误报告的目标是让您和其他人能够轻松地复现错误并开发修复方案。