README

Plesk XML-RPC API 的面向对象 PHP 库。

通过 Composer 安装

Composer 是安装此库的首选方式

composer require plesk/api-php-lib

使用示例

以下是一个如何使用此库创建具有所需属性的客户的示例

$client = new \PleskX\Api\Client($host);
$client->setCredentials($login, $password);

$client->customer()->create([
    'cname' => 'Plesk',
    'pname' => 'John Smith',
    'login' => 'john',
    'passwd' => 'secret',
    'email' => 'john@smith.com',
]);

可以使用密钥而不是密码进行身份验证。

$client = new \PleskX\Api\Client($host);
$client->setSecretKey($secretKey)

在创建 Plesk 扩展时，可以使用内部机制来访问 XML-RPC API。由于扩展在 Plesk 的上下文中运行，因此不需要进行身份验证。

$client = new \PleskX\Api\InternalClient();
$protocols = $client->server()->getProtos();

更多示例请参阅 tests/ 目录。

如何运行单元测试

熟悉此库的一种方法是检查单元测试。

要运行单元测试，请使用以下命令

REMOTE_HOST=your-plesk-host.dom REMOTE_PASSWORD=password composer test

要使用自定义端口，可以提供 URL（例如 Docker 容器）

REMOTE_URL=https://your-plesk-host.dom:port REMOTE_PASSWORD=password composer test

运行测试的另一种方法是使用 Docker

docker-compose run tests

持续测试

在积极开发期间，以连续方式运行测试可能更方便。以下是如何实现的方法

REMOTE_URL=https://your-plesk-host.dom:port REMOTE_PASSWORD=password composer test:watch

giovanne-oliveira / plesk-php-api

维护者

详细信息

README

通过 Composer 安装

使用示例

如何运行单元测试

持续测试