1. class
  2. Alvine
  3. \
  4. Channel
  5. \
  6. Tradebyte
  7. \
  8. Element
  9. \
  10. Message

Message

class Message extends AbstractElement

Message

<MESSAGE>
     <MESSAGE_TYPE>ORDER_ACKNOWLEDGE</MESSAGE_TYPE>
     <TB_ORDER_ID>2</TB_ORDER_ID>
     <TB_ORDER_ITEM_ID>1</TB_ORDER_ITEM_ID>
     <SKU>4711</SKU>
     <QUANTITY>1</QUANTITY>
     <COMMENT>Auftragsbestätigung</COMMENT>
     <EST_SHIP_DATE>2013-04-10</EST_SHIP_DATE>
</MESSAGE>
<MESSAGE>
     <MESSAGE_TYPE>SHIP</MESSAGE_TYPE>
     <TB_ORDER_ID>3</TB_ORDER_ID>
     <TB_ORDER_ITEM_ID>1</TB_ORDER_ITEM_ID>
     <SKU>4711</SKU>
     <QUANTITY>1</QUANTITY>
     <CARRIER_PARCEL_TYPE>DHL_STD_NATIONAL</CARRIER_PARCEL_TYPE>
     <IDCODE>123456789</IDCODE>
     <IDCODE_RETURN_PROPOSAL>987654321</IDCODE_RETURN_PROPOSAL>
</MESSAGE>
<MESSAGE>
     <MESSAGE_TYPE>RETURN</MESSAGE_TYPE>
     <TB_ORDER_ID>6</TB_ORDER_ID>
     <TB_ORDER_ITEM_ID>1</TB_ORDER_ITEM_ID>
     <SKU>4711</SKU>
     <QUANTITY>1</QUANTITY>
     <CARRIER_PARCEL_TYPE>DHL_STD_NATIONAL</CARRIER_PARCEL_TYPE>
     <IDCODE>123459876</IDCODE>
     <RETURN_CAUSE>zu groß</RETURN_CAUSE>
     <RETURN_STATE>ohne Mängel</RETURN_STATE>
</MESSAGE>

Methods

string
getFirstChildValue(string $elementName)

Hilfsmethode Gibt den Wert des ersten Elementes zurück

from AbstractElement
AbstractElement
setFirstChildValue(string $elementName, string $value, string $type = null)

Hilfsmethode Setzt den Wert eines Elementes Wenn dieses Element noch nicht angelegt wurde wird es angelegt

from AbstractElement
$this
setFirstChildAttributes(type $elementName, type $value, type $identifier, type $name = null)

Hilfsmethode Setzt die Attribute eines Elementes Wenn dieses Element noch nicht angelegt wurde wird es angelegt

from AbstractElement
$this
setChildIdentifierAttributes($elementName, $attributes, $elementValue = '')

Hilfsmethode Setzt die Attribute eines Elementes Wenn dieses Element noch nicht angelegt wurde wird es angelegt erlaubt sind 'identifier', 'key', 'name'

from AbstractElement
$this
setChildAttributes(string $elementName, array $attributes, string $elementValue = '')

Hilfsmethode Setzt die Attribute eines Elementes Wenn dieses Element noch nicht angelegt wurde wird es angelegt

from AbstractElement
setFirstChild(string $elementName, Node $child, string $type = null)

Hilfsmethode

from AbstractElement
setUniqueChildValue(string $elementName, string $value, string $type)

Hilfsmethode zum setzten eindeutiger Werte bei mehrfach vorkommenden Elementen

from AbstractElement
setUniqueChildAttribute($elementName, $value, $attribute, $attrValue)

Hilfsmethode zum setzten eindeutiger Werte bei mehrfach vorkommenden Elementen

from AbstractElement
Element|null
getFirstChildElement(string $elementName, string $type = null)

Hilfsmethode Gibt das erste gefundene Element zurück

from AbstractElement
type
getChildElementAttributes(type $elementName)

Hilfsmethode gibt die Attribute des Elementes zurück

from AbstractElement
NodeList
getChildElements($elementName)

Hilfsmethode Gibt alle Element zurück

from AbstractElement
type
checkMediaType(type $type, type $media)

No description

from AbstractElement
__construct(string $tag = null, type $value = '', type $attributes = null)

neues Objekt

Message
setMessageType(string $type)

setzt den Nachrichtentyp

Message
setTbOrderID(int $id)

Eindeutige, von TB.One vergebene Nummer, die der erhaltenen Orderdatei entnommen werden kann.

Message
setTbOrderItemID(int $id)

Eindeutige, von TB.One vergebene Nummer einer bestimmten Position innerhalb des Auftrags.

Message
setQuantity(int $quantity)

Meldungsmenge für den gelieferten Nachrichtentyp

Message
setSKU(string $SKU)

Artikelnummer aus TB.One

Message
setComment(string $comment)

Kommentar

Message
setEstShipDate(string $estShipDate)

Voraussichtliches Lieferdatum (bei Auftragsbestätigungen)

Message
setCarrierParcelType(string $carrierParcelType)

Import-Key eines der Pakettypen, die Sie unter "Basisdaten > Versand > Pakettypen" angelegt haben.

Message
setIdCode(string $idCode)

Shipcode zur Versandverfolgung

Message
setIdCodeReturnProposal(string $idCodeReturnProposal)

Voraussichtlicher Shipcode des Retourenpakets, z.B. wenn dem Paket ein Retourenlabel beigelegt wird (nur bei Versandmeldungen). Bei Retourenmeldungen ist der Shipcode des Versandlabeld in IDCODE zu liefern.

Message
setReturnCause(string $returnCause)

Retourengrund (bei Retourenmeldungen)

Message
setReturnState(string $returnState)

Retourenzustand (bei Retourenmeldungen)

Details

in AbstractElement at line 43
protected string getFirstChildValue(string $elementName)

Hilfsmethode Gibt den Wert des ersten Elementes zurück

Parameters

string $elementName Name des Elementes

Return Value

string | \null Wert des Elementes

in AbstractElement at line 62
protected AbstractElement setFirstChildValue(string $elementName, string $value, string $type = null)

Hilfsmethode Setzt den Wert eines Elementes Wenn dieses Element noch nicht angelegt wurde wird es angelegt

Parameters

string $elementName Name des Elementes
string $value Wert
string $type |\null $type Type Attribute

Return Value

AbstractElement dieses Objekt

in AbstractElement at line 88
protected $this setFirstChildAttributes(type $elementName, type $value, type $identifier, type $name = null)

Hilfsmethode Setzt die Attribute eines Elementes Wenn dieses Element noch nicht angelegt wurde wird es angelegt

Parameters

type $elementName
type $value
type $identifier
type $name

Return Value

$this

in AbstractElement at line 114
protected $this setChildIdentifierAttributes($elementName, $attributes, $elementValue = '')

Hilfsmethode Setzt die Attribute eines Elementes Wenn dieses Element noch nicht angelegt wurde wird es angelegt erlaubt sind 'identifier', 'key', 'name'

Parameters

$elementName
$attributes
$elementValue

Return Value

$this

in AbstractElement at line 157
protected $this setChildAttributes(string $elementName, array $attributes, string $elementValue = '')

Hilfsmethode Setzt die Attribute eines Elementes Wenn dieses Element noch nicht angelegt wurde wird es angelegt

Parameters

string $elementName Name
array $attributes Attribute
string $elementValue

Return Value

$this

in AbstractElement at line 190
protected setFirstChild(string $elementName, Node $child, string $type = null)

Hilfsmethode

Setzt oder ersetzt das erste Kind Element

Parameters

string $elementName Name des Elementes
Node $child Node
string $type Typ Attribute

in AbstractElement at line 222
protected setUniqueChildValue(string $elementName, string $value, string $type)

Hilfsmethode zum setzten eindeutiger Werte bei mehrfach vorkommenden Elementen

Parameters

string $elementName TAG
string $value Wert
string $type Type Attribute

in AbstractElement at line 251
protected setUniqueChildAttribute($elementName, $value, $attribute, $attrValue)

Hilfsmethode zum setzten eindeutiger Werte bei mehrfach vorkommenden Elementen

Parameters

$elementName
$value
$attribute
$attrValue

in AbstractElement at line 282
protected Element|null getFirstChildElement(string $elementName, string $type = null)

Hilfsmethode Gibt das erste gefundene Element zurück

Parameters

string $elementName Name des Elementes
string $type Type Filter

Return Value

Element|null | \false Element

in AbstractElement at line 309
protected type getChildElementAttributes(type $elementName)

Hilfsmethode gibt die Attribute des Elementes zurück

Parameters

type $elementName

Return Value

type

in AbstractElement at line 333
protected NodeList getChildElements($elementName)

Hilfsmethode Gibt alle Element zurück

Parameters

$elementName

Return Value

NodeList | \false Element

in AbstractElement at line 343
protected type checkMediaType(type $type, type $media)

Parameters

type $type
type $media

Return Value

type

at line 70
__construct(string $tag = null, type $value = '', type $attributes = null)

neues Objekt

Parameters

string $tag
type $value
type $attributes

at line 101
Message setMessageType(string $type)

setzt den Nachrichtentyp

Folgende Nachrichtentypen sind möglich:

ORDER_ACKNOWLEDGE Auftragsbestätigung SHIP Versandmeldung NO_INVENTORY Stornomeldung wegen Lagermenge CUST_CANCEL Stornomeldung auf Kundenwunsch RETURN Retourenmeldung DEDUCT_SHIPPING_COSTS Versandkostenabzug DEDUCT_SERVICE_PRICE Servicekostenabzug DEDUCT_PAYMENT_COSTS Zahlkostenabzug

PAYMENT_STATE_OPEN Zahlstatus: Auftrag noch nicht bezahlt PAYMENT_STATE_PAID Zahlstatus: Auftrag bezahlt PAYMENT_STATE_SHORTFALL Zahlstatus: Zahlungsausfall

Parameters

string $type Nachrichtentyp

Return Value

Message

at line 114
Message setTbOrderID(int $id)

Eindeutige, von TB.One vergebene Nummer, die der erhaltenen Orderdatei entnommen werden kann.

Parameters

int $id

Return Value

Message

at line 129
Message setTbOrderItemID(int $id)

Eindeutige, von TB.One vergebene Nummer einer bestimmten Position innerhalb des Auftrags.

Bei positionsbezogenen Meldungen Pflicht! Ausnahmen: Versandkosten- und Zahlkostenabzug

Parameters

int $id

Return Value

Message

at line 141
Message setQuantity(int $quantity)

Meldungsmenge für den gelieferten Nachrichtentyp

Parameters

int $quantity

Return Value

Message

at line 153
Message setSKU(string $SKU)

Artikelnummer aus TB.One

Parameters

string $SKU

Return Value

Message

at line 165
Message setComment(string $comment)

Kommentar

Parameters

string $comment

Return Value

Message

at line 177
Message setEstShipDate(string $estShipDate)

Voraussichtliches Lieferdatum (bei Auftragsbestätigungen)

Parameters

string $estShipDate

Return Value

Message

at line 190
Message setCarrierParcelType(string $carrierParcelType)

Import-Key eines der Pakettypen, die Sie unter "Basisdaten > Versand > Pakettypen" angelegt haben.

Parameters

string $carrierParcelType

Return Value

Message

at line 202
Message setIdCode(string $idCode)

Shipcode zur Versandverfolgung

Parameters

string $idCode

Return Value

Message

at line 217
Message setIdCodeReturnProposal(string $idCodeReturnProposal)

Voraussichtlicher Shipcode des Retourenpakets, z.B. wenn dem Paket ein Retourenlabel beigelegt wird (nur bei Versandmeldungen). Bei Retourenmeldungen ist der Shipcode des Versandlabeld in IDCODE zu liefern.

Parameters

string $idCodeReturnProposal

Return Value

Message

at line 229
Message setReturnCause(string $returnCause)

Retourengrund (bei Retourenmeldungen)

Parameters

string $returnCause

Return Value

Message

at line 241
Message setReturnState(string $returnState)

Retourenzustand (bei Retourenmeldungen)

Parameters

string $returnState

Return Value

Message