PHP Класс EDI\Reader

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( string $url = null ) Reader constructor.
errors ( ) Get errors
getParsedFile ( ) Returns the parsed file contained within.
groupsExtract ( type $start = 'LIN', type $barrier = ['UNS'] ) : boolean/array get groups from message when last segment is unknown but you know the barrier useful for invoices by default
load ( $url ) : boolean
preValidate ( ) : boolean Do initial validation
readEdiDataValue ( array/string $filter, integer $l1, $l2 = false, boolean $required = false ) : string/null read data value from parsed EDI data
readEdiDataValueReq ( $filter, $l1, boolean $l2 = false ) : string read required value. if no found, registre error
readEdiSegmentDTM ( integer $PeriodQualifier ) : string read date from DTM segment period qualifier - codelist 2005
readGroups ( char $before, type $start, type $end, type $after ) : boolean/array get groups from message
readTDTtransportIdentification ( $transportStageQualifier ) : string read transport identification number
readUNBDateTimeOfPpreperation ( )
readUNBDateTimeOfPreperation ( ) : mixed | string get message preparation time
readUNHmessageNumber ( ) : string read message number
readUNHmessageType ( ) : string read message type
resetErrors ( ) reset errors
setParsedFile ( array $parsed_file ) : boolean
splitMultiMessage ( $ediMessage ) : array Split multi messages to separate messages

Приватные методы

Метод Описание
unwrap ( $string ) : array unwrap string splitting rows on terminator (if not escaped)

Описание методов

__construct() публичный Метод

Reader constructor.
public __construct ( string $url = null )
$url string url or path ur EDI message

errors() публичный Метод

Get errors
public errors ( )

getParsedFile() публичный Метод

Returns the parsed file contained within.
public getParsedFile ( )

groupsExtract() публичный Метод

get groups from message when last segment is unknown but you know the barrier useful for invoices by default
public groupsExtract ( type $start = 'LIN', type $barrier = ['UNS'] ) : boolean/array
$start type first segment start a new group
$barrier type barrier segment (NOT in group)
Результат boolean/array

load() публичный Метод

public load ( $url ) : boolean
$url string url to edi file, path to edi file or EDI message
Результат boolean

preValidate() публичный Метод

Do initial validation
public preValidate ( ) : boolean
Результат boolean

readEdiDataValue() публичный Метод

read data value from parsed EDI data
public readEdiDataValue ( array/string $filter, integer $l1, $l2 = false, boolean $required = false ) : string/null
$filter array/string
$l1 integer first level item number (start by 1)
$required boolean if required, but no exist, register error
Результат string/null

readEdiDataValueReq() публичный Метод

read required value. if no found, registre error
public readEdiDataValueReq ( $filter, $l1, boolean $l2 = false ) : string
$filter string|array segment filter by segment name and values
$l1
$l2 boolean
Результат string

readEdiSegmentDTM() публичный Метод

read date from DTM segment period qualifier - codelist 2005
public readEdiSegmentDTM ( integer $PeriodQualifier ) : string
$PeriodQualifier integer period qualifier (codelist/2005)
Результат string YYYY-MM-DD HH:MM:SS

readGroups() публичный Метод

get groups from message
public readGroups ( char $before, type $start, type $end, type $after ) : boolean/array
$before char segment before groups
$start type first segment of group
$end type last segment of group
$after type segment after groups
Результат boolean/array

readTDTtransportIdentification() публичный Метод

read transport identification number
public readTDTtransportIdentification ( $transportStageQualifier ) : string
$transportStageQualifier
Результат string

readUNBDateTimeOfPpreperation() публичный Метод

Устаревший:

readUNBDateTimeOfPreperation() публичный Метод

get message preparation time
public readUNBDateTimeOfPreperation ( ) : mixed | string
Результат mixed | string

readUNHmessageNumber() публичный Метод

read message number
public readUNHmessageNumber ( ) : string
Результат string

readUNHmessageType() публичный Метод

read message type
public readUNHmessageType ( ) : string
Результат string

resetErrors() публичный Метод

reset errors
public resetErrors ( )

setParsedFile() публичный Метод

public setParsedFile ( array $parsed_file ) : boolean
$parsed_file array array
Результат boolean

splitMultiMessage() публичный статический Метод

Split multi messages to separate messages
public static splitMultiMessage ( $ediMessage ) : array
$ediMessage string
Результат array