php-extended/php-api-fr-gouv-minint-rna-object

A library that implements the php-extended/php-api-fr-gouv-minint-rna-interface library

Maintainers

Details

gitlab.com/php-extended/php-api-fr-gouv-minint-rna-object

Homepage

Source

Issues

Installs: 117

Dependents: 1

Suggesters: 0

Security: 0

6.2.1 2023-08-21 19:31 UTC

Requires

Requires (Dev)

MIT 17a807bd2185b476833f0f4aa7f149c72fb033dc

phpapiimplementationassociationsfrnationalrnagouvminintrepertoire

This package is auto-updated.

Last update: 2023-09-21 19:46:48 UTC

README

A library that implements the php-extended/php-api-fr-gouv-minint-rna-interface library

coverage build status

Installation

The installation of this library is made via composer and the autoloading of all classes of this library is made through their autoloader.

  • Download composer.phar from their website.
  • Then run the following command to install this library as dependency :
  • php composer.phar php-extended/php-api-fr-gouv-minint-rna-object ^6

Basic Usage

This library gives an unique endpoint : \PhpExtended\Minint\MinintRnaEndpoint from which all data can be retrieved.

  • For most usages, you may use the following code :

use PhpExtended\Minint\MinintRnaEndpoint;
use PhpExtended\Endpoint\ZipHttpEndpoint;
use PhpExtended\Endpoint\HttpEndpoint;

/** $client \Psr\Http\Client\ClientInterface */

$endpoint = new MinintRnaEndpoint(new ZipHttpEndpoint(new HttpEndpoint($client)));

$associations = $endpoint->getLatestRnaWaldecIterator();

foreach($associations as $association)
{
	/** @var $association \PhpExtended\Minint\MinintRnaAssociationWaldec */
}

Be wary that the client must follow a certain number of rules regarding the handling of files via the X-Php-Download-File request and response headers for the ZipHttpEndpoint to be able to unzip the downloaded file without having to use gigabytes of memory. It must also return an X-Request-Uri header to get the full uri back.

For an example of the minimal needed http client, look at the MinintRnaEndpointTest class file and find the client that is used.

If you have that much memory however, you can bypass the ZipHttpEndpoint and all of the X-Php-Download-File and X-Request-Uri shenanigans altogether.

License