README

这是用PHP编写的cPanel PublicAPI客户端的仓库。

包含内容

该仓库包含以下项目。以下将详细介绍每个项目

cPanel PHP库
PublicAPI客户端类
示例目录
cPanel PHP库和PublicAPI客户端类的PHPUnit测试

PublicAPI客户端的快速入门示例

此快速入门示例说明

使用配置数组实例化PublicAPI客户端对象。
调用 whm_api() 方法查询 XML-API::version 函数
从响应对象获取版本字符串

代码: <?php

    // Include the autoloader
    require_once realpath( dirname(__FILE__) . '/Util/Autoload.php');
    
    // Make a configuration data array
    $config = array(
        'service' => array(
            'whm' => array(
                'config'    => array(
                    'host' => '10.1.4.191',
                    'user' => 'root',
                    'password' => 'rootsecret'
                ),
            ),
        ),
    );
    
    // Instantiate the PublicAPI client
    $cp = Cpanel_PublicAPI::getInstance($config);
    
    // Make a Whostmgr query
    $response = $cp->whm_api('version');
    
    // Print result string
    echo "WHM Version: {$response->version}\n";
    
?>

cPanel PHP库

cPanel PHP库是开发人员构建与cPanel系统交互的应用程序和脚本的基石。

版本0.1.0与PHP >= 5.2兼容

库分为组件。以下列出库中的一些组件及其描述

Cpanel_Query

创建可以查询cPanel系统的对象的抽象类
Cpanel_Service

表示cPanel服务（如Whostmgr和cPanel）的具体和抽象类
Cpanel_Parser

允许编码和解码常见字符串和数据结构的类
Cpanel_Util

用于开发cPanel库的实用文件和脚本
...以及其他

PublicAPI客户端类

PublicAPI是cPanel定义的客户接口的名称：可以说是一种合同，它呈现了一组与cPanel系统交互的语言无关的方法。

该仓库中的PublicAPI PHP客户端类是该接口的PHP实现。客户端支持PublicAPI接口的所有方法，以及大多数以前PHP客户端类中可用的方法，如XML-API客户端类。

如何使用PublicAPI客户端类的示例可以在以下位置找到

简要：本文件的 PublicAPI客户端的快速入门示例 部分
详细：仓库中的 Cpanel/Examples/ 目录中的示例

版本0.1.0与PHP >= 5.2兼容

示例目录

在 Cpanel/Examples/ 中有多个示例文件。阅读 Introduction_to_PublicAPI.php 是一个好的开始。所有其他示例都假设您已经阅读了它。

每个示例文件都是可工作的示例，如果您替换自己的凭据和主机信息。

实际上，您甚至可以在本地运行LivePHP示例 Using_the_LivePHP_Service.php，而无需下载和安装它 respective of the LivePHP环境。这是由于测试设备的一部分是模拟服务器。注意：这是一个非常、非常简单的模拟服务器，且不适用于任何其他目的。因此，请不要实现或依赖它。

单元测试

单元测试包括cPanel PHP库和PublicAPI客户端类，位于Cpanel/Tests/目录下。这些测试是用PHPUnit >= 3.5编写的。这些测试需要PHP 5.3或更高版本，因为它们使用特定的反射函数，可以在private或protected属性的可见性上进行断言。

eresults / publicapi

维护者

详细信息