eappointment/zmsclient

Use this library to fetch data from the eappointment API via HTTP.

2.26.07 2024-04-23 13:41 UTC

Requires

• php: >=7.3.0
• ext-curl: >=0
• ext-json: >=1.0
• ext-mbstring: >=0
• ext-pcre: >=0
• eappointment/mellon: ^2.0.1
• eappointment/zmsentities: 2.26.07
• eappointment/zmsslim: 2.26.07
• php-http/curl-client: ^2.2
• psr/http-message: ^1.0
• roave/security-advisories: dev-master
• tracy/tracy: ^2.9
• twig/twig: 3.*

Requires (Dev)

• helmich/phpunit-psr7-assert: ^4.3.0
• phpmd/phpmd: @stable
• phpspec/prophecy-phpunit: ^2.0.0
• phpunit/phpunit: ^9.5.4
• squizlabs/php_codesniffer: ^3.5.8

MIT

• Mathias Fischer

README

Use this library to fetch data from the eappointment API via HTTP.

For a detailed project description, see https://gitlab.com/eappointment/eappointment

Requirements

• PHP 7.3+

Installation

Usually this module is required by other modules and does not need any special installation. Add the following lines to your composer.json:

composer require eappointment/zmsclient

Usage

$http = new \BO\Zmsclient\Http("https://eappointment.example.com/api/2");
$result = $http->readGetResult('/status/');
$entity = $result->getEntity();
var_dump($entity->version);

Configuration

Setting up default CURL-Options, use the following line:

\BO\Zmsclient\Psr7\Client::$curlopt = [
    CURLOPT_SSL_VERIFYPEER => false,
    CURLOPT_TIMEOUT => 3,
    //CURLOPT_VERBOSE => true,
];

Testing

If you want to run the test, docker-compose is required. Testing needs an HTTP server to answer the HTTP calls from this library.

Run the following command:

docker-compose up

The docker-compose starts the mockup server, waits 10 seconds and starts the unit tests. After the tests are finished, the mockup server is still running. If there are failures, you need to lookup possible HTTP calls. There is a port forwarding and you can see the calls under http://localhost:8082/