Download the PHP package plesk/api-php-lib without Composer

On this page you can find all versions of the php package plesk/api-php-lib. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Please rate this library. Is it a good library?
Rate from 1 - 5
Rated 5.00 based on 1 reviews

All versions of api-php-lib with dependencies

Informations about the package api-php-lib

PHP library for Plesk XML-RPC API

Build Status Scrutinizer Code Quality StyleCI codecov

PHP object-oriented library for Plesk XML-RPC API.

Install Via Composer

Composer is a preferable way to install the library:

composer require plesk/api-php-lib

Usage Examples

Here is an example on how to use the library and create a customer with desired properties:

It is possible to use a secret key instead of password for authentication.

In case of Plesk extension creation one can use an internal mechanism to access XML-RPC API. It does not require to pass authentication because the extension works in the context of Plesk.

For additional examples see tests/ directory.

How to Run Unit Tests

One the possible ways to become familiar with the library is to check the unit tests.

To run the unit tests use the following command:

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

To use custom port one can provide a URL (e.g. for Docker container):

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

One more way to run tests is to use Docker:

docker-compose run tests

Continuous Testing

During active development it could be more convenient to run tests in continuous manner. Here is the way how to achieve it:

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

Requires php Version ^7.3
ext-curl Version *
ext-xml Version *
ext-simplexml Version *

The package plesk/api-php-lib contains the following files

Loading the files please wait ....