CoolCMS API

Order extends Order
in package

Application

Admin order aggregate (bridge to the Api).

IMPORTANT: the collections are owned with orphanRemoval, so every object-graph save must send the full includes. Otherwise items, vouchers and the other collections are silently lost.

Properties

$bankAccount : string|null
$bankName : string|null
$buyerType : int
$currency : TCurrency|null
$customerCity : string|null
$customerCompanyName : string|null
$customerContactId : int|null
$customerCountry : string|null
$customerCountryCode : string|null
$customerDlvCity : string|null
$customerDlvCountry : string|null
$customerDlvCountryCode : string|null
$customerDlvInformations : string|null
$customerDlvName : string|null
$customerDlvPostcode : string|null
$customerDlvStreet : string|null
$customerEmail : string|null
$customerFirstname : string|null
$customerId : int|null
$customerInformations : string|null
$customerLastname : string|null
$customerPhone : string|null
$customerPostcode : string|null
$customerRegNo : string|null
$customerStreet : string|null
$customerVatId : string|null
$customerVatIdCheckId : int|null: Applied VAT id check (`cms_system_vat_id_checks`): consultation number or manual proof.
$customerVatIdOutageCheckId : int|null: Record of a VIES outage on the supply date.
$customerVatIdVerified : bool|null: Null means the VAT id does not matter (empty or domestic); false is unverified; true is verified.
$customerVatIdVerifiedAt : DateTime|null
$expeditionCode : string|null
$expeditionDatetime : DateTime|null
$expeditionInformations : string|null
$expeditionShipper : TExpeditionShipper|null
$expeditionShipperBranchId : int|null
$gifts : Collection<int, OrderGift>
$gridInvoices : array<int, Invoice>
$iban : string|null
$id : int|null
$informations : string|null
$insertDatetime : DateTime|null
$insertUserIp : string|null
$invoicedStatus : int|null
$isCancelled : bool
$items : Collection<int, OrderItem>
$language : TLanguage|null
$localization : object|null: Invoice localization: number and currency formats come from here, not from the current request.
$orderNumber : string
$payment : TPayment|null
$paymentMethod : OrderPaymentMethod|null
$paymentRegion : TPaymentRegion|null
$payments : Collection<int, OrderPayment>
$region : TRegion|null
$reservationExpiresAt : DateTime|null
$roundedTotalPrice : string
$roundedTotalPriceWithVat : string
$rounding : string
$roundingVat : string
$sellerBankAccountId : int|null
$sellerCity : string|null
$sellerContactId : int|null
$sellerCountry : string|null
$sellerEmail : string|null
$sellerId : int|null
$sellerInformations : string|null
$sellerName : string|null
$sellerPhone : string|null
$sellerPostcode : string|null
$sellerRegNo : string|null
$sellerStreet : string|null
$sellerVatId : string|null
$sellerVatInformations : string|null
$shipper : OrderShipper|null
$status : TStatus|null
$statusInformations : string|null
$stockDocumentId : int|null
$stockState : string
$summaryReportCode : string|null: Supply code for the summary report (`3` services, `0` goods); null means it is not reported.
$swift : string|null
$taxCountryCode : string|null: Country of the applied rate (null without VAT).
$taxDate : DateTime|null: Date of the rate and of the seller status.
$taxFlags : array<int, string>|null
$taxNote : string|null: Note in the document language (plus Czech), resolved at creation.
$taxTreatment : string|null: Treatment code; on a payment also the markers `INTERMEDIARY` and `CREDIT_REDEMPTION`.
$totalPrice : string
$totalPriceWithVat : string
$updateDatetime : DateTime|null
$updateUserId : int|null
$updateUserIp : string|null
$useDeliveryAddress : bool
$user : TUser|null
$userDiscountPercents : string
$userIsUpdated : bool
$userType : TUserType|null
$variableSymbol : string|null
$vouchers : Collection<int, OrderVoucher>
$withVat : bool

Methods

__construct() : mixed
addGift() : $this
addItem() : $this
addPaymentRel() : $this
addVoucher() : $this
callInitMethods() : void: Calls `init{TraitName}()` for every used trait that defines such a method.
getAllTraits() : array<string, string>: Returns all traits the class uses, including those used by parent classes and nested traits.
getBankAccount() : string|null
getBankName() : string|null
getBuyerType() : int
getCurrency() : TCurrency|null
getCustomerCity() : string|null
getCustomerCompanyName() : string|null
getCustomerContactId() : int|null
getCustomerCountry() : string|null
getCustomerCountryCode() : string|null
getCustomerDlvCity() : string|null
getCustomerDlvCountry() : string|null
getCustomerDlvCountryCode() : string|null
getCustomerDlvInformations() : string|null
getCustomerDlvName() : string|null
getCustomerDlvPostcode() : string|null
getCustomerDlvStreet() : string|null
getCustomerEmail() : string|null
getCustomerFirstname() : string|null
getCustomerId() : int|null
getCustomerInformations() : string|null
getCustomerLastname() : string|null
getCustomerPhone() : string|null
getCustomerPostcode() : string|null
getCustomerRegNo() : string|null
getCustomerStreet() : string|null
getCustomerVatId() : string|null
getCustomerVatIdCheckId() : int|null
getCustomerVatIdOutageCheckId() : int|null
getCustomerVatIdVerified() : bool|null
getCustomerVatIdVerifiedAt() : DateTime|null
getExpeditionCode() : string|null
getExpeditionDatetime() : DateTime|null
getExpeditionInformations() : string|null
getExpeditionShipper() : TExpeditionShipper|null
getExpeditionShipperBranchId() : int|null
getGifts() : Collection<int, TOrderGift>
getGridInvoices() : array<int, Invoice>
getIban() : string|null
getId() : int|null
getInformations() : string|null
getInsertDatetime() : DateTime|null
getInsertUserIp() : string|null
getInvoicedStatus() : int|null
getIsCancelled() : bool
getItems() : Collection<int, TItem>
getLanguage() : TLanguage|null
getLocalization() : object|null
getLocalizationId() : int|null: Prefers the object over the scalar (a freshly set localization wins over the mirror loaded from the DB). `$localization` is an untyped `object`, hence the guard instead of a plain `?->getId()`: without it PHPStan reports `object::getId()` and a foreign object in the association would fail at runtime.
getOrderNumber() : string
getOwnerUserId() : int|null
getPayment() : TPayment|null
getPaymentMethod() : TOrderPaymentMethod|null
getPaymentRegion() : TPaymentRegion|null
getPayments() : Collection<int, TOrderPayment>
getRegion() : TRegion|null
getReservationExpiresAt() : DateTime|null
getRoundedTotalPrice() : string
getRoundedTotalPriceWithVat() : string
getRounding() : string
getRoundingVat() : string
getSellerBankAccountId() : int|null
getSellerCity() : string|null
getSellerContactId() : int|null
getSellerCountry() : string|null
getSellerEmail() : string|null
getSellerId() : int|null
getSellerInformations() : string|null
getSellerName() : string|null
getSellerPhone() : string|null
getSellerPostcode() : string|null
getSellerRegNo() : string|null
getSellerStreet() : string|null
getSellerVatId() : string|null
getSellerVatInformations() : string|null
getShipper() : TOrderShipper|null
getStatus() : TStatus|null
getStatusInformations() : string|null
getStockDocumentId() : int|null
getStockState() : string
getSummaryReportCode() : string|null
getSwift() : string|null
getTaxCountryCode() : string|null
getTaxDate() : DateTime|null
getTaxFlags() : array<int, string>|null
getTaxNote() : string|null
getTaxTreatment() : string|null
getTotalPrice() : string
getTotalPriceWithVat() : string
getUpdateDatetime() : DateTime|null
getUpdateUserId() : int|null
getUpdateUserIp() : string|null
getUseDeliveryAddress() : bool
getUser() : TUser|null
getUserDiscountPercents() : string
getUserDiscountPercentsAsFloat() : float
getUserIsUpdated() : bool
getUserType() : TUserType|null
getVariableSymbol() : string|null
getVouchers() : Collection<int, TOrderVoucher>
getWithVat() : bool
hasTaxFlag() : bool
isCancelled() : bool
isPersisted() : bool
setBankAccount() : $this
setBankName() : $this
setBuyerType() : $this
setCurrency() : $this
setCustomerCity() : $this
setCustomerCompanyName() : $this
setCustomerContactId() : $this
setCustomerCountry() : $this
setCustomerCountryCode() : $this
setCustomerDlvCity() : $this
setCustomerDlvCountry() : $this
setCustomerDlvCountryCode() : $this
setCustomerDlvInformations() : $this
setCustomerDlvName() : $this
setCustomerDlvPostcode() : $this
setCustomerDlvStreet() : $this
setCustomerEmail() : $this
setCustomerFirstname() : $this
setCustomerId() : $this
setCustomerInformations() : $this
setCustomerLastname() : $this
setCustomerPhone() : $this
setCustomerPostcode() : $this
setCustomerRegNo() : $this
setCustomerStreet() : $this
setCustomerVatId() : $this
setCustomerVatIdCheckId() : static
setCustomerVatIdOutageCheckId() : static
setCustomerVatIdVerified() : static
setCustomerVatIdVerifiedAt() : static
setExpeditionCode() : $this
setExpeditionDatetime() : $this
setExpeditionInformations() : $this
setExpeditionShipper() : $this
setExpeditionShipperBranchId() : $this
setGifts() : $this
setGridInvoices() : self
setIban() : $this
setId() : $this
setInformations() : $this
setInsertDatetime() : $this
setInsertUserIp() : $this
setInvoicedStatus() : $this
setIsCancelled() : $this
setItems() : $this
setLanguage() : $this
setLocalization() : $this: IMPORTANT: deliberately without the side effect `$this->localizationId = $localization?->getId()`.
setOrderNumber() : $this
setPayment() : $this
setPaymentMethod() : $this
setPaymentRegion() : $this
setPayments() : $this
setRegion() : $this
setReservationExpiresAt() : $this
setRoundedTotalPrice() : $this
setRoundedTotalPriceWithVat() : $this
setRounding() : $this
setRoundingVat() : $this
setSellerBankAccountId() : $this
setSellerCity() : $this
setSellerContactId() : $this
setSellerCountry() : $this
setSellerEmail() : $this
setSellerId() : $this
setSellerInformations() : $this
setSellerName() : $this
setSellerPhone() : $this
setSellerPostcode() : $this
setSellerRegNo() : $this
setSellerStreet() : $this
setSellerVatId() : $this
setSellerVatInformations() : $this
setShipper() : $this
setStatus() : $this
setStatusInformations() : $this
setStockDocumentId() : $this
setStockState() : $this
setSummaryReportCode() : static
setSwift() : $this
setTaxCountryCode() : static
setTaxDate() : static
setTaxFlags() : static
setTaxNote() : static
setTaxTreatment() : static
setTotalPrice() : $this
setTotalPriceWithVat() : $this
setUpdateDatetime() : $this
setUpdateUserId() : $this
setUpdateUserIp() : $this
setUseDeliveryAddress() : $this
setUser() : $this
setUserDiscountPercents() : $this
setUserIsUpdated() : $this
setUserType() : $this
setVariableSymbol() : $this
setVouchers() : $this
setWithVat() : $this
getTraitsRecursive() : array<string, string>: Walks the trait list recursively and collects nested traits too.

$bankAccount


        protected
            string|null
    $bankAccount
     = null

#[Column]: $name: 'bank_account'; $type: 'string'; $length: 50; $nullable: true

#[ExternalReadonly]

$bankName


        protected
            string|null
    $bankName
     = null

#[Column]: $name: 'bank_name'; $type: 'string'; $length: 255; $nullable: true

#[ExternalReadonly]

$buyerType


        protected
            int
    $buyerType
     = 0

#[Column]: $name: 'buyer_type'; $type: 'integer'; $options: ['unsigned' => true]

$currency


        protected
            TCurrency|null
    $currency
     = null

#[EntityOf]: \App\UI\Admin\System\Models\Entities\Currency::class

#[JoinColumn]: $name: 'cms_system_currencies_currency_id'; $referencedColumnName: 'currency_id'; $nullable: true; $onDelete: 'SET NULL'

#[ManyToOne]: $targetEntity: \App\UI\Admin\System\Models\Entities\Currency::class; $fetch: 'LAZY'

$customerCity


        protected
            string|null
    $customerCity
     = null

#[Column]: $name: 'customer_city'; $type: 'string'; $length: 255; $nullable: true

$customerCompanyName


        protected
            string|null
    $customerCompanyName
     = null

#[Column]: $name: 'customer_company_name'; $type: 'string'; $length: 255; $nullable: true

$customerContactId


        protected
            int|null
    $customerContactId
     = null

#[Column]: $name: 'cms_mod_invoicer_customer_contacts_customer_contact_id'; $type: 'integer'; $options: ['unsigned' => true]; $nullable: true

#[ExternalReadonly]

$customerCountry


        protected
            string|null
    $customerCountry
     = null

#[Column]: $name: 'customer_country'; $type: 'string'; $length: 255; $nullable: true

$customerCountryCode


        protected
            string|null
    $customerCountryCode
     = null

#[Column]: $name: 'customer_country_code'; $type: 'string'; $length: 2; $nullable: true; $options: ['fixed' => true]

$customerDlvCity


        protected
            string|null
    $customerDlvCity
     = null

#[Column]: $name: 'customer_dlv_city'; $type: 'string'; $length: 255; $nullable: true

$customerDlvCountry


        protected
            string|null
    $customerDlvCountry
     = null

#[Column]: $name: 'customer_dlv_country'; $type: 'string'; $length: 255; $nullable: true

$customerDlvCountryCode


        protected
            string|null
    $customerDlvCountryCode
     = null

#[Column]: $name: 'customer_dlv_country_code'; $type: 'string'; $length: 2; $nullable: true; $options: ['fixed' => true]

$customerDlvInformations


        protected
            string|null
    $customerDlvInformations
     = null

#[Column]: $name: 'customer_dlv_informations'; $type: 'text'; $nullable: true

$customerDlvName


        protected
            string|null
    $customerDlvName
     = null

#[Column]: $name: 'customer_dlv_name'; $type: 'string'; $length: 255; $nullable: true

$customerDlvPostcode


        protected
            string|null
    $customerDlvPostcode
     = null

Attributes

#[Column]: $name: 'customer_dlv_postcode'; $type: 'string'; $length: 20; $nullable: true

$customerDlvStreet


        protected
            string|null
    $customerDlvStreet
     = null

#[Column]: $name: 'customer_dlv_street'; $type: 'string'; $length: 255; $nullable: true

$customerEmail


        protected
            string|null
    $customerEmail
     = null

#[Column]: $name: 'customer_email'; $type: 'string'; $length: 255; $nullable: true

$customerFirstname


        protected
            string|null
    $customerFirstname
     = null

#[Column]: $name: 'customer_firstname'; $type: 'string'; $length: 255; $nullable: true

$customerId


        protected
            int|null
    $customerId
     = null

#[Column]: $name: 'cms_mod_invoicer_customers_customer_id'; $type: 'integer'; $options: ['unsigned' => true]; $nullable: true

#[ExternalReadonly]

$customerInformations


        protected
            string|null
    $customerInformations
     = null

#[Column]: $name: 'customer_informations'; $type: 'text'; $nullable: true

$customerLastname


        protected
            string|null
    $customerLastname
     = null

#[Column]: $name: 'customer_lastname'; $type: 'string'; $length: 255; $nullable: true

$customerPhone


        protected
            string|null
    $customerPhone
     = null

#[Column]: $name: 'customer_phone'; $type: 'string'; $length: 255; $nullable: true

$customerPostcode


        protected
            string|null
    $customerPostcode
     = null

Attributes

#[Column]: $name: 'customer_postcode'; $type: 'string'; $length: 20; $nullable: true

$customerRegNo


        protected
            string|null
    $customerRegNo
     = null

#[Column]: $name: 'customer_reg_no'; $type: 'string'; $length: 255; $nullable: true

$customerStreet


        protected
            string|null
    $customerStreet
     = null

#[Column]: $name: 'customer_street'; $type: 'string'; $length: 255; $nullable: true

$customerVatId


        protected
            string|null
    $customerVatId
     = null

#[Column]: $name: 'customer_vat_id'; $type: 'string'; $length: 255; $nullable: true

$customerVatIdCheckId

Applied VAT id check (`cms_system_vat_id_checks`): consultation number or manual proof.


        protected
            int|null
    $customerVatIdCheckId
     = null

#[Column]: $name: 'customer_vat_id_check_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

#[ExternalReadonly]

$customerVatIdOutageCheckId

Record of a VIES outage on the supply date.


        protected
            int|null
    $customerVatIdOutageCheckId
     = null

#[Column]: $name: 'customer_vat_id_outage_check_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

#[ExternalReadonly]

$customerVatIdVerified

Null means the VAT id does not matter (empty or domestic); false is unverified; true is verified.


        protected
            bool|null
    $customerVatIdVerified
     = null

#[Column]: $name: 'customer_vat_id_verified'; $type: 'boolean'; $nullable: true

#[ExternalReadonly]

$customerVatIdVerifiedAt


        protected
            DateTime|null
    $customerVatIdVerifiedAt
     = null

#[Column]: $name: 'customer_vat_id_verified_at'; $type: 'datetime'; $nullable: true

#[ExternalReadonly]

$expeditionCode


        protected
            string|null
    $expeditionCode
     = null

#[Column]: $name: 'expedition_code'; $type: 'string'; $length: 80; $nullable: true

$expeditionDatetime


        protected
            DateTime|null
    $expeditionDatetime
     = null

#[Column]: $name: 'expedition_datetime'; $type: 'datetime'; $nullable: true

#[ExternalReadonly]

$expeditionInformations


        protected
            string|null
    $expeditionInformations
     = null

#[Column]: $name: 'expedition_informations'; $type: 'text'; $nullable: true

$expeditionShipper


        protected
            TExpeditionShipper|null
    $expeditionShipper
     = null

#[EntityOf]: \App\UI\Admin\Eshop\Models\Entities\Shipper::class

#[JoinColumn]: $name: 'expedition_shipper_id'; $referencedColumnName: 'shipper_id'; $nullable: true; $onDelete: 'SET NULL'

#[ManyToOne]: $targetEntity: \App\UI\Admin\Eshop\Models\Entities\Shipper::class; $fetch: 'LAZY'

$expeditionShipperBranchId


        protected
            int|null
    $expeditionShipperBranchId
     = null

#[Column]: $name: 'expedition_shipper_branch_id'; $type: 'integer'; $options: ['unsigned' => true]; $nullable: true

$gifts


        protected
            Collection<int, OrderGift>
    $gifts

#[CollectionOf]: \App\UI\Admin\Eshop\Models\Entities\OrderGift::class; $owned: true

#[OneToMany]: $targetEntity: \App\UI\Admin\Eshop\Models\Entities\OrderGift::class; $mappedBy: 'order'; $cascade: ['persist', 'remove']; $orphanRemoval: true; $fetch: 'LAZY'

$gridInvoices


        protected
            array<int, Invoice>
    $gridInvoices
     = []

#[Transient]

$iban


        protected
            string|null
    $iban
     = null

#[Column]: $name: 'iban'; $type: 'string'; $length: 255; $nullable: true

#[ExternalReadonly]

$id


        protected
            int|null
    $id
     = null

#[Column]: $name: 'order_id'; $type: 'integer'; $options: ['unsigned' => true]

#[GeneratedValue]

#[Id]

$informations


        protected
            string|null
    $informations
     = null

#[Column]: $name: 'informations'; $type: 'text'; $nullable: true

$insertDatetime


        protected
            DateTime|null
    $insertDatetime
     = null

#[Column]: $name: 'insert_datetime'; $type: 'datetime'

#[ExternalReadonly]

$insertUserIp


        protected
            string|null
    $insertUserIp
     = null

#[Column]: $name: 'insert_user_ip'; $type: 'string'; $length: 45; $nullable: true

#[ExternalReadonly]

#[PersonalData]: PersonalDataKind::Hidden

$invoicedStatus


        protected
            int|null
    $invoicedStatus
     = null

#[Column]: $name: 'invoiced_status'; $type: 'integer'; $nullable: true

#[ExternalReadonly]

$isCancelled


        protected
            bool
    $isCancelled
     = false

#[Column]: $name: 'is_cancelled'; $type: 'boolean'

#[ExternalReadonly]

$items


        protected
            Collection<int, OrderItem>
    $items

#[CollectionOf]: \App\UI\Admin\Eshop\Models\Entities\OrderItem::class; $owned: true

#[OneToMany]: $targetEntity: \App\UI\Admin\Eshop\Models\Entities\OrderItem::class; $mappedBy: 'order'; $cascade: ['persist', 'remove']; $orphanRemoval: true; $fetch: 'LAZY'

$language


        protected
            TLanguage|null
    $language
     = null

#[EntityOf]: \App\UI\Admin\System\Models\Entities\Language::class

#[JoinColumn]: $name: 'cms_system_languages_language_id'; $referencedColumnName: 'language_id'; $nullable: true; $onDelete: 'SET NULL'

#[ManyToOne]: $targetEntity: \App\UI\Admin\System\Models\Entities\Language::class; $fetch: 'LAZY'

$localization

Invoice localization: number and currency formats come from here, not from the current request.


        protected
            object|null
    $localization
     = null

Load it with ->include(['localization']), like the currency.

#[EntityOf]: \App\UI\Admin\System\Models\Entities\Localization::class

#[JoinColumn]: $name: 'cms_system_localizations_localization_id'; $referencedColumnName: 'localization_id'; $onDelete: 'SET NULL'

#[ManyToOne]: $targetEntity: \App\UI\Admin\System\Models\Entities\Localization::class; $fetch: 'LAZY'

$orderNumber


        protected
            string
    $orderNumber
     = ''

#[Column]: $name: 'order_number'; $type: 'string'; $length: 30

#[ExternalReadonly]

$payment


        protected
            TPayment|null
    $payment
     = null

last matched payment (denormalized; the full list is $payments)

#[EntityOf]: \App\UI\Admin\System\Models\Entities\Payment::class

#[JoinColumn]: $name: 'cms_system_payments_payment_id'; $referencedColumnName: 'payment_id'; $nullable: true; $onDelete: 'SET NULL'

#[ManyToOne]: $targetEntity: \App\UI\Admin\System\Models\Entities\Payment::class; $fetch: 'LAZY'

$paymentMethod


        protected
            OrderPaymentMethod|null
    $paymentMethod
     = null

#[EntityOf]: \App\UI\Admin\Eshop\Models\Entities\OrderPaymentMethod::class

#[OneToOne]: $targetEntity: \App\UI\Admin\Eshop\Models\Entities\OrderPaymentMethod::class; $mappedBy: 'order'; $cascade: ['persist', 'remove']; $orphanRemoval: true; $fetch: 'LAZY'

$paymentRegion


        protected
            TPaymentRegion|null
    $paymentRegion
     = null

#[EntityOf]: \App\UI\Admin\System\Models\Entities\PaymentRegion::class

#[JoinColumn]: $name: 'cms_system_payment_regions_payment_region_id'; $referencedColumnName: 'payment_region_id'; $nullable: true; $onDelete: 'SET NULL'

#[ManyToOne]: $targetEntity: \App\UI\Admin\System\Models\Entities\PaymentRegion::class; $fetch: 'LAZY'

$payments


        protected
            Collection<int, OrderPayment>
    $payments

#[CollectionOf]: \App\UI\Admin\Eshop\Models\Entities\OrderPayment::class; $owned: true

#[OneToMany]: $targetEntity: \App\UI\Admin\Eshop\Models\Entities\OrderPayment::class; $mappedBy: 'order'; $cascade: ['persist', 'remove']; $orphanRemoval: true; $fetch: 'LAZY'

$region


        protected
            TRegion|null
    $region
     = null

geographic region of the customer

#[EntityOf]: \App\UI\Admin\System\Models\Entities\Region::class

#[JoinColumn]: $name: 'cms_system_regions_region_id'; $referencedColumnName: 'region_id'; $nullable: true; $onDelete: 'SET NULL'

#[ManyToOne]: $targetEntity: \App\UI\Admin\System\Models\Entities\Region::class; $fetch: 'LAZY'

$reservationExpiresAt


        protected
            DateTime|null
    $reservationExpiresAt
     = null

#[Column]: $name: 'reservation_expires_at'; $type: 'datetime'; $nullable: true

#[ExternalReadonly]

$roundedTotalPrice


        protected
            string
    $roundedTotalPrice
     = '0.000'

#[Column]: $name: 'rounded_total_price'; $type: 'decimal'; $precision: 10; $scale: 3

#[ExternalReadonly]

$roundedTotalPriceWithVat


        protected
            string
    $roundedTotalPriceWithVat
     = '0.000'

#[Column]: $name: 'rounded_total_price_with_vat'; $type: 'decimal'; $precision: 10; $scale: 3

#[ExternalReadonly]

$rounding


        protected
            string
    $rounding
     = '0.000'

#[Column]: $name: 'rounding'; $type: 'decimal'; $precision: 10; $scale: 3

#[ExternalReadonly]

$roundingVat


        protected
            string
    $roundingVat
     = '0.000'

#[Column]: $name: 'rounding_vat'; $type: 'decimal'; $precision: 10; $scale: 3

#[ExternalReadonly]

$sellerBankAccountId


        protected
            int|null
    $sellerBankAccountId
     = null

#[Column]: $name: 'cms_mod_invoicer_seller_bank_accounts_seller_bank_account_id'; $type: 'integer'; $options: ['unsigned' => true]; $nullable: true

#[ExternalReadonly]

$sellerCity


        protected
            string|null
    $sellerCity
     = null

#[Column]: $name: 'seller_city'; $type: 'string'; $length: 255; $nullable: true

#[ExternalReadonly]

$sellerContactId


        protected
            int|null
    $sellerContactId
     = null

#[Column]: $name: 'cms_mod_invoicer_seller_contacts_seller_contact_id'; $type: 'integer'; $options: ['unsigned' => true]; $nullable: true

#[ExternalReadonly]

$sellerCountry


        protected
            string|null
    $sellerCountry
     = null

#[Column]: $name: 'seller_country'; $type: 'string'; $length: 255; $nullable: true

#[ExternalReadonly]

$sellerEmail


        protected
            string|null
    $sellerEmail
     = null

#[Column]: $name: 'seller_email'; $type: 'string'; $length: 255; $nullable: true

#[ExternalReadonly]

$sellerId


        protected
            int|null
    $sellerId
     = null

#[Column]: $name: 'cms_mod_invoicer_sellers_seller_id'; $type: 'integer'; $options: ['unsigned' => true]; $nullable: true

#[ExternalReadonly]

$sellerInformations


        protected
            string|null
    $sellerInformations
     = null

#[Column]: $name: 'seller_informations'; $type: 'text'; $nullable: true

#[ExternalReadonly]

$sellerName


        protected
            string|null
    $sellerName
     = null

#[Column]: $name: 'seller_name'; $type: 'string'; $length: 255; $nullable: true

#[ExternalReadonly]

$sellerPhone


        protected
            string|null
    $sellerPhone
     = null

#[Column]: $name: 'seller_phone'; $type: 'string'; $length: 255; $nullable: true

#[ExternalReadonly]

$sellerPostcode


        protected
            string|null
    $sellerPostcode
     = null

Attributes

#[Column]: $name: 'seller_postcode'; $type: 'string'; $length: 20; $nullable: true

#[ExternalReadonly]

$sellerRegNo


        protected
            string|null
    $sellerRegNo
     = null

#[Column]: $name: 'seller_reg_no'; $type: 'string'; $length: 255; $nullable: true

#[ExternalReadonly]

$sellerStreet


        protected
            string|null
    $sellerStreet
     = null

#[Column]: $name: 'seller_street'; $type: 'string'; $length: 255; $nullable: true

#[ExternalReadonly]

$sellerVatId


        protected
            string|null
    $sellerVatId
     = null

#[Column]: $name: 'seller_vat_id'; $type: 'string'; $length: 255; $nullable: true

#[ExternalReadonly]

$sellerVatInformations


        protected
            string|null
    $sellerVatInformations
     = null

#[Column]: $name: 'seller_vat_informations'; $type: 'text'; $nullable: true

#[ExternalReadonly]

$shipper


        protected
            OrderShipper|null
    $shipper
     = null

#[EntityOf]: \App\UI\Admin\Eshop\Models\Entities\OrderShipper::class

#[OneToOne]: $targetEntity: \App\UI\Admin\Eshop\Models\Entities\OrderShipper::class; $mappedBy: 'order'; $cascade: ['persist', 'remove']; $orphanRemoval: true; $fetch: 'LAZY'

$status


        protected
            TStatus|null
    $status
     = null

#[EntityOf]: \App\UI\Admin\Eshop\Models\Entities\OrderStatus::class

#[JoinColumn]: $name: 'cms_mod_eshop_order_statuses_order_status_id'; $referencedColumnName: 'order_status_id'; $nullable: true; $onDelete: 'SET NULL'

#[ManyToOne]: $targetEntity: \App\UI\Admin\Eshop\Models\Entities\OrderStatus::class; $fetch: 'LAZY'

$statusInformations


        protected
            string|null
    $statusInformations
     = null

#[Column]: $name: 'status_informations'; $type: 'text'; $nullable: true

$stockDocumentId


        protected
            int|null
    $stockDocumentId
     = null

#[Column]: $name: 'stock_document_id'; $type: 'integer'; $options: ['unsigned' => true]; $nullable: true

#[ExternalReadonly]

$stockState


        protected
            string
    $stockState
     = OrderStockState::NONE

#[Column]: $name: 'stock_state'; $type: 'string'; $length: 20

#[ExternalReadonly]

$summaryReportCode

Supply code for the summary report (`3` services, `0` goods); null means it is not reported.


        protected
            string|null
    $summaryReportCode
     = null

Attributes

#[Column]: $name: 'summary_report_code'; $type: 'string'; $length: 1; $nullable: true; $options: ['fixed' => true]

#[ExternalReadonly]

$swift


        protected
            string|null
    $swift
     = null

#[Column]: $name: 'swift'; $type: 'string'; $length: 255; $nullable: true

#[ExternalReadonly]

$taxCountryCode

Country of the applied rate (null without VAT).


        protected
            string|null
    $taxCountryCode
     = null

#[Column]: $name: 'tax_country_code'; $type: 'string'; $length: 2; $nullable: true; $options: ['fixed' => true]

#[ExternalReadonly]

$taxDate

Date of the rate and of the seller status.


        protected
            DateTime|null
    $taxDate
     = null

#[Column]: $name: 'tax_date'; $type: 'date'; $nullable: true

#[ExternalReadonly]

$taxFlags


        protected
            array<int, string>|null
    $taxFlags
     = null

TaxFlag codes

#[Column]: $name: 'tax_flags'; $type: 'json'; $nullable: true

#[ExternalReadonly]

$taxNote

Note in the document language (plus Czech), resolved at creation.


        protected
            string|null
    $taxNote
     = null

#[Column]: $name: 'tax_note'; $type: 'text'; $nullable: true

#[ExternalReadonly]

$taxTreatment

Treatment code; on a payment also the markers `INTERMEDIARY` and `CREDIT_REDEMPTION`.


        protected
            string|null
    $taxTreatment
     = null

#[Column]: $name: 'tax_treatment'; $type: 'string'; $length: 24; $nullable: true

#[ExternalReadonly]

$totalPrice


        protected
            string
    $totalPrice
     = '0.000'

#[Column]: $name: 'total_price'; $type: 'decimal'; $precision: 10; $scale: 3

#[ExternalReadonly]

$totalPriceWithVat


        protected
            string
    $totalPriceWithVat
     = '0.000'

#[Column]: $name: 'total_price_with_vat'; $type: 'decimal'; $precision: 10; $scale: 3

#[ExternalReadonly]

$updateDatetime


        protected
            DateTime|null
    $updateDatetime
     = null

#[Column]: $name: 'update_datetime'; $type: 'datetime'; $nullable: true

#[ExternalReadonly]

$updateUserId


        protected
            int|null
    $updateUserId
     = null

#[Column]: $name: 'update_user_id'; $type: 'integer'; $options: ['unsigned' => true]; $nullable: true

#[ExternalReadonly]

$updateUserIp


        protected
            string|null
    $updateUserIp
     = null

#[Column]: $name: 'update_user_ip'; $type: 'string'; $length: 45; $nullable: true

#[ExternalReadonly]

#[PersonalData]: PersonalDataKind::Hidden

$useDeliveryAddress


        protected
            bool
    $useDeliveryAddress
     = false

#[Column]: $name: 'use_delivery_address'; $type: 'boolean'

$user


        protected
            TUser|null
    $user
     = null

#[EntityOf]: \App\UI\Admin\System\Models\Entities\User::class

#[JoinColumn]: $name: 'cms_system_users_user_id'; $referencedColumnName: 'user_id'; $nullable: true; $onDelete: 'SET NULL'

#[ManyToOne]: $targetEntity: \App\UI\Admin\System\Models\Entities\User::class; $fetch: 'LAZY'

$userDiscountPercents


        protected
            string
    $userDiscountPercents
     = '0.00'

#[Column]: $name: 'user_discount_percents'; $type: 'decimal'; $precision: 5; $scale: 2; $options: ['unsigned' => true]

#[ExternalReadonly]

$userIsUpdated


        protected
            bool
    $userIsUpdated
     = false

#[Column]: $name: 'user_is_updated'; $type: 'boolean'

#[ExternalReadonly]

$userType


        protected
            TUserType|null
    $userType
     = null

#[EntityOf]: \App\UI\Admin\System\Models\Entities\UserType::class

#[JoinColumn]: $name: 'cms_system_user_types_user_type_id'; $referencedColumnName: 'user_type_id'; $nullable: true; $onDelete: 'SET NULL'

#[ManyToOne]: $targetEntity: \App\UI\Admin\System\Models\Entities\UserType::class; $fetch: 'LAZY'

$variableSymbol


        protected
            string|null
    $variableSymbol
     = null

#[Column]: $name: 'variable_symbol'; $type: 'string'; $length: 50; $nullable: true

#[ExternalReadonly]

$vouchers


        protected
            Collection<int, OrderVoucher>
    $vouchers

#[CollectionOf]: \App\UI\Admin\Eshop\Models\Entities\OrderVoucher::class; $owned: true

#[OneToMany]: $targetEntity: \App\UI\Admin\Eshop\Models\Entities\OrderVoucher::class; $mappedBy: 'order'; $cascade: ['persist', 'remove']; $orphanRemoval: true; $fetch: 'LAZY'

$withVat


        protected
            bool
    $withVat
     = true

#[Column]: $name: 'with_vat'; $type: 'boolean'

__construct()


    public
                    __construct([int|null $id = null ][, string $orderNumber = '' ][, string|null $variableSymbol = null ][, mixed $user = null ][, mixed $language = null ][, mixed $currency = null ][, mixed $status = null ][, mixed $userType = null ][, mixed $paymentRegion = null ][, string $userDiscountPercents = '0.00' ][, bool $withVat = true ][, string $totalPrice = '0.000' ][, string $totalPriceWithVat = '0.000' ][, string $roundedTotalPrice = '0.000' ][, string $roundedTotalPriceWithVat = '0.000' ][, string $rounding = '0.000' ][, string $roundingVat = '0.000' ][, int $buyerType = 0 ][, int|null $sellerId = null ][, int|null $sellerContactId = null ][, int|null $sellerBankAccountId = null ][, string|null $sellerName = null ][, string|null $sellerStreet = null ][, string|null $sellerCity = null ][, string|null $sellerPostcode = null ][, string|null $sellerCountry = null ][, string|null $sellerRegNo = null ][, string|null $sellerVatId = null ][, string|null $sellerEmail = null ][, string|null $sellerPhone = null ][, string|null $sellerInformations = null ][, string|null $sellerVatInformations = null ][, string|null $bankName = null ][, string|null $bankAccount = null ][, string|null $iban = null ][, string|null $swift = null ][, int|null $customerId = null ][, int|null $customerContactId = null ][, string|null $customerCompanyName = null ][, string|null $customerRegNo = null ][, string|null $customerVatId = null ][, string|null $customerFirstname = null ][, string|null $customerLastname = null ][, string|null $customerStreet = null ][, string|null $customerCity = null ][, string|null $customerPostcode = null ][, string|null $customerCountry = null ][, string|null $customerCountryCode = null ][, string|null $customerEmail = null ][, string|null $customerPhone = null ][, mixed $region = null ][, string|null $customerDlvName = null ][, string|null $customerDlvStreet = null ][, string|null $customerDlvCity = null ][, string|null $customerDlvPostcode = null ][, string|null $customerDlvCountry = null ][, string|null $customerDlvCountryCode = null ][, string|null $customerDlvInformations = null ][, string|null $customerInformations = null ][, bool $useDeliveryAddress = false ][, string|null $informations = null ][, string|null $statusInformations = null ][, DateTime|null $expeditionDatetime = null ][, mixed $expeditionShipper = null ][, int|null $expeditionShipperBranchId = null ][, string|null $expeditionCode = null ][, string|null $expeditionInformations = null ][, mixed $payment = null ][, string $stockState = OrderStockState::NONE ][, int|null $stockDocumentId = null ][, DateTime|null $reservationExpiresAt = null ][, int|null $invoicedStatus = null ][, bool $isCancelled = false ][, bool $userIsUpdated = false ][, DateTime|null $insertDatetime = null ][, string|null $insertUserIp = null ][, DateTime|null $updateDatetime = null ][, int|null $updateUserId = null ][, string|null $updateUserIp = null ][, Collection $items = new ArrayCollection() ][, mixed $shipper = null ][, mixed $paymentMethod = null ][, Collection $vouchers = new ArrayCollection() ][, Collection $gifts = new ArrayCollection() ][, Collection $payments = new ArrayCollection() ][, mixed $localization = null ][, int|null $localizationId = null ]) : mixed

Parameters

$id : int|null = null
$orderNumber : string = ''
$variableSymbol : string|null = null
$user : mixed = null
$language : mixed = null
$currency : mixed = null
$status : mixed = null
$userType : mixed = null
$paymentRegion : mixed = null
$userDiscountPercents : string = '0.00'
$withVat : bool = true
$totalPrice : string = '0.000'
$totalPriceWithVat : string = '0.000'
$roundedTotalPrice : string = '0.000'
$roundedTotalPriceWithVat : string = '0.000'
$rounding : string = '0.000'
$roundingVat : string = '0.000'
$buyerType : int = 0
$sellerId : int|null = null
$sellerContactId : int|null = null
$sellerBankAccountId : int|null = null
$sellerName : string|null = null
$sellerStreet : string|null = null
$sellerCity : string|null = null
$sellerPostcode : string|null = null
$sellerCountry : string|null = null
$sellerRegNo : string|null = null
$sellerVatId : string|null = null
$sellerEmail : string|null = null
$sellerPhone : string|null = null
$sellerInformations : string|null = null
$sellerVatInformations : string|null = null
$bankName : string|null = null
$bankAccount : string|null = null
$iban : string|null = null
$swift : string|null = null
$customerId : int|null = null
$customerContactId : int|null = null
$customerCompanyName : string|null = null
$customerRegNo : string|null = null
$customerVatId : string|null = null
$customerFirstname : string|null = null
$customerLastname : string|null = null
$customerStreet : string|null = null
$customerCity : string|null = null
$customerPostcode : string|null = null
$customerCountry : string|null = null
$customerCountryCode : string|null = null
$customerEmail : string|null = null
$customerPhone : string|null = null
$region : mixed = null
$customerDlvName : string|null = null
$customerDlvStreet : string|null = null
$customerDlvCity : string|null = null
$customerDlvPostcode : string|null = null
$customerDlvCountry : string|null = null
$customerDlvCountryCode : string|null = null
$customerDlvInformations : string|null = null
$customerInformations : string|null = null
$useDeliveryAddress : bool = false
$informations : string|null = null
$statusInformations : string|null = null
$expeditionDatetime : DateTime|null = null
$expeditionShipper : mixed = null
$expeditionShipperBranchId : int|null = null
$expeditionCode : string|null = null
$expeditionInformations : string|null = null
$payment : mixed = null
$stockState : string = OrderStockState::NONE
$stockDocumentId : int|null = null
$reservationExpiresAt : DateTime|null = null
$invoicedStatus : int|null = null
$isCancelled : bool = false
$userIsUpdated : bool = false
$insertDatetime : DateTime|null = null
$insertUserIp : string|null = null
$updateDatetime : DateTime|null = null
$updateUserId : int|null = null
$updateUserIp : string|null = null
$items : Collection = new ArrayCollection()
$shipper : mixed = null
$paymentMethod : mixed = null
$vouchers : Collection = new ArrayCollection()
$gifts : Collection = new ArrayCollection()
$payments : Collection = new ArrayCollection()
$localization : mixed = null
$localizationId : int|null = null

addGift()


    public
                    addGift(TOrderGift $gift) : $this

Parameters

$gift : TOrderGift

Return values

$this

addItem()


    public
                    addItem(TItem $item) : $this

Parameters

$item : TItem

Return values

$this

addPaymentRel()


    public
                    addPaymentRel(TOrderPayment $payment) : $this

Parameters

$payment : TOrderPayment

Return values

$this

addVoucher()


    public
                    addVoucher(TOrderVoucher $voucher) : $this

Parameters

$voucher : TOrderVoucher

Return values

$this

callInitMethods()

Calls `init{TraitName}()` for every used trait that defines such a method.


    public
                    callInitMethods() : void

getAllTraits()

Returns all traits the class uses, including those used by parent classes and nested traits.


    public
                    getAllTraits() : array<string, string>

Return values

array<string, string>

getBankAccount()


    public
                    getBankAccount() : string|null

Return values

string|null

getBankName()


    public
                    getBankName() : string|null

Return values

string|null

getBuyerType()


    public
                    getBuyerType() : int

Return values

int

getCurrency()


    public
                    getCurrency() : TCurrency|null

Return values

TCurrency|null

getCustomerCity()


    public
                    getCustomerCity() : string|null

Return values

string|null

getCustomerCompanyName()


    public
                    getCustomerCompanyName() : string|null

Return values

string|null

getCustomerContactId()


    public
                    getCustomerContactId() : int|null

Return values

int|null

getCustomerCountry()


    public
                    getCustomerCountry() : string|null

Return values

string|null

getCustomerCountryCode()


    public
                    getCustomerCountryCode() : string|null

Return values

string|null

getCustomerDlvCity()


    public
                    getCustomerDlvCity() : string|null

Return values

string|null

getCustomerDlvCountry()


    public
                    getCustomerDlvCountry() : string|null

Return values

string|null

getCustomerDlvCountryCode()


    public
                    getCustomerDlvCountryCode() : string|null

Return values

string|null

getCustomerDlvInformations()


    public
                    getCustomerDlvInformations() : string|null

Return values

string|null

getCustomerDlvName()


    public
                    getCustomerDlvName() : string|null

Return values

string|null

getCustomerDlvPostcode()


    public
                    getCustomerDlvPostcode() : string|null

Return values

string|null

getCustomerDlvStreet()


    public
                    getCustomerDlvStreet() : string|null

Return values

string|null

getCustomerEmail()


    public
                    getCustomerEmail() : string|null

Return values

string|null

getCustomerFirstname()


    public
                    getCustomerFirstname() : string|null

Return values

string|null

getCustomerId()


    public
                    getCustomerId() : int|null

Return values

int|null

getCustomerInformations()


    public
                    getCustomerInformations() : string|null

Return values

string|null

getCustomerLastname()


    public
                    getCustomerLastname() : string|null

Return values

string|null

getCustomerPhone()


    public
                    getCustomerPhone() : string|null

Return values

string|null

getCustomerPostcode()


    public
                    getCustomerPostcode() : string|null

Return values

string|null

getCustomerRegNo()


    public
                    getCustomerRegNo() : string|null

Return values

string|null

getCustomerStreet()


    public
                    getCustomerStreet() : string|null

Return values

string|null

getCustomerVatId()


    public
                    getCustomerVatId() : string|null

Return values

string|null

getCustomerVatIdCheckId()


    public
                    getCustomerVatIdCheckId() : int|null

Return values

int|null

getCustomerVatIdOutageCheckId()


    public
                    getCustomerVatIdOutageCheckId() : int|null

Return values

int|null

getCustomerVatIdVerified()


    public
                    getCustomerVatIdVerified() : bool|null

Return values

bool|null

getCustomerVatIdVerifiedAt()


    public
                    getCustomerVatIdVerifiedAt() : DateTime|null

Return values

DateTime|null

getExpeditionCode()


    public
                    getExpeditionCode() : string|null

Return values

string|null

getExpeditionDatetime()


    public
                    getExpeditionDatetime() : DateTime|null

Return values

DateTime|null

getExpeditionInformations()


    public
                    getExpeditionInformations() : string|null

Return values

string|null

getExpeditionShipper()


    public
                    getExpeditionShipper() : TExpeditionShipper|null

Return values

TExpeditionShipper|null

getExpeditionShipperBranchId()


    public
                    getExpeditionShipperBranchId() : int|null

Return values

int|null

getGifts()


    public
                    getGifts() : Collection<int, TOrderGift>

Return values

Collection<int, TOrderGift>

getGridInvoices()


    public
                    getGridInvoices() : array<int, Invoice>

Return values

array<int, Invoice>

getIban()


    public
                    getIban() : string|null

Return values

string|null

getId()


    public
                    getId() : int|null

Return values

int|null

getInformations()


    public
                    getInformations() : string|null

Return values

string|null

getInsertDatetime()


    public
                    getInsertDatetime() : DateTime|null

Return values

DateTime|null

getInsertUserIp()


    public
                    getInsertUserIp() : string|null

Return values

string|null

getInvoicedStatus()


    public
                    getInvoicedStatus() : int|null

Return values

int|null

getIsCancelled()


    public
                    getIsCancelled() : bool

Return values

bool

getItems()


    public
                    getItems() : Collection<int, TItem>

Return values

Collection<int, TItem>

getLanguage()


    public
                    getLanguage() : TLanguage|null

Return values

TLanguage|null

getLocalization()


    public
                    getLocalization() : object|null

Return values

object|null

getLocalizationId()

Prefers the object over the scalar (a freshly set localization wins over the mirror loaded from the DB). `$localization` is an untyped `object`, hence the guard instead of a plain `?->getId()`: without it PHPStan reports `object::getId()` and a foreign object in the association would fail at runtime.


    public
                    getLocalizationId() : int|null

Return values

int|null

getOrderNumber()


    public
                    getOrderNumber() : string

Return values

string

getOwnerUserId()


    public
                    getOwnerUserId() : int|null

Return values

int|null

getPayment()


    public
                    getPayment() : TPayment|null

Return values

TPayment|null

getPaymentMethod()


    public
                    getPaymentMethod() : TOrderPaymentMethod|null

Return values

TOrderPaymentMethod|null

getPaymentRegion()


    public
                    getPaymentRegion() : TPaymentRegion|null

Return values

TPaymentRegion|null

getPayments()


    public
                    getPayments() : Collection<int, TOrderPayment>

Return values

Collection<int, TOrderPayment>

getRegion()


    public
                    getRegion() : TRegion|null

Return values

TRegion|null

getReservationExpiresAt()


    public
                    getReservationExpiresAt() : DateTime|null

Return values

DateTime|null

getRoundedTotalPrice()


    public
                    getRoundedTotalPrice() : string

Return values

string

getRoundedTotalPriceWithVat()


    public
                    getRoundedTotalPriceWithVat() : string

Return values

string

getRounding()


    public
                    getRounding() : string

Return values

string

getRoundingVat()


    public
                    getRoundingVat() : string

Return values

string

getSellerBankAccountId()


    public
                    getSellerBankAccountId() : int|null

Return values

int|null

getSellerCity()


    public
                    getSellerCity() : string|null

Return values

string|null

getSellerContactId()


    public
                    getSellerContactId() : int|null

Return values

int|null

getSellerCountry()


    public
                    getSellerCountry() : string|null

Return values

string|null

getSellerEmail()


    public
                    getSellerEmail() : string|null

Return values

string|null

getSellerId()


    public
                    getSellerId() : int|null

Return values

int|null

getSellerInformations()


    public
                    getSellerInformations() : string|null

Return values

string|null

getSellerName()


    public
                    getSellerName() : string|null

Return values

string|null

getSellerPhone()


    public
                    getSellerPhone() : string|null

Return values

string|null

getSellerPostcode()


    public
                    getSellerPostcode() : string|null

Return values

string|null

getSellerRegNo()


    public
                    getSellerRegNo() : string|null

Return values

string|null

getSellerStreet()


    public
                    getSellerStreet() : string|null

Return values

string|null

getSellerVatId()


    public
                    getSellerVatId() : string|null

Return values

string|null

getSellerVatInformations()


    public
                    getSellerVatInformations() : string|null

Return values

string|null

getShipper()


    public
                    getShipper() : TOrderShipper|null

Return values

TOrderShipper|null

getStatus()


    public
                    getStatus() : TStatus|null

Return values

TStatus|null

getStatusInformations()


    public
                    getStatusInformations() : string|null

Return values

string|null

getStockDocumentId()


    public
                    getStockDocumentId() : int|null

Return values

int|null

getStockState()


    public
                    getStockState() : string

Return values

string

getSummaryReportCode()


    public
                    getSummaryReportCode() : string|null

Return values

string|null

getSwift()


    public
                    getSwift() : string|null

Return values

string|null

getTaxCountryCode()


    public
                    getTaxCountryCode() : string|null

Return values

string|null

getTaxDate()


    public
                    getTaxDate() : DateTime|null

Return values

DateTime|null

getTaxFlags()


    public
                    getTaxFlags() : array<int, string>|null

Return values

array<int, string>|null

getTaxNote()


    public
                    getTaxNote() : string|null

Return values

string|null

getTaxTreatment()


    public
                    getTaxTreatment() : string|null

Return values

string|null

getTotalPrice()


    public
                    getTotalPrice() : string

Return values

string

getTotalPriceWithVat()


    public
                    getTotalPriceWithVat() : string

Return values

string

getUpdateDatetime()


    public
                    getUpdateDatetime() : DateTime|null

Return values

DateTime|null

getUpdateUserId()


    public
                    getUpdateUserId() : int|null

Return values

int|null

getUpdateUserIp()


    public
                    getUpdateUserIp() : string|null

Return values

string|null

getUseDeliveryAddress()


    public
                    getUseDeliveryAddress() : bool

Return values

bool

getUser()


    public
                    getUser() : TUser|null

Return values

TUser|null

getUserDiscountPercents()


    public
                    getUserDiscountPercents() : string

Return values

string

getUserDiscountPercentsAsFloat()


    public
                    getUserDiscountPercentsAsFloat() : float

Return values

float

getUserIsUpdated()


    public
                    getUserIsUpdated() : bool

Return values

bool

getUserType()


    public
                    getUserType() : TUserType|null

Return values

TUserType|null

getVariableSymbol()


    public
                    getVariableSymbol() : string|null

Return values

string|null

getVouchers()


    public
                    getVouchers() : Collection<int, TOrderVoucher>

Return values

Collection<int, TOrderVoucher>

getWithVat()


    public
                    getWithVat() : bool

Return values

bool

hasTaxFlag()


    public
                    hasTaxFlag(string $flag) : bool

Parameters

$flag : string

Return values

bool

isCancelled()


    public
                    isCancelled() : bool

Return values

bool

isPersisted()


    public
                    isPersisted() : bool

Return values

bool

setBankAccount()


    public
                    setBankAccount(string|null $bankAccount) : $this

Parameters

$bankAccount : string|null

Return values

$this

setBankName()


    public
                    setBankName(string|null $bankName) : $this

Parameters

$bankName : string|null

Return values

$this

setBuyerType()


    public
                    setBuyerType(int $buyerType) : $this

Parameters

$buyerType : int

Return values

$this

setCurrency()


    public
                    setCurrency(TCurrency|null $currency) : $this

Parameters

$currency : TCurrency|null

Return values

$this

setCustomerCity()


    public
                    setCustomerCity(string|null $customerCity) : $this

Parameters

$customerCity : string|null

Return values

$this

setCustomerCompanyName()


    public
                    setCustomerCompanyName(string|null $customerCompanyName) : $this

Parameters

$customerCompanyName : string|null

Return values

$this

setCustomerContactId()


    public
                    setCustomerContactId(int|null $customerContactId) : $this

Parameters

$customerContactId : int|null

Return values

$this

setCustomerCountry()


    public
                    setCustomerCountry(string|null $customerCountry) : $this

Parameters

$customerCountry : string|null

Return values

$this

setCustomerCountryCode()


    public
                    setCustomerCountryCode(string|null $customerCountryCode) : $this

Parameters

$customerCountryCode : string|null

Return values

$this

setCustomerDlvCity()


    public
                    setCustomerDlvCity(string|null $customerDlvCity) : $this

Parameters

$customerDlvCity : string|null

Return values

$this

setCustomerDlvCountry()


    public
                    setCustomerDlvCountry(string|null $customerDlvCountry) : $this

Parameters

$customerDlvCountry : string|null

Return values

$this

setCustomerDlvCountryCode()


    public
                    setCustomerDlvCountryCode(string|null $customerDlvCountryCode) : $this

Parameters

$customerDlvCountryCode : string|null

Return values

$this

setCustomerDlvInformations()


    public
                    setCustomerDlvInformations(string|null $customerDlvInformations) : $this

Parameters

$customerDlvInformations : string|null

Return values

$this

setCustomerDlvName()


    public
                    setCustomerDlvName(string|null $customerDlvName) : $this

Parameters

$customerDlvName : string|null

Return values

$this

setCustomerDlvPostcode()


    public
                    setCustomerDlvPostcode(string|null $customerDlvPostcode) : $this

Parameters

$customerDlvPostcode : string|null

Return values

$this

setCustomerDlvStreet()


    public
                    setCustomerDlvStreet(string|null $customerDlvStreet) : $this

Parameters

$customerDlvStreet : string|null

Return values

$this

setCustomerEmail()


    public
                    setCustomerEmail(string|null $customerEmail) : $this

Parameters

$customerEmail : string|null

Return values

$this

setCustomerFirstname()


    public
                    setCustomerFirstname(string|null $customerFirstname) : $this

Parameters

$customerFirstname : string|null

Return values

$this

setCustomerId()


    public
                    setCustomerId(int|null $customerId) : $this

Parameters

$customerId : int|null

Return values

$this

setCustomerInformations()


    public
                    setCustomerInformations(string|null $customerInformations) : $this

Parameters

$customerInformations : string|null

Return values

$this

setCustomerLastname()


    public
                    setCustomerLastname(string|null $customerLastname) : $this

Parameters

$customerLastname : string|null

Return values

$this

setCustomerPhone()


    public
                    setCustomerPhone(string|null $customerPhone) : $this

Parameters

$customerPhone : string|null

Return values

$this

setCustomerPostcode()


    public
                    setCustomerPostcode(string|null $customerPostcode) : $this

Parameters

$customerPostcode : string|null

Return values

$this

setCustomerRegNo()


    public
                    setCustomerRegNo(string|null $customerRegNo) : $this

Parameters

$customerRegNo : string|null

Return values

$this

setCustomerStreet()


    public
                    setCustomerStreet(string|null $customerStreet) : $this

Parameters

$customerStreet : string|null

Return values

$this

setCustomerVatId()


    public
                    setCustomerVatId(string|null $customerVatId) : $this

Parameters

$customerVatId : string|null

Return values

$this

setCustomerVatIdCheckId()


    public
                    setCustomerVatIdCheckId(int|null $customerVatIdCheckId) : static

Parameters

$customerVatIdCheckId : int|null

Return values

static

setCustomerVatIdOutageCheckId()


    public
                    setCustomerVatIdOutageCheckId(int|null $customerVatIdOutageCheckId) : static

Parameters

$customerVatIdOutageCheckId : int|null

Return values

static

setCustomerVatIdVerified()


    public
                    setCustomerVatIdVerified(bool|null $customerVatIdVerified) : static

Parameters

$customerVatIdVerified : bool|null

Return values

static

setCustomerVatIdVerifiedAt()


    public
                    setCustomerVatIdVerifiedAt(DateTime|null $customerVatIdVerifiedAt) : static

Parameters

$customerVatIdVerifiedAt : DateTime|null

Return values

static

setExpeditionCode()


    public
                    setExpeditionCode(string|null $expeditionCode) : $this

Parameters

$expeditionCode : string|null

Return values

$this

setExpeditionDatetime()


    public
                    setExpeditionDatetime(DateTime|null $expeditionDatetime) : $this

Parameters

$expeditionDatetime : DateTime|null

Return values

$this

setExpeditionInformations()


    public
                    setExpeditionInformations(string|null $expeditionInformations) : $this

Parameters

$expeditionInformations : string|null

Return values

$this

setExpeditionShipper()


    public
                    setExpeditionShipper(TExpeditionShipper|null $expeditionShipper) : $this

Parameters

$expeditionShipper : TExpeditionShipper|null

Return values

$this

setExpeditionShipperBranchId()


    public
                    setExpeditionShipperBranchId(int|null $expeditionShipperBranchId) : $this

Parameters

$expeditionShipperBranchId : int|null

Return values

$this

setGifts()


    public
                    setGifts(Collection<int, TOrderGift>|array<int, TOrderGift> $gifts) : $this

Parameters

$gifts : Collection<int, TOrderGift>|array<int, TOrderGift>

Return values

$this

setGridInvoices()


    public
                    setGridInvoices(array<int, Invoice> $gridInvoices) : self

Parameters

$gridInvoices : array<int, Invoice>

Return values

self

setIban()


    public
                    setIban(string|null $iban) : $this

Parameters

$iban : string|null

Return values

$this

setId()


    public
                    setId(int|null $id) : $this

Parameters

$id : int|null

Return values

$this

setInformations()


    public
                    setInformations(string|null $informations) : $this

Parameters

$informations : string|null

Return values

$this

setInsertDatetime()


    public
                    setInsertDatetime(DateTime|null $insertDatetime) : $this

Parameters

$insertDatetime : DateTime|null

Return values

$this

setInsertUserIp()


    public
                    setInsertUserIp(string|null $insertUserIp) : $this

Parameters

$insertUserIp : string|null

Return values

$this

setInvoicedStatus()


    public
                    setInvoicedStatus(int|null $invoicedStatus) : $this

Parameters

$invoicedStatus : int|null

Return values

$this

setIsCancelled()


    public
                    setIsCancelled(bool $isCancelled) : $this

Parameters

$isCancelled : bool

Return values

$this

setItems()


    public
                    setItems(Collection<int, TItem>|array<int, TItem> $items) : $this

Parameters

$items : Collection<int, TItem>|array<int, TItem>

Return values

$this

setLanguage()


    public
                    setLanguage(TLanguage|null $language) : $this

Parameters

$language : TLanguage|null

Return values

$this

setLocalization()

IMPORTANT: deliberately without the side effect `$this->localizationId = $localization?->getId()`.


    public
                    setLocalization(object|null $localization) : $this

During two-phase hydration the setter runs before the shell receives its id and would overwrite the correctly loaded read-only scalar with null.

Parameters

$localization : object|null

Return values

$this

setOrderNumber()


    public
                    setOrderNumber(string $orderNumber) : $this

Parameters

$orderNumber : string

Return values

$this

setPayment()


    public
                    setPayment(TPayment|null $payment) : $this

Parameters

$payment : TPayment|null

Return values

$this

setPaymentMethod()


    public
                    setPaymentMethod(TOrderPaymentMethod|null $paymentMethod) : $this

Parameters

$paymentMethod : TOrderPaymentMethod|null

Return values

$this

setPaymentRegion()


    public
                    setPaymentRegion(TPaymentRegion|null $paymentRegion) : $this

Parameters

$paymentRegion : TPaymentRegion|null

Return values

$this

setPayments()


    public
                    setPayments(Collection<int, TOrderPayment>|array<int, TOrderPayment> $payments) : $this

Parameters

$payments : Collection<int, TOrderPayment>|array<int, TOrderPayment>

Return values

$this

setRegion()


    public
                    setRegion(TRegion|null $region) : $this

Parameters

$region : TRegion|null

Return values

$this

setReservationExpiresAt()


    public
                    setReservationExpiresAt(DateTime|null $reservationExpiresAt) : $this

Parameters

$reservationExpiresAt : DateTime|null

Return values

$this

setRoundedTotalPrice()


    public
                    setRoundedTotalPrice(string $roundedTotalPrice) : $this

Parameters

$roundedTotalPrice : string

Return values

$this

setRoundedTotalPriceWithVat()


    public
                    setRoundedTotalPriceWithVat(string $roundedTotalPriceWithVat) : $this

Parameters

$roundedTotalPriceWithVat : string

Return values

$this

setRounding()


    public
                    setRounding(string $rounding) : $this

Parameters

$rounding : string

Return values

$this

setRoundingVat()


    public
                    setRoundingVat(string $roundingVat) : $this

Parameters

$roundingVat : string

Return values

$this

setSellerBankAccountId()


    public
                    setSellerBankAccountId(int|null $sellerBankAccountId) : $this

Parameters

$sellerBankAccountId : int|null

Return values

$this

setSellerCity()


    public
                    setSellerCity(string|null $sellerCity) : $this

Parameters

$sellerCity : string|null

Return values

$this

setSellerContactId()


    public
                    setSellerContactId(int|null $sellerContactId) : $this

Parameters

$sellerContactId : int|null

Return values

$this

setSellerCountry()


    public
                    setSellerCountry(string|null $sellerCountry) : $this

Parameters

$sellerCountry : string|null

Return values

$this

setSellerEmail()


    public
                    setSellerEmail(string|null $sellerEmail) : $this

Parameters

$sellerEmail : string|null

Return values

$this

setSellerId()


    public
                    setSellerId(int|null $sellerId) : $this

Parameters

$sellerId : int|null

Return values

$this

setSellerInformations()


    public
                    setSellerInformations(string|null $sellerInformations) : $this

Parameters

$sellerInformations : string|null

Return values

$this

setSellerName()


    public
                    setSellerName(string|null $sellerName) : $this

Parameters

$sellerName : string|null

Return values

$this

setSellerPhone()


    public
                    setSellerPhone(string|null $sellerPhone) : $this

Parameters

$sellerPhone : string|null

Return values

$this

setSellerPostcode()


    public
                    setSellerPostcode(string|null $sellerPostcode) : $this

Parameters

$sellerPostcode : string|null

Return values

$this

setSellerRegNo()


    public
                    setSellerRegNo(string|null $sellerRegNo) : $this

Parameters

$sellerRegNo : string|null

Return values

$this

setSellerStreet()


    public
                    setSellerStreet(string|null $sellerStreet) : $this

Parameters

$sellerStreet : string|null

Return values

$this

setSellerVatId()


    public
                    setSellerVatId(string|null $sellerVatId) : $this

Parameters

$sellerVatId : string|null

Return values

$this

setSellerVatInformations()


    public
                    setSellerVatInformations(string|null $sellerVatInformations) : $this

Parameters

$sellerVatInformations : string|null

Return values

$this

setShipper()


    public
                    setShipper(TOrderShipper|null $shipper) : $this

Parameters

$shipper : TOrderShipper|null

Return values

$this

setStatus()


    public
                    setStatus(TStatus|null $status) : $this

Parameters

$status : TStatus|null

Return values

$this

setStatusInformations()


    public
                    setStatusInformations(string|null $statusInformations) : $this

Parameters

$statusInformations : string|null

Return values

$this

setStockDocumentId()


    public
                    setStockDocumentId(int|null $stockDocumentId) : $this

Parameters

$stockDocumentId : int|null

Return values

$this

setStockState()


    public
                    setStockState(string $stockState) : $this

Parameters

$stockState : string

Return values

$this

setSummaryReportCode()


    public
                    setSummaryReportCode(string|null $summaryReportCode) : static

Parameters

$summaryReportCode : string|null

Return values

static

setSwift()


    public
                    setSwift(string|null $swift) : $this

Parameters

$swift : string|null

Return values

$this

setTaxCountryCode()


    public
                    setTaxCountryCode(string|null $taxCountryCode) : static

Parameters

$taxCountryCode : string|null

Return values

static

setTaxDate()


    public
                    setTaxDate(DateTime|null $taxDate) : static

Parameters

$taxDate : DateTime|null

Return values

static

setTaxFlags()


    public
                    setTaxFlags(array<int, string>|null $taxFlags) : static

Parameters

$taxFlags : array<int, string>|null

Return values

static

setTaxNote()


    public
                    setTaxNote(string|null $taxNote) : static

Parameters

$taxNote : string|null

Return values

static

setTaxTreatment()


    public
                    setTaxTreatment(string|null $taxTreatment) : static

Parameters

$taxTreatment : string|null

Return values

static

setTotalPrice()


    public
                    setTotalPrice(string $totalPrice) : $this

Parameters

$totalPrice : string

Return values

$this

setTotalPriceWithVat()


    public
                    setTotalPriceWithVat(string $totalPriceWithVat) : $this

Parameters

$totalPriceWithVat : string

Return values

$this

setUpdateDatetime()


    public
                    setUpdateDatetime(DateTime|null $updateDatetime) : $this

Parameters

$updateDatetime : DateTime|null

Return values

$this

setUpdateUserId()


    public
                    setUpdateUserId(int|null $updateUserId) : $this

Parameters

$updateUserId : int|null

Return values

$this

setUpdateUserIp()


    public
                    setUpdateUserIp(string|null $updateUserIp) : $this

Parameters

$updateUserIp : string|null

Return values

$this

setUseDeliveryAddress()


    public
                    setUseDeliveryAddress(bool $useDeliveryAddress) : $this

Parameters

$useDeliveryAddress : bool

Return values

$this

setUser()


    public
                    setUser(TUser|null $user) : $this

Parameters

$user : TUser|null

Return values

$this

setUserDiscountPercents()


    public
                    setUserDiscountPercents(string $userDiscountPercents) : $this

Parameters

$userDiscountPercents : string

Return values

$this

setUserIsUpdated()


    public
                    setUserIsUpdated(bool $userIsUpdated) : $this

Parameters

$userIsUpdated : bool

Return values

$this

setUserType()


    public
                    setUserType(TUserType|null $userType) : $this

Parameters

$userType : TUserType|null

Return values

$this

setVariableSymbol()


    public
                    setVariableSymbol(string|null $variableSymbol) : $this

Parameters

$variableSymbol : string|null

Return values

$this

setVouchers()


    public
                    setVouchers(Collection<int, TOrderVoucher>|array<int, TOrderVoucher> $vouchers) : $this

Parameters

$vouchers : Collection<int, TOrderVoucher>|array<int, TOrderVoucher>

Return values

$this

setWithVat()


    public
                    setWithVat(bool $withVat) : $this

Parameters

$withVat : bool

Return values

$this

getTraitsRecursive()

Walks the trait list recursively and collects nested traits too.


    private
            static        getTraitsRecursive(array<string, string> $traits) : array<string, string>

Parameters

$traits : array<string, string>

Return values

array<string, string>

Order extends Order in package Application

Tags

Attributes

Table of Contents

Properties

Methods

Properties

$bankAccount

Attributes

$bankName

Attributes

$buyerType

Attributes

$currency

Attributes

$customerCity

Attributes

$customerCompanyName

Attributes

$customerContactId

Attributes

$customerCountry

Attributes

$customerCountryCode

Attributes

$customerDlvCity

Attributes

$customerDlvCountry

Attributes

$customerDlvCountryCode

Attributes

$customerDlvInformations

Attributes

$customerDlvName

Attributes

$customerDlvPostcode

Attributes

$customerDlvStreet

Attributes

$customerEmail

Attributes

$customerFirstname

Attributes

$customerId

Attributes

$customerInformations

Attributes

$customerLastname

Attributes

$customerPhone

Attributes

$customerPostcode

Attributes

$customerRegNo

Attributes

$customerStreet

Attributes

$customerVatId

Attributes

$customerVatIdCheckId

Attributes

$customerVatIdOutageCheckId

Attributes

$customerVatIdVerified

Attributes

$customerVatIdVerifiedAt

Attributes

$expeditionCode

Attributes

$expeditionDatetime

Attributes

$expeditionInformations

Attributes

$expeditionShipper

Attributes

$expeditionShipperBranchId

Attributes

$gifts

Attributes

$gridInvoices

Order extends Order
in package

Application