GXParcelTrackingCode
in package
Class GXParcelTrackingCode
Table of Contents
- $comment : ParcelTrackingCodeComment
- $isLightweight : bool
- $languageId : ParcelTrackingCodeLanguageId
- $name : ParcelTrackingCodeServiceName
- $orderId : ParcelTrackingCodeOrderId
- $parcelServiceId : ParcelTrackingCodeServiceId
- $trackingCode : OrderParcelTrackingCode
- $url : ParcelTrackingCodeUrl
- comment() : ParcelTrackingCodeComment
- Returns the tracking code comment.par
- create() : GXParcelTrackingCode
- Creates a new order parcel tracking code entity.
- createLightweight() : GXParcelTrackingCode
- Creates a new order parcel tracking code entity.
- isLightweight() : mixed
- languageId() : ParcelTrackingCodeLanguageId
- Returns the language id.
- orderId() : ParcelTrackingCodeOrderId
- Returns the order id.
- parcelServiceId() : ParcelTrackingCodeServiceId
- Returns the parcels service id.
- parcelServiceName() : ParcelTrackingCodeServiceName
- Returns the name of the parcel service name.
- trackingCode() : OrderParcelTrackingCode
- Returns the tracking code.
- url() : ParcelTrackingCodeUrl
- Returns the tracking code url.
- __construct() : mixed
- OrderParcelTrackingCode constructor.
Properties
$comment
protected
ParcelTrackingCodeComment
$comment
$isLightweight
protected
bool
$isLightweight
$languageId
protected
ParcelTrackingCodeLanguageId
$languageId
$name
protected
ParcelTrackingCodeServiceName
$name
$orderId
protected
ParcelTrackingCodeOrderId
$orderId
$parcelServiceId
protected
ParcelTrackingCodeServiceId
$parcelServiceId
$trackingCode
protected
OrderParcelTrackingCode
$trackingCode
$url
protected
ParcelTrackingCodeUrl
$url
Methods
comment()
Returns the tracking code comment.par
public
comment() : ParcelTrackingCodeComment
Return values
ParcelTrackingCodeComment —create()
Creates a new order parcel tracking code entity.
public
static create(ParcelTrackingCodeServiceId $parcelServiceId, ParcelTrackingCodeOrderId $orderId, OrderParcelTrackingCode $trackingCode, ParcelTrackingCodeLanguageId $languageId) : GXParcelTrackingCode
This entity version will fetch the corresponding data from related tables.
Parameters
- $parcelServiceId : ParcelTrackingCodeServiceId
-
Id of related parcel service.
- $orderId : ParcelTrackingCodeOrderId
-
Id of related order.
- $trackingCode : OrderParcelTrackingCode
-
Tracking code for order.
- $languageId : ParcelTrackingCodeLanguageId
-
Language id (for language specific comment).
Return values
GXParcelTrackingCode —New instance.
createLightweight()
Creates a new order parcel tracking code entity.
public
static createLightweight(ParcelTrackingCodeOrderId $orderId, ParcelTrackingCodeServiceName $name, ParcelTrackingCodeUrl $url[, ParcelTrackingCodeComment|null $comment = null ]) : GXParcelTrackingCode
The lightweight version renounce on related data.
Parameters
- $orderId : ParcelTrackingCodeOrderId
-
Id of related order.
- $name : ParcelTrackingCodeServiceName
-
Name of parcel service-
- $url : ParcelTrackingCodeUrl
-
Tracking code url.
- $comment : ParcelTrackingCodeComment|null = null
-
Comment of tracking code for order.
Return values
GXParcelTrackingCode —New instance.
isLightweight()
public
isLightweight() : mixed
Return values
mixed —languageId()
Returns the language id.
public
languageId() : ParcelTrackingCodeLanguageId
Return values
ParcelTrackingCodeLanguageId —orderId()
Returns the order id.
public
orderId() : ParcelTrackingCodeOrderId
Return values
ParcelTrackingCodeOrderId —parcelServiceId()
Returns the parcels service id.
public
parcelServiceId() : ParcelTrackingCodeServiceId
Return values
ParcelTrackingCodeServiceId —parcelServiceName()
Returns the name of the parcel service name.
public
parcelServiceName() : ParcelTrackingCodeServiceName
Return values
ParcelTrackingCodeServiceName —trackingCode()
Returns the tracking code.
public
trackingCode() : OrderParcelTrackingCode
Return values
OrderParcelTrackingCode —url()
Returns the tracking code url.
public
url() : ParcelTrackingCodeUrl
Return values
ParcelTrackingCodeUrl —__construct()
OrderParcelTrackingCode constructor.
private
__construct() : mixed
Private to enforce usage of named constructors.