zoilomora / ocean-smart-client

1.2.0 2024-07-11 13:56 UTC

Requires

• php: ^7.2 | ^8.0
• ext-json: *
• guzzlehttp/guzzle: ^6.3 || ^7.5

MIT

• client
• smart
• ocean

Published on Packagist.org on 2024-07-11 14:01 UTC

README

This library helps to communicate with OceanSmart software.

Tested with Ocean Smart 1.4.0603.1.

Usage

To facilitate the use with several users, a factory is included to start the session.

Below is an example of use:

<?php
require __DIR__ . '/../vendor/autoload.php';

$factory = new \ZoiloMora\OceanSmartClient\ClientFactory(
    new \GuzzleHttp\Client(
        [
            'base_uri' => BASE_URI,
            // ... specific user settings
        ]
    )
);

$client = $factory->build(USER, PASSWORD);

$markings = $client->markings(
    new DateTime('2019-06-01'), // from
    new DateTime('2019-07-01')  // to
);

Notes

For now, raw array of API responses are returned, they are not transformed into mapped objects.