dbrkls/edifact

Tools in PHP for UN/EDIFACT

edifact

Tools to process EDI messages in UN/EDIFACT format, _(*1)

Supported syntax is version 3., _(*2)

It's provided in a Composer package:, _(*3)

composer require sabas/edifact, _(*4)

The mapping xml files are provided in a separate repository (https://github.com/sabas/edifact-data). To get them within the repository remember to clone with the --recursive flag, or download them with git submodule update --init --recursive, _(*5)

EDI/Parser

Given an edi message checks the syntax, outputs errors and returns the message as a multidimensional array., _(*6)

INPUT, _(*7)

$c = new Parser($x);

Where $x could be: * a url * a string (wrapped message) * an array of strings (a segment per entry), _(*8)

OR, _(*9)

```php $c = new Parser(); $c->load($file); $c->loadString($string);, <sub>(*10)</sub>

**OUTPUT**

Errors
```php
$c->errors();

Array, <sub>(*11)</sub>

$c->get();

EDI/Encoder

Given a multidimensional array (formatted as the output of the parser), returns an EDI string, optionally one segment per line., <sub>(*12)</sub>

INPUT, <sub>(*13)</sub>

$c = new Encoder($x, $wrap = true);

$x is a multidimensional array where first dimension is the EDI segment, second contains elements: * single value * array (representing composite elements), <sub>(*14)</sub>

$wrap is a boolean, if you need a segment per line. Set to false to disable wrapping, <sub>(*15)</sub>

OR, <sub>(*16)</sub>

$c = new Encoder();
$c->encode($array, $wrap);

OUTPUT, <sub>(*17)</sub>

$c->get(); // returns String

EDI/Analyser

Create from EDI file readable structured text with comments from segments.xml., <sub>(*18)</sub>

INPUT, <sub>(*19)</sub>

$analyser = new EDI\Analyser();
$analyser->loadSegmentsXml('edifact/src/EDI/Mapping/d95b/segments.xml');

• $url is the path to orginal EDI message file
• $parsed is a by EDI\Parser() created EDI messages array

TEXT OUTPUT, <sub>(*20)</sub>

$analyser->process($parsed); // returns text

Or, <sub>(*21)</sub>

$analyser->process($parsed, $rawSegments);

• $rawSegments (optional) is segments in raw format from EDI\Parser::getRawSegments to be printed before each segment in the analysed result

JSON OUTPUT Get a json representation of the array, with the element names as key., <sub>(*22)</sub>

$analyser->process($parsed);
$json = $analyser->getJson();

EDI/Reader

Read from EDI file requested segment element values., <sub>(*23)</sub>

INPUT, <sub>(*24)</sub>

$r = new Reader($x);
$sender = $r->readEdiDataValue('UNB', 2);
$Dt = $r->readUNBDateTimeOfPpreperation();

Where X could be: * a url * a string (wrapped message) * an array of strings (a segment per entry), <sub>(*25)</sub>

OR, <sub>(*26)</sub>

$c = new Parser($x);

$r=new Reader();
$r->setParsedFile($c);
$sender = $r->readEdiDataValue('UNB', 2);
$Dt = $r->readUNBDateTimeOfPpreperation();

OUTPUT Errors, <sub>(*27)</sub>

$c->errors();

Array, <sub>(*28)</sub>

$c->get();

EDI/Interpreter

Organizes the data parsed by EDI/Parser using the xml description of the message and the xml segments., <sub>(*29)</sub>

INPUT, <sub>(*30)</sub>

$p=new EDI\Parser($edifile);
$edi = $p->get();

$analyser = new EDI\Analyser();
$segs =$analyser->loadSegmentsXml('vendor/sabas/edifact-data/D95B/segments.xml');

$interpreter = new EDI\Interpreter('vendor/sabas/edifact-data/D95B/messages/codeco.xml', $segs);
$prep = $interpreter->prepare($edi);

OUTPUT, <sub>(*31)</sub>

Json, <sub>(*32)</sub>

$interpreter->getJson()

Errors (per message), <sub>(*33)</sub>

$interpreter->getErrors()

Example

Edifact, <sub>(*34)</sub>

DTM+7:201309200717:203', <sub>(*35)</sub>

Array, <sub>(*36)</sub>

['DTM',['7','201309200717','203']]

Syntax data

Processed from EDI PEAR Package by David JEAN LOUIS (izi), downloadable from https://code.google.com/p/izi-sandbox/source/browse/trunk/php/php_edi/., <sub>(*37)</sub>

Notes

Valid characters are: A-Za-z0-9.,-()/'+:=?!"%&*;<> UNECE, <sub>(*38)</sub>