README

通过Composer安装

Composer是推荐的安装方式。

在项目中运行：composer require stayallive/plesk-php-api:0.1.*

使用示例

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

$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->setCredentials($login, $password);
+$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 run -d -it -p 8443:8443 plesk/plesk

之后，容器在http://localhost:8443上可用，假设您在本地运行Docker，并且您可以运行

REMOTE_URL=https://127.0.0.1:8443 REMOTE_PASSWORD=changeme ./vendor/bin/phpunit`

您还可以使用--group参数运行单个测试组，要列出所有可用的组

./vendor/bin/phpunit --list-groups

要运行客户测试

REMOTE_URL=https://127.0.0.1:8443 REMOTE_PASSWORD=changeme ./vendor/bin/phpunit --group customer

使用Grunt进行持续测试

• 安装node.js并全局安装grunt： npm -g install grunt
• 通过npm install或yarn install命令安装依赖项
• 运行REMOTE_HOST=your-plesk-host.dom REMOTE_PASSWORD=password grunt watch:test