PHP Interface Sonata\Component\Order\OrderInterface

显示文件 Open project: sonata-project/ecommerce Interface Usage Examples

Public Methods

Method	Description
addOrderElement ( Sonata\Component\Order\OrderElementInterface $orderElement )
addOrderElements ( Sonata\Component\Order\OrderElementInterface $orderElements )	Add order elements.
getBillingAddress1 ( ) : string	Get billing address1.
getBillingAddress2 ( ) : string	Get billing address2.
getBillingAddress3 ( ) : string	Get billing address3.
getBillingCity ( ) : string	Get billing city.
getBillingCountryCode ( ) : string	Get billing country.
getBillingEmail ( ) : string	Get billing email.
getBillingFax ( ) : string	Get billing fax.
getBillingMobile ( ) : string	Get billing mobile.
getBillingName ( ) : string	Get billing name.
getBillingPhone ( ) : string	Get billing phone.
getBillingPostcode ( ) : string	Get billing postcode.
getCreatedAt ( ) : DateTime
getCurrency ( ) : Sonata\Component\Currency\CurrencyInterface	Get currency.
getCustomer ( ) : Sonata\Component\Customer\CustomerInterface
getDeliveryCost ( ) : float	Get delivery cost.
getDeliveryMethod ( ) : string	Get delivery method.
getDeliveryStatus ( ) : integer	Get delivery status.
getDeliveryVat ( ) : float	Get delivery VAT.
getId ( ) : integer
getLocale ( ) : string
getOrderElements ( ) : array
getPaymentMethod ( ) : string	Get payment method.
getPaymentStatus ( ) : integer	Get payment status.
getReference ( ) : string	Get reference.
getShippingAddress1 ( ) : string	Get shipping address1.
getShippingAddress2 ( ) : string	Get shipping address2.
getShippingAddress3 ( ) : string	Get shipping address3.
getShippingCity ( ) : string	Get shipping city.
getShippingCountryCode ( ) : string	Get shipping country.
getShippingEmail ( ) : string	Get shipping email.
getShippingFax ( ) : string	Get shipping fax.
getShippingMobile ( ) : string	Get shipping mobile.
getShippingName ( ) : string	Get shipping name.
getShippingPhone ( ) : string	Get shipping phone.
getShippingPostcode ( ) : string	Get shipping postcode.
getStatus ( ) : integer	Get status.
getTotalExcl ( ) : float	Get totalExcl.
getTotalInc ( ) : float	Get totalInc.
getUpdatedAt ( ) : DateTime
getUsername ( ) : string	Get username.
getValidatedAt ( ) : Datetime	Get validated at.
getVat ( ) : float
isCancellable ( ) : boolean
isCancelled ( ) : boolean
isError ( ) : boolean	Return true if the order has an error.
isOpen ( ) : boolean	Return true if the order is open.
isPending ( ) : boolean
isValidated ( ) : boolean	return true if the order is validated.
setBillingAddress1 ( string $billingAddress1 )	Set billing address1.
setBillingAddress2 ( string $billingAddress2 )	Set billing address2.
setBillingAddress3 ( string $billingAddress3 )	Set billing address3.
setBillingCity ( string $billingCity )	Set billing city.
setBillingCountryCode ( string $billingCountryCode )	Set billing country code.
setBillingEmail ( string $billingEmail )	Set billing email.
setBillingFax ( string $billingFax )	Set billing fax.
setBillingMobile ( string $billingMobile )	Set billing mobile.
setBillingName ( string $billingName )	Set billing name.
setBillingPhone ( string $billingPhone )	Set billing phone.
setBillingPostcode ( string $billingPostcode )	Set billing postcode.
setCreatedAt ( DateTime $createdAt = null )
setCurrency ( Sonata\Component\Currency\CurrencyInterface $currency )	Set currency.
setCustomer ( Sonata\Component\Customer\CustomerInterface $customer )
setDeliveryCost ( float $deliveryCost )	Set delivery cost (VAT included).
setDeliveryMethod ( string $deliveryMethod )	Set delivery method.
setDeliveryStatus ( integer $deliveryStatus )	Set delivery status.
setDeliveryVat ( float $deliveryVat )	Set delivery VAT.
setLocale ( string $locale )
setOrderElements ( array $orderElements ) : array
setPaymentMethod ( string $paymentMethod )	Set payment method.
setPaymentStatus ( integer $paymentStatus )	Set payment status.
setReference ( string $reference )	Set reference.
setShippingAddress1 ( string $shippingAddress1 )	Set shipping address1.
setShippingAddress2 ( string $shippingAddress2 )	Set shipping address2.
setShippingAddress3 ( string $shippingAddress3 )	Set shipping address3.
setShippingCity ( string $shippingCity )	Set shipping city.
setShippingCountryCode ( string $shippingCountryCode )	Set shipping country.
setShippingEmail ( string $shippingEmail )	Set shipping email.
setShippingFax ( string $shippingFax )	Set shipping fax.
setShippingMobile ( string $shippingMobile )	Set shipping mobile.
setShippingName ( string $shippingName )	Set shipping name.
setShippingPhone ( string $shippingPhone )	Set shipping phone.
setShippingPostcode ( string $shippingPostcode )	Set shipping postcode.
setStatus ( integer $status )	Set status.
setTotalExcl ( float $totalExcl )	Set totalExcl.
setTotalInc ( float $totalInc )	Set totalInc.
setUpdatedAt ( DateTime $updatedAt = null )
setUsername ( string $username )	Set username.
setValidatedAt ( DateTime $validatedAt = null )	Set validated at.

Method Details

addOrderElement() public method

public addOrderElement ( Sonata\Component\Order\OrderElementInterface $orderElement )
$orderElement	Sonata\Component\Order\OrderElementInterface

addOrderElements() public method

Add order elements.

public addOrderElements ( Sonata\Component\Order\OrderElementInterface $orderElements )
$orderElements	Sonata\Component\Order\OrderElementInterface

getBillingAddress1() public method

Get billing address1.

public getBillingAddress1 ( ) : string
return	string	$billingAddress1

getBillingAddress2() public method

Get billing address2.

public getBillingAddress2 ( ) : string
return	string	$billingAddress2

getBillingAddress3() public method

Get billing address3.

public getBillingAddress3 ( ) : string
return	string	$billingAddress3

getBillingCity() public method

Get billing city.

public getBillingCity ( ) : string
return	string	$billingCity

getBillingCountryCode() public method

Get billing country.

public getBillingCountryCode ( ) : string
return	string	$billingCountryCode

getBillingEmail() public method

Get billing email.

public getBillingEmail ( ) : string
return	string	$billingEmail

getBillingFax() public method

Get billing fax.

public getBillingFax ( ) : string
return	string	$billingFax

getBillingMobile() public method

Get billing mobile.

public getBillingMobile ( ) : string
return	string	$billingMobile

getBillingName() public method

Get billing name.

public getBillingName ( ) : string
return	string	$billingName

getBillingPhone() public method

Get billing phone.

public getBillingPhone ( ) : string
return	string	$billingPhone

getBillingPostcode() public method

Get billing postcode.

public getBillingPostcode ( ) : string
return	string	$billingPostcode

getCreatedAt() public method

public getCreatedAt ( ) : DateTime
return	DateTime

getCurrency() public method

Get currency.

public getCurrency ( ) : Sonata\Component\Currency\CurrencyInterface
return	Sonata\Component\Currency\CurrencyInterface	$currency

getCustomer() public method

public getCustomer ( ) : Sonata\Component\Customer\CustomerInterface
return	Sonata\Component\Customer\CustomerInterface

getDeliveryCost() public method

Get delivery cost.

public getDeliveryCost ( ) : float
return	float	$deliveryCost

getDeliveryMethod() public method

Get delivery method.

public getDeliveryMethod ( ) : string
return	string	$deliveryMethod

getDeliveryStatus() public method

Get delivery status.

public getDeliveryStatus ( ) : integer
return	integer	$deliveryStatus

getDeliveryVat() public method

Get delivery VAT.

public getDeliveryVat ( ) : float
return	float	$deliveryVat

getId() public method

public getId ( ) : integer
return	integer	the order id

getLocale() public method

public getLocale ( ) : string
return	string

getOrderElements() public method

public getOrderElements ( ) : array
return	array

getPaymentMethod() public method

Get payment method.

public getPaymentMethod ( ) : string
return	string

getPaymentStatus() public method

Get payment status.

public getPaymentStatus ( ) : integer
return	integer	$paymentStatus

getReference() public method

Get reference.

public getReference ( ) : string
return	string	$reference

getShippingAddress1() public method

Get shipping address1.

public getShippingAddress1 ( ) : string
return	string	$shippingAddress1

getShippingAddress2() public method

Get shipping address2.

public getShippingAddress2 ( ) : string
return	string	$shippingAddress2

getShippingAddress3() public method

Get shipping address3.

public getShippingAddress3 ( ) : string
return	string	$shippingAddress3

getShippingCity() public method

Get shipping city.

public getShippingCity ( ) : string
return	string	$shippingCity

getShippingCountryCode() public method

Get shipping country.

public getShippingCountryCode ( ) : string
return	string	$shippingCountry

getShippingEmail() public method

Get shipping email.

public getShippingEmail ( ) : string
return	string	$shippingEmail

getShippingFax() public method

Get shipping fax.

public getShippingFax ( ) : string
return	string	$shippingFax

getShippingMobile() public method

Get shipping mobile.

public getShippingMobile ( ) : string
return	string	$shippingMobile

getShippingName() public method

Get shipping name.

public getShippingName ( ) : string
return	string	$shippingName

getShippingPhone() public method

Get shipping phone.

public getShippingPhone ( ) : string
return	string	$shippingPhone

getShippingPostcode() public method

Get shipping postcode.

public getShippingPostcode ( ) : string
return	string	$shippingPostcode

getStatus() public method

Get status.

public getStatus ( ) : integer
return	integer	$status

getTotalExcl() public method

Get totalExcl.

public getTotalExcl ( ) : float
return	float	$totalExcl

getTotalInc() public method

Get totalInc.

public getTotalInc ( ) : float
return	float	$totalInc

getUpdatedAt() public method

public getUpdatedAt ( ) : DateTime
return	DateTime

getUsername() public method

Get username.

public getUsername ( ) : string
return	string	$username

getValidatedAt() public method

Get validated at.

public getValidatedAt ( ) : Datetime
return	Datetime	$validatedAt

getVat() public method

public getVat ( ) : float
return	float

isCancellable() public method

public isCancellable ( ) : boolean
return	boolean	true if the order can be cancelled

isCancelled() public method

public isCancelled ( ) : boolean
return	boolean	true if cancelled, else false

isError() public method

Return true if the order has an error.

public isError ( ) : boolean
return	boolean

isOpen() public method

Return true if the order is open.

public isOpen ( ) : boolean
return	boolean

isPending() public method

public isPending ( ) : boolean
return	boolean	true if pending, else false

isValidated() public method

return true if the order is validated.

public isValidated ( ) : boolean
return	boolean

setBillingAddress1() public method

Set billing address1.

public setBillingAddress1 ( string $billingAddress1 )
$billingAddress1	string

setBillingAddress2() public method

Set billing address2.

public setBillingAddress2 ( string $billingAddress2 )
$billingAddress2	string

setBillingAddress3() public method

Set billing address3.

public setBillingAddress3 ( string $billingAddress3 )
$billingAddress3	string

setBillingCity() public method

Set billing city.

public setBillingCity ( string $billingCity )
$billingCity	string

setBillingCountryCode() public method

Set billing country code.

public setBillingCountryCode ( string $billingCountryCode )
$billingCountryCode	string

setBillingEmail() public method

Set billing email.

public setBillingEmail ( string $billingEmail )
$billingEmail	string

setBillingFax() public method

Set billing fax.

public setBillingFax ( string $billingFax )
$billingFax	string

setBillingMobile() public method

Set billing mobile.

public setBillingMobile ( string $billingMobile )
$billingMobile	string

setBillingName() public method

Set billing name.

public setBillingName ( string $billingName )
$billingName	string

setBillingPhone() public method

Set billing phone.

public setBillingPhone ( string $billingPhone )
$billingPhone	string

setBillingPostcode() public method

Set billing postcode.

public setBillingPostcode ( string $billingPostcode )
$billingPostcode	string

setCreatedAt() public method

public setCreatedAt ( DateTime $createdAt = null )
$createdAt	DateTime

setCurrency() public method

Set currency.

public setCurrency ( Sonata\Component\Currency\CurrencyInterface $currency )
$currency	Sonata\Component\Currency\CurrencyInterface

setCustomer() public method

public setCustomer ( Sonata\Component\Customer\CustomerInterface $customer )
$customer	Sonata\Component\Customer\CustomerInterface

setDeliveryCost() public method

Set delivery cost (VAT included).

public setDeliveryCost ( float $deliveryCost )
$deliveryCost	float

setDeliveryMethod() public method

Set delivery method.

public setDeliveryMethod ( string $deliveryMethod )
$deliveryMethod	string

setDeliveryStatus() public method

Set delivery status.

public setDeliveryStatus ( integer $deliveryStatus )
$deliveryStatus	integer

setDeliveryVat() public method

Set delivery VAT.

public setDeliveryVat ( float $deliveryVat )
$deliveryVat	float

setLocale() public method

public setLocale ( string $locale )
$locale	string

setOrderElements() public method

public setOrderElements ( array $orderElements ) : array
$orderElements	array
return	array

setPaymentMethod() public method

Set payment method.

public setPaymentMethod ( string $paymentMethod )
$paymentMethod	string

setPaymentStatus() public method

Set payment status.

public setPaymentStatus ( integer $paymentStatus )
$paymentStatus	integer

setReference() public method

Set reference.

public setReference ( string $reference )
$reference	string

setShippingAddress1() public method

Set shipping address1.

public setShippingAddress1 ( string $shippingAddress1 )
$shippingAddress1	string

setShippingAddress2() public method

Set shipping address2.

public setShippingAddress2 ( string $shippingAddress2 )
$shippingAddress2	string

setShippingAddress3() public method

Set shipping address3.

public setShippingAddress3 ( string $shippingAddress3 )
$shippingAddress3	string

setShippingCity() public method

Set shipping city.

public setShippingCity ( string $shippingCity )
$shippingCity	string

setShippingCountryCode() public method

Set shipping country.

public setShippingCountryCode ( string $shippingCountryCode )
$shippingCountryCode	string

setShippingEmail() public method

Set shipping email.

public setShippingEmail ( string $shippingEmail )
$shippingEmail	string

setShippingFax() public method

Set shipping fax.

public setShippingFax ( string $shippingFax )
$shippingFax	string

setShippingMobile() public method

Set shipping mobile.

public setShippingMobile ( string $shippingMobile )
$shippingMobile	string

setShippingName() public method

Set shipping name.

public setShippingName ( string $shippingName )
$shippingName	string

setShippingPhone() public method

Set shipping phone.

public setShippingPhone ( string $shippingPhone )
$shippingPhone	string

setShippingPostcode() public method

Set shipping postcode.

public setShippingPostcode ( string $shippingPostcode )
$shippingPostcode	string

setStatus() public method

Set status.

public setStatus ( integer $status )
$status	integer

setTotalExcl() public method

Set totalExcl.

public setTotalExcl ( float $totalExcl )
$totalExcl	float

setTotalInc() public method

Set totalInc.

public setTotalInc ( float $totalInc )
$totalInc	float

setUpdatedAt() public method

public setUpdatedAt ( DateTime $updatedAt = null )
$updatedAt	DateTime

setUsername() public method

Set username.

public setUsername ( string $username )
$username	string

setValidatedAt() public method

Set validated at.

public setValidatedAt ( DateTime $validatedAt = null )
$validatedAt	DateTime