Tradacoms
in package
implements
CharactersInterface
Handle the control characters used in TRADACOMS messages.
Table of Contents
Interfaces
- CharactersInterface
- Handle the control characters used in EDI messages.
Methods
- getComponentSeparator() : string
- Get the control character used to separate components.
- getDataSeparator() : string
- Get the control character used to separate data elements.
- getDecimalPoint() : string
- Get the control character used as a decimal point.
- getEscapeCharacter() : string
- Get the control character used as an escape character.
- getReservedSpace() : string
- Get the control character used as the reserved space.
- getSegmentSeparator() : string
- Get the character used to separate segment tags from their data components.
- getSegmentTerminator() : string
- Get the control character used as a segment terminator.
- includesUNASegment() : bool
- Check whether the UNA segment should be part of the message or not.
- withComponentSeparator() : self
- Set the control character used to separate components.
- withDataSeparator() : self
- Set the control character used to separate data elements.
- withDecimalPoint() : self
- Set the control character used as a decimal point.
- withEscapeCharacter() : self
- Set the control character used as an escape character.
- withReservedSpace() : self
- Set the control character used as the reserved space.
- withSegmentTerminator() : self
- Set the control character used as a segment terminator.
- withUNASegment() : self
- Set whether the UNA segment should be part of the message or not.
Methods
getComponentSeparator()
Get the control character used to separate components.
public
getComponentSeparator() : string
Return values
stringgetDataSeparator()
Get the control character used to separate data elements.
public
getDataSeparator() : string
Return values
stringgetDecimalPoint()
Get the control character used as a decimal point.
public
getDecimalPoint() : string
Return values
stringgetEscapeCharacter()
Get the control character used as an escape character.
public
getEscapeCharacter() : string
Return values
stringgetReservedSpace()
Get the control character used as the reserved space.
public
getReservedSpace() : string
Return values
stringgetSegmentSeparator()
Get the character used to separate segment tags from their data components.
public
getSegmentSeparator() : string
Return values
stringgetSegmentTerminator()
Get the control character used as a segment terminator.
public
getSegmentTerminator() : string
Return values
stringincludesUNASegment()
Check whether the UNA segment should be part of the message or not.
public
includesUNASegment() : bool
Return values
boolwithComponentSeparator()
Set the control character used to separate components.
public
withComponentSeparator(string $character) : self
Parameters
- $character : string
Return values
selfwithDataSeparator()
Set the control character used to separate data elements.
public
withDataSeparator(string $character) : self
Parameters
- $character : string
Return values
selfwithDecimalPoint()
Set the control character used as a decimal point.
public
withDecimalPoint(string $character) : self
Parameters
- $character : string
Return values
selfwithEscapeCharacter()
Set the control character used as an escape character.
public
withEscapeCharacter(string $character) : self
Parameters
- $character : string
Return values
selfwithReservedSpace()
Set the control character used as the reserved space.
public
withReservedSpace(string $character) : self
Parameters
- $character : string
Return values
selfwithSegmentTerminator()
Set the control character used as a segment terminator.
public
withSegmentTerminator(string $character) : self
Parameters
- $character : string
Return values
selfwithUNASegment()
Set whether the UNA segment should be part of the message or not.
public
withUNASegment(bool $include) : self
Parameters
- $include : bool