GXParcelService
in package
implements
ParcelServiceInterface
Class GXParcelService
Interfaces, Classes and Traits
- ParcelServiceInterface
- Interface ParcelServiceInterface
Table of Contents
- $descriptions : ParcelServiceDescriptionCollection
- $id : int|null
- $isDefault : bool
- $name : string
- __construct() : mixed
- GXParcelService constructor.
- create() : GXParcelService
- id() : int|null
- Returns the ID of the parcel service if set. Otherwise null will be returned.
- isDefault() : bool
- Checks if the parcel service is set as default.
- name() : string
- Returns the name of the parcel service.
- parcelServiceDescriptions() : ParcelServiceDescriptionCollection
- Returns the parcel service descriptions as a ParcelServiceDescriptionCollection.
Properties
$descriptions
protected
ParcelServiceDescriptionCollection
$descriptions
$id
protected
int|null
$id
$isDefault
protected
bool
$isDefault
$name
protected
string
$name
Methods
__construct()
GXParcelService constructor.
public
__construct(ParcelServiceId $id, NonEmptyStringType $name, BoolType $isDefault, ParcelServiceDescriptionCollection $descriptions) : mixed
Parameters
- $id : ParcelServiceId
- $name : NonEmptyStringType
- $isDefault : BoolType
- $descriptions : ParcelServiceDescriptionCollection
Return values
mixed —create()
public
static create(ParcelServiceId $id, string $name, bool $isDefault, ParcelServiceDescriptionCollection $descriptions) : GXParcelService
Parameters
- $id : ParcelServiceId
- $name : string
- $isDefault : bool
- $descriptions : ParcelServiceDescriptionCollection
Return values
GXParcelService —New instance
id()
Returns the ID of the parcel service if set. Otherwise null will be returned.
public
id() : int|null
Return values
int|null —isDefault()
Checks if the parcel service is set as default.
public
isDefault() : bool
Return values
bool —name()
Returns the name of the parcel service.
public
name() : string
Return values
string —parcelServiceDescriptions()
Returns the parcel service descriptions as a ParcelServiceDescriptionCollection.
public
parcelServiceDescriptions() : ParcelServiceDescriptionCollection