kubinyete/getnet-edi

There is no license information available for the latest version (1.0.5) of this package.

A simple yet useful EDI parser for Getnet, a brazillian payment acquirer institution

1.0.5 2024-05-03 13:26 UTC

Requires

• kubinyete/edi-php: ^1.0
• psr/log: ^1|^2|^3
• symfony/polyfill-php80: ^1.0
• symfony/polyfill-php81: ^1.0

Requires (Dev)

• phpunit/phpunit: ^10.5
• symfony/var-dumper: ^6.4

Unknown License

• Vitor Kubinyete

README

pt-BR: Uma biblioteca simples e direta para carregar arquivos EDI da adquirente Getnet

en-US: A straightfoward library for loading EDI files from Getnet

NOTA: Este guia está primariamente em inglês, caso haja necessidade, será adicionado uma versão em pt-BR no futuro.

Warning

This package is still work-in-progress, there are plans for adding better support for document reading by providing indexing and class bindings to directly access those entries, for now we have only provided the basic parser & document wrapper, providing the necessary means for line-by-line sequential reading.

Installation

Let's start by requiring the package by running the following command

composer require kubinyete/getnet-edi

Usage

Basic line-by-line parsing

Provides a basic document class for opening a EDI text-file

// Opening a new document (version 10.1)
$document = Kubinyete\Edi\Getnet\Document\Document::open('./sample/getnetextr_20240418_0000000_c101.txt');

// Sequential reading
while ($row = $document->next()) {
    // Current line number that has been read
    $lineNumber = $document->currentLineNumber();
    // Current line contents that has been read
    $lineContent = $document->currentLine();

    // What type/class we got after parsing it.
    $parsedType = get_class($row);

    echo "Current line {$lineNumber}: '{$lineContent}'" . PHP_EOL;
    echo "Parsed content ($parsedType): " . json_encode($row, JSON_PRETTY_PRINT) . PHP_EOL;
    // @NOTE: This is only a sample code for visualizing each entry that has been parsed
}

The above code will output:

Current line 1: '01804202407321018042024CEADM1000000000        00000000000000GETNET S.A.         000000001GSSANT. V.10.1 400 BYTES                                                                                                                                                                                                                                                                                               '
Parsed content (Kubinyete\Edi\Getnet\Registry\Header): {
    "registryType": 0,
    "fileCreationDate": {
        "date": "2024-04-18 07:32:10.000000",
        "timezone_type": 3,
        "timezone": "America\/Sao_Paulo"
    },
    "movementReferenceDate": {
        "date": "2024-04-18 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "America\/Sao_Paulo"
    },
    "fileVersion": "CEADM100",
    "establishmentCode": "0000000",
    "acquirerDocument": "00000000000000",
    "acquirerName": "GETNET S.A.",
    "sequenceNumber": 1,
    "acquirerCode": "GS",
    "layoutVersion": "SANT. V.10.1 400 BYTES",
    "_padding": ""
}

Type reference

Quick type reference for each registry type and associated baseline version.

We advice only to expect the associated registry interface, and not its defined type, this will prevent any breaking change from affecting your application immediately (Ex: Name changes, value type changes, and so on)

If there are any changes that are not retrocompatible, a new type or associated interface will be used for that functionality.

Registry types