class Invoice extends Base

Class Invoice

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
getNextInvoiceNumber()

Creates next InvoiceNumber.

static  Invoice|null
findByInvoiceNumber($invoiceNumber)

Get Order by InvoiceNumber

static  string
getValidInvoiceNumber($number)

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

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

get folder for Invoice

null
getPathForItems()

No description

array
getTaxRates()

Returns array with key=>value for tax and value.

calculatePrices()

Calculates Prices, Shipping, Discounts and Payment Fees for Invoice

Asset
getAsset()

No description

Document|bool
generate()

Renders the Invoice to a PDF

getOrder()

No description

setOrder( Order $order)

No description

Carbon
getInvoiceDate()

No description

setInvoiceDate( DateTime $invoiceDate)

No description

string
getInvoiceNumber()

No description

setInvoiceNumber( string $invoiceNumber)

No description

string
getLang()

No description

setLang( string $lang)

No description

Fieldcollection|null
getPriceRuleFieldCollection()

No description

setPriceRuleFieldCollection( Fieldcollection $priceRules)

No description

getCurrency()

No description

setCurrency( Currency $currency)

No description

double
getDiscount()

No description

setDiscountWithoutTax( double $discountWithoutTax)

No description

double
getDiscountWithoutTax()

No description

setDiscount( double $discount)

No description

double
getSubtotalTax()

No description

setSubtotalTax( double $subtotalTax)

No description

double
getSubtotalWithoutTax()

No description

setSubtotalWithoutTax( double $subtotalWithoutTax)

No description

double
getSubtotal()

No description

setSubtotal( double $subtotal)

No description

double
getShipping()

No description

setShipping( double $shipping)

No description

double
getShippingTaxRate()

No description

setShippingTaxRate( double $shippingTaxRate)

No description

double
getShippingWithoutTax()

No description

setShippingWithoutTax( double $shippingWithoutTax)

No description

double
getShippingTax()

No description

setShippingTax( double $shippingTax)

No description

double
getPaymentFee()

No description

setPaymentFee( double $paymentFee)

No description

mixed
getPaymentFeeTaxRate()

No description

setPaymentFeeTaxRate( double $paymentFeeTaxRate)

No description

double
getPaymentFeeWithoutTax()

No description

setPaymentFeeWithoutTax( double $paymentFeeWithoutTax)

No description

double
getPaymentFeeTax()

No description

setPaymentFeeTax( double $paymentFeeTax)

No description

double
getTotalTax()

No description

setTotalTax( double $totalTax)

No description

double
getTotalWithoutTax()

No description

setTotalWithoutTax( double $totalWithtouTax)

No description

double
getTotal()

No description

setTotal( double $total)

No description

getShop()

No description

setShop( Shop $shop)

No description

mixed
getTaxes()

No description

setTaxes( mixed $taxes)

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

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 85
static int|string getNextInvoiceNumber()

Creates next InvoiceNumber.

Return Value

int|string

at line line 98
static Invoice|null findByInvoiceNumber($invoiceNumber)

Get Order by InvoiceNumber

Parameters

$invoiceNumber

Return Value

Invoice|null

at line line 116
static string getValidInvoiceNumber($number)

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

Parameters

$number

Return Value

string

at line line 140
static Folder getPathForNewInvoice( Order $order, DateTime $date = null)

get folder for Invoice

Parameters

Order $order
DateTime $date

Return Value

Folder

at line line 152
null getPathForItems()

Return Value

null

at line line 162
array getTaxRates()

Returns array with key=>value for tax and value.

Return Value

array

at line line 190
calculatePrices()

Calculates Prices, Shipping, Discounts and Payment Fees for Invoice

at line line 328
Asset getAsset()

Return Value

Asset

at line line 343
Document|bool generate()

Renders the Invoice to a PDF

Return Value

Document|bool

Exceptions

Exception

at line line 392
Order getOrder()

Return Value

Order

Exceptions

ObjectUnsupportedException

at line line 402
setOrder( Order $order)

Parameters

Order $order

Exceptions

ObjectUnsupportedException

at line line 412
Carbon getInvoiceDate()

Return Value

Carbon

Exceptions

ObjectUnsupportedException

at line line 422
setInvoiceDate( DateTime $invoiceDate)

Parameters

DateTime $invoiceDate

Exceptions

ObjectUnsupportedException

at line line 432
string getInvoiceNumber()

Return Value

string

Exceptions

ObjectUnsupportedException

at line line 442
setInvoiceNumber( string $invoiceNumber)

Parameters

string $invoiceNumber

Exceptions

ObjectUnsupportedException

at line line 452
string getLang()

Return Value

string

Exceptions

ObjectUnsupportedException

at line line 462
setLang( string $lang)

Parameters

string $lang

Exceptions

ObjectUnsupportedException

at line line 472
Fieldcollection|null getPriceRuleFieldCollection()

Return Value

Fieldcollection|null

Exceptions

ObjectUnsupportedException

at line line 482
setPriceRuleFieldCollection( Fieldcollection $priceRules)

Parameters

Fieldcollection $priceRules

Exceptions

ObjectUnsupportedException

at line line 492
Currency getCurrency()

Return Value

Currency

Exceptions

ObjectUnsupportedException

at line line 502
setCurrency( Currency $currency)

Parameters

Currency $currency

Exceptions

ObjectUnsupportedException

at line line 512
double getDiscount()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 522
setDiscountWithoutTax( double $discountWithoutTax)

Parameters

double $discountWithoutTax

Exceptions

ObjectUnsupportedException

at line line 532
double getDiscountWithoutTax()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 542
setDiscount( double $discount)

Parameters

double $discount

Exceptions

ObjectUnsupportedException

at line line 552
double getSubtotalTax()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 562
setSubtotalTax( double $subtotalTax)

Parameters

double $subtotalTax

Exceptions

ObjectUnsupportedException

at line line 572
double getSubtotalWithoutTax()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 582
setSubtotalWithoutTax( double $subtotalWithoutTax)

Parameters

double $subtotalWithoutTax

Exceptions

ObjectUnsupportedException

at line line 592
double getSubtotal()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 602
setSubtotal( double $subtotal)

Parameters

double $subtotal

Exceptions

ObjectUnsupportedException

at line line 612
double getShipping()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 622
setShipping( double $shipping)

Parameters

double $shipping

Exceptions

ObjectUnsupportedException

at line line 632
double getShippingTaxRate()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 642
setShippingTaxRate( double $shippingTaxRate)

Parameters

double $shippingTaxRate

Exceptions

ObjectUnsupportedException

at line line 652
double getShippingWithoutTax()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 662
setShippingWithoutTax( double $shippingWithoutTax)

Parameters

double $shippingWithoutTax

Exceptions

ObjectUnsupportedException

at line line 672
double getShippingTax()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 682
setShippingTax( double $shippingTax)

Parameters

double $shippingTax

Exceptions

ObjectUnsupportedException

at line line 692
double getPaymentFee()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 702
setPaymentFee( double $paymentFee)

Parameters

double $paymentFee

Exceptions

ObjectUnsupportedException

at line line 712
mixed getPaymentFeeTaxRate()

Return Value

mixed

Exceptions

ObjectUnsupportedException

at line line 722
setPaymentFeeTaxRate( double $paymentFeeTaxRate)

Parameters

double $paymentFeeTaxRate

Exceptions

ObjectUnsupportedException

at line line 732
double getPaymentFeeWithoutTax()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 742
setPaymentFeeWithoutTax( double $paymentFeeWithoutTax)

Parameters

double $paymentFeeWithoutTax

Exceptions

ObjectUnsupportedException

at line line 752
double getPaymentFeeTax()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 762
setPaymentFeeTax( double $paymentFeeTax)

Parameters

double $paymentFeeTax

Exceptions

ObjectUnsupportedException

at line line 772
double getTotalTax()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 782
setTotalTax( double $totalTax)

Parameters

double $totalTax

Exceptions

ObjectUnsupportedException

at line line 792
double getTotalWithoutTax()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 802
setTotalWithoutTax( double $totalWithtouTax)

Parameters

double $totalWithtouTax

Exceptions

ObjectUnsupportedException

at line line 812
double getTotal()

Return Value

double

Exceptions

ObjectUnsupportedException

at line line 822
setTotal( double $total)

Parameters

double $total

Exceptions

ObjectUnsupportedException

at line line 832
Shop getShop()

Return Value

Shop

Exceptions

ObjectUnsupportedException

at line line 842
setShop( Shop $shop)

Parameters

Shop $shop

Exceptions

ObjectUnsupportedException

at line line 852
mixed getTaxes()

Return Value

mixed

Exceptions

ObjectUnsupportedException

at line line 862
setTaxes( mixed $taxes)

Parameters

mixed $taxes

Exceptions

ObjectUnsupportedException

at line line 872
Item[] getItems()

Return Value

Item[]

Exceptions

ObjectUnsupportedException

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

Parameters

Item[] $items

Exceptions

ObjectUnsupportedException

at line line 892
User getCustomer()

Return Value

User

Exceptions

ObjectUnsupportedException

at line line 902
setCustomer( User $customer)

Parameters

User $customer

Exceptions

ObjectUnsupportedException

at line line 912
mixed getShippingAddress()

Return Value

mixed

Exceptions

ObjectUnsupportedException

at line line 922
setShippingAddress( mixed $shippingAddress)

Parameters

mixed $shippingAddress

Exceptions

ObjectUnsupportedException

at line line 932
mixed getBillingAddress()

Return Value

mixed

Exceptions

ObjectUnsupportedException

at line line 942
setBillingAddress( mixed $billingAddress)

Parameters

mixed $billingAddress

Exceptions

ObjectUnsupportedException

at line line 952
mixed getExtraInformation()

Return Value

mixed

Exceptions

ObjectUnsupportedException

at line line 962
setExtraInformation( mixed $extraInformation)

Parameters

mixed $extraInformation

Exceptions

ObjectUnsupportedException