PHP Интерфейс Sonata\Component\Basket\BasketInterface

Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
addBasketElement ( Sonata\Component\Basket\BasketElementInterface $basketElement ) Add a basket element into the current basket.
buildPrices ( ) Compute the price of the basket.
clean ( ) remove basket element market as deleted.
countBasketElements ( ) : integer count number of element in the basket.
getBasketElements ( ) : Sonata\Component\Basket\BasketElementInterface[] return BasketElements.
getBillingAddress ( ) : Sonata\Component\Customer\AddressInterface
getBillingAddressId ( ) : integer
getCurrency ( ) : Sonata\Component\Currency\CurrencyInterface
getCustomer ( )
getCustomerId ( ) : integer
getDeliveryAddress ( ) : Sonata\Component\Customer\AddressInterface
getDeliveryAddressId ( ) : integer
getDeliveryMethod ( ) : Sonata\Component\Delivery\ServiceDeliveryInterface
getDeliveryMethodCode ( ) : string
getDeliveryPrice ( boolean $vat = false ) : float return the Delivery price.
getDeliveryVat ( ) : float returns the Delivery VAT rate.
getElement ( Sonata\Component\Product\ProductInterface $product ) : Sonata\Component\Basket\BasketElementInterface return the BasketElement depends on the $product or the position from the element stacks.
getLocale ( ) : string
getPaymentMethod ( ) : Sonata\Component\Payment\PaymentInterface
getPaymentMethodCode ( ) : string
getPositions ( ) : array
getProductPool ( ) : Pool
getSerializationFields ( ) : array Retrieves fields and associated values use for serialization Used by serialize method.
getTotal ( boolean $vat = false, boolean $recurrentOnly = null ) : float return the total of the basket if $vat = true, return price with vat if $recurrent_only = true, return price for recurrent product only if $recurrent_only = false, return price for non recurrent product only.
getUnserializationFields ( ) : array Retrieves fields for deserialization Used by unserialize method.
getVatAmount ( ) : float Returns the VAT of the current basket.
getVatAmounts ( ) : array Returns an array with all VAT amounts of the current basket.
hasBasketElements ( ) : boolean return true if the basket has some elements .
hasProduct ( Sonata\Component\Product\ProductInterface $product ) : boolean check if the basket contains $product.
hasRecurrentPayment ( ) : boolean return true if the basket has a least one recurrent product (subscription).
isAddable ( Sonata\Component\Product\ProductInterface $product ) : boolean Check if the product can be added to the basket.
isEmpty ( ) : boolean test is the basket has elements.
isValid ( boolean $elementsOnly = false ) : boolean Check is the basket is valid : elements, Payment and Delivery information.
removeBasketElement ( Sonata\Component\Basket\BasketElementInterface $element ) : Sonata\Component\Basket\BasketElementInterface delete an element from the basket depend on the $element. Element can be a product or a basket element.
removeElement ( Sonata\Component\Basket\BasketElementInterface $element ) : Sonata\Component\Basket\BasketElementInterface delete an element from the basket depend on the $element. Element can be a product or a basket element.
removeElements ( array $elementsToRemove ) deletes several elements from the basket.
reset ( boolean $full = true ) reset basket.
setBasketElements ( array $elements ) Warning : this method should be only used by the validation framework.
setBillingAddress ( Sonata\Component\Customer\AddressInterface $address = null ) set the Payment address.
setBillingAddressId ( integer $billingAddressId )
setCurrency ( Sonata\Component\Currency\CurrencyInterface $currency )
setCustomer ( Sonata\Component\Customer\CustomerInterface $customer = null )
setCustomerId ( integer $customerId )
setDeliveryAddress ( Sonata\Component\Customer\AddressInterface $address = null ) set the Delivery address.
setDeliveryAddressId ( integer $deliveryAddressId )
setDeliveryMethod ( Sonata\Component\Delivery\ServiceDeliveryInterface $method = null ) set the Delivery method.
setLocale ( string $locale )
setPaymentMethod ( Sonata\Component\Payment\PaymentInterface $method = null ) set Payment method.
setPaymentMethodCode ( string $paymentMethodCode )
setProductPool ( Pool $pool )

Описание методов

addBasketElement() публичный Метод

Add a basket element into the current basket.
public addBasketElement ( Sonata\Component\Basket\BasketElementInterface $basketElement )
$basketElement Sonata\Component\Basket\BasketElementInterface

buildPrices() публичный Метод

Compute the price of the basket.
public buildPrices ( )

clean() публичный Метод

remove basket element market as deleted.
public clean ( )

countBasketElements() публичный Метод

count number of element in the basket.
public countBasketElements ( ) : integer
Результат integer

getBasketElements() публичный Метод

return BasketElements.
public getBasketElements ( ) : Sonata\Component\Basket\BasketElementInterface[]
Результат Sonata\Component\Basket\BasketElementInterface[]

getBillingAddress() публичный Метод

public getBillingAddress ( ) : Sonata\Component\Customer\AddressInterface
Результат Sonata\Component\Customer\AddressInterface

getBillingAddressId() публичный Метод

public getBillingAddressId ( ) : integer
Результат integer

getCurrency() публичный Метод

public getCurrency ( ) : Sonata\Component\Currency\CurrencyInterface
Результат Sonata\Component\Currency\CurrencyInterface

getCustomer() публичный Метод

public getCustomer ( )

getCustomerId() публичный Метод

public getCustomerId ( ) : integer
Результат integer

getDeliveryAddress() публичный Метод

public getDeliveryAddress ( ) : Sonata\Component\Customer\AddressInterface
Результат Sonata\Component\Customer\AddressInterface

getDeliveryAddressId() публичный Метод

public getDeliveryAddressId ( ) : integer
Результат integer

getDeliveryMethod() публичный Метод

public getDeliveryMethod ( ) : Sonata\Component\Delivery\ServiceDeliveryInterface
Результат Sonata\Component\Delivery\ServiceDeliveryInterface

getDeliveryMethodCode() публичный Метод

public getDeliveryMethodCode ( ) : string
Результат string

getDeliveryPrice() публичный Метод

return the Delivery price.
public getDeliveryPrice ( boolean $vat = false ) : float
$vat boolean
Результат float

getDeliveryVat() публичный Метод

returns the Delivery VAT rate.
public getDeliveryVat ( ) : float
Результат float

getElement() публичный Метод

return the BasketElement depends on the $product or the position from the element stacks.
public getElement ( Sonata\Component\Product\ProductInterface $product ) : Sonata\Component\Basket\BasketElementInterface
$product Sonata\Component\Product\ProductInterface
Результат Sonata\Component\Basket\BasketElementInterface

getLocale() публичный Метод

public getLocale ( ) : string
Результат string

getPaymentMethod() публичный Метод

public getPaymentMethod ( ) : Sonata\Component\Payment\PaymentInterface
Результат Sonata\Component\Payment\PaymentInterface

getPaymentMethodCode() публичный Метод

public getPaymentMethodCode ( ) : string
Результат string

getPositions() публичный Метод

public getPositions ( ) : array
Результат array

getProductPool() публичный Метод

public getProductPool ( ) : Pool
Результат Sonata\Component\Product\Pool

getSerializationFields() публичный Метод

Retrieves fields and associated values use for serialization Used by serialize method.
public getSerializationFields ( ) : array
Результат array

getTotal() публичный Метод

return the total of the basket if $vat = true, return price with vat if $recurrent_only = true, return price for recurrent product only if $recurrent_only = false, return price for non recurrent product only.
public getTotal ( boolean $vat = false, boolean $recurrentOnly = null ) : float
$vat boolean Returns price including VAT?
$recurrentOnly boolean Is recurrent only?
Результат float

getUnserializationFields() публичный Метод

Retrieves fields for deserialization Used by unserialize method.
public getUnserializationFields ( ) : array
Результат array

getVatAmount() публичный Метод

Returns the VAT of the current basket.
public getVatAmount ( ) : float
Результат float

getVatAmounts() публичный Метод

Returns an array with all VAT amounts of the current basket.
public getVatAmounts ( ) : array
Результат array

hasBasketElements() публичный Метод

..
public hasBasketElements ( ) : boolean
Результат boolean

hasProduct() публичный Метод

check if the basket contains $product.
public hasProduct ( Sonata\Component\Product\ProductInterface $product ) : boolean
$product Sonata\Component\Product\ProductInterface
Результат boolean

hasRecurrentPayment() публичный Метод

@return bool
public hasRecurrentPayment ( ) : boolean
Результат boolean

isAddable() публичный Метод

Check if the product can be added to the basket.
public isAddable ( Sonata\Component\Product\ProductInterface $product ) : boolean
$product Sonata\Component\Product\ProductInterface
Результат boolean

isEmpty() публичный Метод

test is the basket has elements.
public isEmpty ( ) : boolean
Результат boolean

isValid() публичный Метод

if $element_only is set to true, only elements are checked
public isValid ( boolean $elementsOnly = false ) : boolean
$elementsOnly boolean
Результат boolean

removeBasketElement() публичный Метод

delete an element from the basket depend on the $element. Element can be a product or a basket element.
public removeBasketElement ( Sonata\Component\Basket\BasketElementInterface $element ) : Sonata\Component\Basket\BasketElementInterface
$element Sonata\Component\Basket\BasketElementInterface
Результат Sonata\Component\Basket\BasketElementInterface

removeElement() публичный Метод

delete an element from the basket depend on the $element. Element can be a product or a basket element.
Устаревший: Use RemoveBasketElement instead
public removeElement ( Sonata\Component\Basket\BasketElementInterface $element ) : Sonata\Component\Basket\BasketElementInterface
$element Sonata\Component\Basket\BasketElementInterface
Результат Sonata\Component\Basket\BasketElementInterface

removeElements() публичный Метод

deletes several elements from the basket.
public removeElements ( array $elementsToRemove )
$elementsToRemove array

reset() публичный Метод

reset basket.
public reset ( boolean $full = true )
$full boolean

setBasketElements() публичный Метод

Warning : this method should be only used by the validation framework.
public setBasketElements ( array $elements )
$elements array

setBillingAddress() публичный Метод

set the Payment address.
public setBillingAddress ( Sonata\Component\Customer\AddressInterface $address = null )
$address Sonata\Component\Customer\AddressInterface

setBillingAddressId() публичный Метод

public setBillingAddressId ( integer $billingAddressId )
$billingAddressId integer

setCurrency() публичный Метод

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

setCustomer() публичный Метод

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

setCustomerId() публичный Метод

public setCustomerId ( integer $customerId )
$customerId integer

setDeliveryAddress() публичный Метод

set the Delivery address.
public setDeliveryAddress ( Sonata\Component\Customer\AddressInterface $address = null )
$address Sonata\Component\Customer\AddressInterface

setDeliveryAddressId() публичный Метод

public setDeliveryAddressId ( integer $deliveryAddressId )
$deliveryAddressId integer

setDeliveryMethod() публичный Метод

set the Delivery method.
public setDeliveryMethod ( Sonata\Component\Delivery\ServiceDeliveryInterface $method = null )
$method Sonata\Component\Delivery\ServiceDeliveryInterface

setLocale() публичный Метод

public setLocale ( string $locale )
$locale string

setPaymentMethod() публичный Метод

set Payment method.
public setPaymentMethod ( Sonata\Component\Payment\PaymentInterface $method = null )
$method Sonata\Component\Payment\PaymentInterface

setPaymentMethodCode() публичный Метод

public setPaymentMethodCode ( string $paymentMethodCode )
$paymentMethodCode string

setProductPool() публичный Метод

public setProductPool ( Pool $pool )
$pool Sonata\Component\Product\Pool