class Shipment extends Base

Class Shipment

Properties

static string $pimcoreClass Pimcore Object Class.

Methods

static  string
getPimcoreObjectClass()

get Pimcore implementation class.

from Base
static  Base
create()

Create new instance of Pimcore Object.

from Base
static  int
classId()

returns the class ID of the current object class.

from Base
static  Listing
getList( array $config = array())

No description

from Base
static  Data[]
getMandatoryFields()

No description

from Base
static 
validate($data)

No description

from Base
static  mixed|null
__callStatic($method, $arguments)

No description

from Base
array
toArray()

Object to Array.

from Base
string
getCacheKey()

get cache key

from Base
AdminStyle
getElementAdminStyle()

Admin Element Style.

from Base
save()

No description

from Base
Note
createNote($type)

Create a note for this object.

from Base
AbstractObject
getVariantMaster()

Return Topmost Master if Object is Variant

from Base
bool
isAllowedForShop( Shop $shop)

No description

from Base
bool|string
getUrl($language, $params = array(), $route, bool $reset = false, Shop $shop = null)

No description

from Base
static  int|string
getNextShipmentNumber()

Creates next Shipment Number.

static  Shipment|null
findByShipmentNumber($shipmentNumber)

Get Shipment by Shipment Number

static  string
getValidShipmentNumber($number)

Converts any Number to a valid ShipmentNumber with Suffix and Prefix.

static  Folder
getPathForNewShipment( Order $order, DateTime $date = null)

get folder for Shipments

null
getPathForItems()

No description

Document|bool
generate()

Renders the Shipment to a PDF

getOrder()

No description

setOrder( Order $order)

No description

Carbon
getShipmentDate()

No description

setShipmentDate( DateTime $shipmentNumber)

No description

string
getShipmentNumber()

No description

setShipmentNumber( string $shipmentNumber)

No description

string
getLang()

No description

setLang( string $lang)

No description

getShop()

No description

setShop( Shop $shop)

No description

Item[]
getItems()

No description

setItems( Item[] $items)

No description

getCustomer()

No description

setCustomer( User $customer)

No description

mixed
getShippingAddress()

No description

setShippingAddress( mixed $shippingAddress)

No description

mixed
getBillingAddress()

No description

setBillingAddress( mixed $billingAddress)

No description

mixed
getExtraInformation()

No description

setExtraInformation( mixed $extraInformation)

No description

getCarrier()

No description

setCarrier( Carrier $carrier)

No description

string
getTrackingCode()

No description

setTrackingCode( string $trackingCode)

No description

float
getWeight()

No description

setWeight( float $weight)

No description

Details

in Base at line line 50
static string getPimcoreObjectClass()

get Pimcore implementation class.

Return Value

string

Exceptions

Exception

in Base at line line 68
static Base create()

Create new instance of Pimcore Object.

Return Value

Base

Exceptions

Exception

in Base at line line 84
static int classId()

returns the class ID of the current object class.

Return Value

int

in Base at line line 98
static Listing getList( array $config = array())

Parameters

array $config

Return Value

Listing

Exceptions

Exception

in Base at line line 131
static Data[] getMandatoryFields()

Return Value

Data[]

Exceptions

Exception

in Base at line line 156
static validate($data)

Parameters

$data

Exceptions

ValidationException

in Base at line line 173
static mixed|null __callStatic($method, $arguments)

Parameters

$method
$arguments

Return Value

mixed|null

Exceptions

Exception

in Base at line line 194
array toArray()

Object to Array.

Return Value

array

in Base at line line 204
string getCacheKey()

get cache key

Return Value

string

in Base at line line 224
AdminStyle getElementAdminStyle()

Admin Element Style.

Return Value

AdminStyle

in Base at line line 247
Base save()

Return Value

Base

Exceptions

Exception
Exception
ValidationException

in Base at line line 267
Note createNote($type)

Create a note for this object.

Parameters

$type string

Return Value

Note $note

in Base at line line 289
AbstractObject getVariantMaster()

Return Topmost Master if Object is Variant

Return Value

AbstractObject

in Base at line line 304
bool isAllowedForShop( Shop $shop)

Parameters

Shop $shop

Return Value

bool

in Base at line line 323
bool|string getUrl($language, $params = array(), $route, bool $reset = false, Shop $shop = null)

Parameters

$language
$params
$route
bool $reset
Shop $shop

Return Value

bool|string

at line line 70
static int|string getNextShipmentNumber()

Creates next Shipment Number.

Return Value

int|string

at line line 83
static Shipment|null findByShipmentNumber($shipmentNumber)

Get Shipment by Shipment Number

Parameters

$shipmentNumber

Return Value

Shipment|null

at line line 101
static string getValidShipmentNumber($number)

Converts any Number to a valid ShipmentNumber with Suffix and Prefix.

Parameters

$number

Return Value

string

at line line 125
static Folder getPathForNewShipment( Order $order, DateTime $date = null)

get folder for Shipments

Parameters

Order $order
DateTime $date

Return Value

Folder

at line line 137
null getPathForItems()

Return Value

null

at line line 149
Document|bool generate()

Renders the Shipment to a PDF

Return Value

Document|bool

Exceptions

Exception

at line line 198
Order getOrder()

Return Value

Order

Exceptions

ObjectUnsupportedException

at line line 208
setOrder( Order $order)

Parameters

Order $order

Exceptions

ObjectUnsupportedException

at line line 218
Carbon getShipmentDate()

Return Value

Carbon

Exceptions

ObjectUnsupportedException

at line line 228
setShipmentDate( DateTime $shipmentNumber)

Parameters

DateTime $shipmentNumber

Exceptions

ObjectUnsupportedException

at line line 238
string getShipmentNumber()

Return Value

string

Exceptions

ObjectUnsupportedException

at line line 248
setShipmentNumber( string $shipmentNumber)

Parameters

string $shipmentNumber

Exceptions

ObjectUnsupportedException

at line line 258
string getLang()

Return Value

string

Exceptions

ObjectUnsupportedException

at line line 268
setLang( string $lang)

Parameters

string $lang

Exceptions

ObjectUnsupportedException

at line line 278
Shop getShop()

Return Value

Shop

Exceptions

ObjectUnsupportedException

at line line 288
setShop( Shop $shop)

Parameters

Shop $shop

Exceptions

ObjectUnsupportedException

at line line 298
Item[] getItems()

Return Value

Item[]

Exceptions

ObjectUnsupportedException

at line line 308
setItems( Item[] $items)

Parameters

Item[] $items

Exceptions

ObjectUnsupportedException

at line line 318
User getCustomer()

Return Value

User

Exceptions

ObjectUnsupportedException

at line line 328
setCustomer( User $customer)

Parameters

User $customer

Exceptions

ObjectUnsupportedException

at line line 338
mixed getShippingAddress()

Return Value

mixed

Exceptions

ObjectUnsupportedException

at line line 348
setShippingAddress( mixed $shippingAddress)

Parameters

mixed $shippingAddress

Exceptions

ObjectUnsupportedException

at line line 358
mixed getBillingAddress()

Return Value

mixed

Exceptions

ObjectUnsupportedException

at line line 368
setBillingAddress( mixed $billingAddress)

Parameters

mixed $billingAddress

Exceptions

ObjectUnsupportedException

at line line 378
mixed getExtraInformation()

Return Value

mixed

Exceptions

ObjectUnsupportedException

at line line 388
setExtraInformation( mixed $extraInformation)

Parameters

mixed $extraInformation

Exceptions

ObjectUnsupportedException

at line line 398
Carrier getCarrier()

Return Value

Carrier

Exceptions

ObjectUnsupportedException

at line line 408
setCarrier( Carrier $carrier)

Parameters

Carrier $carrier

Exceptions

ObjectUnsupportedException

at line line 418
string getTrackingCode()

Return Value

string

Exceptions

ObjectUnsupportedException

at line line 428
setTrackingCode( string $trackingCode)

Parameters

string $trackingCode

Exceptions

ObjectUnsupportedException

at line line 438
float getWeight()

Return Value

float

Exceptions

ObjectUnsupportedException

at line line 448
setWeight( float $weight)

Parameters

float $weight

Exceptions

ObjectUnsupportedException