X12Translator Class

Properties   Methods   Events   Config Settings   Errors  

The X12Translator class converts X12 documents to XML and back, streamlining translation between formats.

Class Name

EDISDK_X12Translator

Procedural Interface

 edisdk_x12translator_open();
 edisdk_x12translator_close($res);
 edisdk_x12translator_register_callback($res, $id, $function);
 edisdk_x12translator_get_last_error($res);
 edisdk_x12translator_get_last_error_code($res);
 edisdk_x12translator_set($res, $id, $index, $value);
 edisdk_x12translator_get($res, $id, $index);
 edisdk_x12translator_do_config($res, $configurationstring);
 edisdk_x12translator_do_loadschema($res, $fileordata, $messagename);
 edisdk_x12translator_do_reset($res);
 edisdk_x12translator_do_translate($res);

Remarks

The class will convert a document from the format specified by InputFormat to the format specified by OutputFormat. This allows for converting to XML from EDI and vice versa.

Before translating from EDI to XML it is recommended to load a schema using the LoadSchema method. This ensures additional information can be included in the XML or JSON document. If a schema is specified the XML will include types and descriptions as element attributes which are useful for interpreting the data.

After calling Translate the resulting output will contain the EDI or XML data as defined by OutputFormat.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputData: The output data is written to this property if no other destination is specified.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

DelimiterComponent Property (EDISDK_X12Translator Class)

The delimiter separating classes.

Object Oriented Interface

public function getDelimiterComponent();
public function setDelimiterComponent($value);

Procedural Interface

edisdk_x12translator_get($res, 1 );
edisdk_x12translator_set($res, 1, $value );

Default Value

':'

Remarks

The delimiter separating components.

In X12Reader, this type is used to hold the delimiters found when parsing the component, while in X12Writer the fields can be set to choose the delimiters that will be used when writing

This property is not available at design time.

Data Type

String

DelimiterElement Property (EDISDK_X12Translator Class)

The delimiter separating elements.

Object Oriented Interface

public function getDelimiterElement();
public function setDelimiterElement($value);

Procedural Interface

edisdk_x12translator_get($res, 2 );
edisdk_x12translator_set($res, 2, $value );

Default Value

'*'

Remarks

The delimiter separating elements.

In X12Reader, this type is used to hold the delimiters found when parsing the element, while in X12Writer the fields can be set to choose the delimiters that will be used when writing

This property is not available at design time.

Data Type

String

DelimiterRepetition Property (EDISDK_X12Translator Class)

The delimiter separating classes.

Object Oriented Interface

public function getDelimiterRepetition();
public function setDelimiterRepetition($value);

Procedural Interface

edisdk_x12translator_get($res, 3 );
edisdk_x12translator_set($res, 3, $value );

Default Value

'^'

Remarks

The delimiter separating components.

In X12Reader, this type is used to hold the delimiters found when parsing the component, while in X12Writer the fields can be set to choose the delimiters that will be used when writing

This property is not available at design time.

Data Type

String

DelimiterSegment Property (EDISDK_X12Translator Class)

The delimiter separating segments.

Object Oriented Interface

public function getDelimiterSegment();
public function setDelimiterSegment($value);

Procedural Interface

edisdk_x12translator_get($res, 4 );
edisdk_x12translator_set($res, 4, $value );

Default Value

'~'

Remarks

The delimiter separating segments.

In X12Reader, this type is used to hold the delimiters found when parsing the segment, while in X12Writer the fields can be set to choose the delimiters that will be used when writing

This property is not available at design time.

Data Type

String

FileWriteMode Property (EDISDK_X12Translator Class)

Determines how the output file is opened for writing.

Object Oriented Interface

public function getFileWriteMode();
public function setFileWriteMode($value);

Procedural Interface

edisdk_x12translator_get($res, 5 );
edisdk_x12translator_set($res, 5, $value );

Possible Values

X12TRANSLATOR_FILEWRITEMODE_CREATE(0), 
X12TRANSLATOR_FILEWRITEMODE_OVERWRITE(1), 
X12TRANSLATOR_FILEWRITEMODE_APPEND(2)

Default Value

0

Remarks

When OutputFile is set, this property determines how the file will be opened.

This property is not available at design time.

Data Type

Integer

InputData Property (EDISDK_X12Translator Class)

The EDI message, specified as a string.

Object Oriented Interface

public function getInputData();
public function setInputData($value);

Procedural Interface

edisdk_x12translator_get($res, 6 );
edisdk_x12translator_set($res, 6, $value );

Default Value

''

Remarks

Set this property to specify the input EDI message as a string. The message can then be parsed with Parse.

This property is not available at design time.

Data Type

String

InputFile Property (EDISDK_X12Translator Class)

The file containing the EDI message.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

edisdk_x12translator_get($res, 7 );
edisdk_x12translator_set($res, 7, $value );

Default Value

''

Remarks

Set this property to specify the input EDI message as a file. The message can then be parsed with Parse.

If the file is not found or cannot be opened, an error will be returned.

Note: If both InputFile and InputData are set, InputData takes precedence.

This property is not available at design time.

Data Type

String

InputFormat Property (EDISDK_X12Translator Class)

The format of the input data.

Object Oriented Interface

public function getInputFormat();
public function setInputFormat($value);

Procedural Interface

edisdk_x12translator_get($res, 8 );
edisdk_x12translator_set($res, 8, $value );

Possible Values

X12TRANSLATOR_INPUTFORMAT_EDI(0), 
X12TRANSLATOR_INPUTFORMAT_XML(1)

Default Value

0

Remarks

The value set here, along with OutputFormat, determines how the data is converted when Translate is called.

Possible values are:

• 0 (ifEDI)
• 1 (ifXML)

This property is not available at design time.

Data Type

Integer

OutputData Property (EDISDK_X12Translator Class)

The translated EDI data.

Object Oriented Interface

public function getOutputData();
public function setOutputData($value);

Procedural Interface

edisdk_x12translator_get($res, 9 );
edisdk_x12translator_set($res, 9, $value );

Default Value

''

Remarks

This property will be populated with the translated data after calling Translate if OutputFile and SetOutputStream are not set.

This property is not available at design time.

Data Type

String

OutputFile Property (EDISDK_X12Translator Class)

The name of the file to write the translated EDI data to.

Object Oriented Interface

public function getOutputFile();
public function setOutputFile($value);

Procedural Interface

edisdk_x12translator_get($res, 10 );
edisdk_x12translator_set($res, 10, $value );

Default Value

''

Remarks

This file specified by this property will be populated with the output after calling Translate if SetOutputStream is not set.

If a file with the specified name already exists Translate will fail unless FileWriteMode is set to "fwmOverwrite" or "fwmAppend".

This property is not available at design time.

Data Type

String

OutputFormat Property (EDISDK_X12Translator Class)

The format of the output data.

Object Oriented Interface

public function getOutputFormat();
public function setOutputFormat($value);

Procedural Interface

edisdk_x12translator_get($res, 11 );
edisdk_x12translator_set($res, 11, $value );

Possible Values

X12TRANSLATOR_OUTPUTFORMAT_EDI(0), 
X12TRANSLATOR_OUTPUTFORMAT_XML(1)

Default Value

0

Remarks

The value set here, along with InputFormat, determines how the data is converted when Translate is called.

Possible values are:

• 0 (ofEDI)
• 1 (ofXML)

This property is not available at design time.

Data Type

Integer

SegmentSuffix Property (EDISDK_X12Translator Class)

The suffix that is appended to the end of a segment.

Object Oriented Interface

public function getSegmentSuffix();
public function setSegmentSuffix($value);

Procedural Interface

edisdk_x12translator_get($res, 12 );
edisdk_x12translator_set($res, 12, $value );

Possible Values

X12TRANSLATOR_SEGMENTSUFFIX_NONE(0), 
X12TRANSLATOR_SEGMENTSUFFIX_CR(1), 
X12TRANSLATOR_SEGMENTSUFFIX_LF(2), 
X12TRANSLATOR_SEGMENTSUFFIX_CRLF(3)

Default Value

3

Remarks

This property determines the suffix that is appended to the end of a segment.

Possible values are:

This property is not available at design time.

Data Type

Integer

Config Method (EDISDK_X12Translator Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

edisdk_x12translator_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

LoadSchema Method (EDISDK_X12Translator Class)

Loads schema information from a file or string data.

Object Oriented Interface

public function doLoadSchema($fileordata, $messagename);

Procedural Interface

edisdk_x12translator_do_loadschema($res, $fileordata, $messagename);

Remarks

This method loads schema information for use when parsing, validating, and translating messages.

The FileOrData parameter can be set to the path of a file containing schema data, or can be set to the contents of a schema file directly.

MessageName can be set to the name of a specific message to load only the specified message's schema information. If left empty or set to "*", the entire schema will be loaded.

Reset Method (EDISDK_X12Translator Class)

Resets all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

edisdk_x12translator_do_reset($res);

Remarks

This method resets all properties of the component to their default values as specified in the property definitions.

Translate Method (EDISDK_X12Translator Class)

Translates the specified data.

Object Oriented Interface

public function doTranslate();

Procedural Interface

edisdk_x12translator_do_translate($res);

Remarks

This method translates the specified data.

Error Event (EDISDK_X12Translator Class)

Fires when a parsing error occurs.

Object Oriented Interface

public function fireError($param);

Procedural Interface

edisdk_x12translator_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

This event fires when the class encounters a parsing error while processing a document.

ResolveSchema Event (EDISDK_X12Translator Class)

Fires to request schema information for a specific transaction set.

Object Oriented Interface

public function fireResolveSchema($param);

Procedural Interface

edisdk_x12translator_register_callback($res, 2, array($this, 'fireResolveSchema'));

Parameter List

 'versionnumber'
 'transactionsetidcode'

Remarks

LoadSchema can be called from within this event to load the schema information for the specified transaction set.

ValidateWarning Event (EDISDK_X12Translator Class)

Fires to warn about validation errors.

Object Oriented Interface

public function fireValidateWarning($param);

Procedural Interface

edisdk_x12translator_register_callback($res, 3, array($this, 'fireValidateWarning'));

Parameter List

 'position'
 'line'
 'column'
 'errorcode'
 'errormessage'
 'errortype'

Remarks

When the class encounters a non-blocking error while validating a document, this event fires with information about the error.

Config Settings (X12Translator Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

X12Translator Config Settings

Trappable Errors (X12Translator Class)

X12Translator Errors