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

expansehost / plesk-api-php

维护者

详情

README

通过Composer安装

使用示例

如何运行单元测试

持续测试