README

PHP面向对象库，用于Plesk XML-RPC API。

通过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 ./vendor/bin/phpunit

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

REMOTE_URL=https://your-plesk-host.dom:port REMOTE_PASSWORD=password ./vendor/bin/phpunit

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

docker-compose run tests

使用Grunt进行持续测试

安装Node.js
通过npm install命令安装依赖项
运行REMOTE_HOST=your-plesk-host.dom REMOTE_PASSWORD=password grunt watch:test

skymailbr / plesk-xml-api

维护者

详细信息

README

通过Composer安装

使用示例

如何运行单元测试

使用Grunt进行持续测试