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=你的Plesk主机域名 REMOTE_PASSWORD=密码 ./vendor/bin/phpunit

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

REMOTE_URL=https://你的Plesk主机域名:端口 REMOTE_PASSWORD=密码 ./vendor/bin/phpunit

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

docker-compose run tests

使用Grunt进行持续测试

安装Node.js
通过npm install命令安装依赖
运行REMOTE_HOST=你的Plesk主机域名 REMOTE_PASSWORD=密码 grunt watch:test

necrorde/ api-php-lib

维护者

详细信息

README

通过Composer安装

使用示例

如何运行单元测试

使用Grunt进行持续测试