- Class name: OrderCore
- Parent class: ObjectModel
- Source: classes/order/Order.php line 27
- $_historyCache
- $_taxCalculationMethod
- $carrier_tax_rate
- $conversion_rate
- $current_state
- $date_add
- $date_upd
- $definition
- $delivery_date
- $delivery_number
- $gift
- $gift_message
- $id_address_delivery
- $id_address_invoice
- $id_carrier
- $id_cart
- $id_currency
- $id_customer
- $id_lang
- $id_shop
- $id_shop_group
- $invoice_date
- $invoice_number
- $module
- $payment
- $recyclable
- $reference
- $secure_key
- $shipping_number
- $total_discounts
- $total_discounts_tax_excl
- $total_discounts_tax_incl
- $total_paid
- $total_paid_real
- $total_paid_tax_excl
- $total_paid_tax_incl
- $total_products
- $total_products_wt
- $total_shipping
- $total_shipping_tax_excl
- $total_shipping_tax_incl
- $total_wrapping
- $total_wrapping_tax_excl
- $total_wrapping_tax_incl
- $valid
- $webserviceParameters
- $db
- $def
- $fieldsRequired
- $fieldsRequiredDatabase
- $fieldsRequiredLang
- $fieldsSize
- $fieldsSizeLang
- $fieldsValidate
- $fieldsValidateLang
- $get_shop_from_context
- $id
- $id_shop_list
- $identifier
- $image_dir
- $image_format
- $table
- $tables
- $update_fields
- __construct
- _deleteProduct
- add
- addCartRule
- addDiscount
- addFieldsRequiredDatabase
- addOrderPayment
- addWs
- associateTo
- clearCache
- delete
- deleteAssociations
- deleteCustomization
- deleteImage
- deleteProduct
- deleteSelection
- displayFieldName
- duplicateObject
- duplicateShops
- existsInDatabase
- formatFields
- formatValue
- generateReference
- getAssociatedShops
- getBrother
- getByDelivery
- getByReference
- getCartIdStatic
- getCartProducts
- getCartRules
- getCurrentOrderState
- getCurrentState
- getCurrentStateFull
- getCustomer
- getCustomerNbOrders
- getCustomerOrders
- getDefinition
- getDeliverySlipsCollection
- getDiscounts
- getDiscountsCustomer
- getDocuments
- getEcoTaxTaxesBreakdown
- getFieldByLang
- getFields
- getFieldsLang
- getFieldsRequiredDatabase
- getFieldsShop
- getFirstMessage
- getHistory
- getIdOrderProduct
- getInvoice
- getInvoicesCollection
- getLastInvoiceNumber
- getNextOrderId
- getNotPaidInvoicesCollection
- getNumberOfDays
- getOrderByCartId
- getOrderDetailList
- getOrderIdsByStatus
- getOrderPaymentCollection
- getOrderPayments
- getOrderSlipsCollection
- getOrdersIdByDate
- getOrdersIdInvoiceByDate
- getOrdersTotalPaid
- getOrdersWithInformations
- getPreviousOrderId
- getProductTaxesBreakdown
- getProducts
- getProductsDetail
- getReturn
- getShipping
- getShippingTaxesBreakdown
- getTaxCalculationMethod
- getTaxesAverageUsed
- getTotalPaid
- getTotalProductsWithTaxes
- getTotalProductsWithoutTaxes
- getTotalWeight
- getTranslationsFields
- getUniqReference
- getUniqReferenceOf
- getValidationRules
- getVirtualProducts
- getWarehouseList
- getWebserviceObjectList
- getWebserviceParameters
- getWrappingTaxesBreakdown
- getWsOrderRows
- hasBeenDelivered
- hasBeenPaid
- hasBeenShipped
- hasInvoice
- hasMultishopEntries
- hasProductReturned
- hydrate
- hydrateCollection
- isAssociatedAtGuest
- isAssociatedToShop
- isCurrentlyUsed
- isInPreparation
- isLangMultishop
- isMultishop
- isPaidAndShipped
- isReturnable
- isVirtual
- makeTranslationFields
- orderContainProduct
- save
- setCurrentState
- setDefinitionRetrocompatibility
- setDelivery
- setFieldsToUpdate
- setInvoice
- setProductCurrentStock
- setProductCustomizedDatas
- setProductImageInformations
- setProductPrices
- toggleStatus
- update
- updateMultishopTable
- updateShippingCost
- useOneAfterAnotherTaxComputationMethod
- validateControler
- validateController
- validateField
- validateFields
- validateFieldsLang
- validateFieldsRequiredDatabase
protected mixed $_historyCache = array()
- Visibility: protected
- This property is static.
- Source: classes/order/Order.php line 246.
protected mixed $_taxCalculationMethod = PS_TAX_EXC
- Visibility: protected
- Source: classes/order/Order.php line 244.
public float $carrier_tax_rate
- Visibility: public
- Source: classes/order/Order.php line 119.
public float $conversion_rate
- Visibility: public
- Source: classes/order/Order.php line 67.
public integer $current_state
- Visibility: public
- Source: classes/order/Order.php line 55.
public string $date_add
- Visibility: public
- Source: classes/order/Order.php line 146.
public string $date_upd
- Visibility: public
- Source: classes/order/Order.php line 149.
public mixed $definition = array('table' => 'orders', 'primary' => 'id_order', 'fields' => array('id_address_delivery' => array('type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true), 'id_address_invoice' => array('type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true), 'id_cart' => array('type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true), 'id_currency' => array('type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true), 'id_shop_group' => array('type' => self::TYPE_INT, 'validate' => 'isUnsignedId'), 'id_shop' => array('type' => self::TYPE_INT, 'validate' => 'isUnsignedId'), 'id_lang' => array('type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true), 'id_customer' => array('type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true), 'id_carrier' => array('type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true), 'current_state' => array('type' => self::TYPE_INT, 'validate' => 'isUnsignedId'), 'secure_key' => array('type' => self::TYPE_STRING, 'validate' => 'isMd5'), 'payment' => array('type' => self::TYPE_STRING, 'validate' => 'isGenericName', 'required' => true), 'module' => array('type' => self::TYPE_STRING), 'recyclable' => array('type' => self::TYPE_BOOL, 'validate' => 'isBool'), 'gift' => array('type' => self::TYPE_BOOL, 'validate' => 'isBool'), 'gift_message' => array('type' => self::TYPE_STRING, 'validate' => 'isMessage'), 'total_discounts' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice'), 'total_discounts_tax_incl' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice'), 'total_discounts_tax_excl' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice'), 'total_paid' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice', 'required' => true), 'total_paid_tax_incl' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice'), 'total_paid_tax_excl' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice'), 'total_paid_real' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice', 'required' => true), 'total_products' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice', 'required' => true), 'total_products_wt' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice', 'required' => true), 'total_shipping' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice'), 'total_shipping_tax_incl' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice'), 'total_shipping_tax_excl' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice'), 'carrier_tax_rate' => array('type' => self::TYPE_FLOAT, 'validate' => 'isFloat'), 'total_wrapping' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice'), 'total_wrapping_tax_incl' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice'), 'total_wrapping_tax_excl' => array('type' => self::TYPE_FLOAT, 'validate' => 'isPrice'), 'shipping_number' => array('type' => self::TYPE_STRING, 'validate' => 'isTrackingNumber'), 'conversion_rate' => array('type' => self::TYPE_FLOAT, 'validate' => 'isFloat', 'required' => true), 'invoice_number' => array('type' => self::TYPE_INT), 'delivery_number' => array('type' => self::TYPE_INT), 'invoice_date' => array('type' => self::TYPE_DATE), 'delivery_date' => array('type' => self::TYPE_DATE), 'valid' => array('type' => self::TYPE_BOOL), 'reference' => array('type' => self::TYPE_STRING), 'date_add' => array('type' => self::TYPE_DATE, 'validate' => 'isDate'), 'date_upd' => array('type' => self::TYPE_DATE, 'validate' => 'isDate')))
- Visibility: public
- This property is static.
- Source: classes/order/Order.php line 159.
public string $delivery_date
- Visibility: public
- Source: classes/order/Order.php line 140.
public integer $delivery_number
- Visibility: public
- Source: classes/order/Order.php line 134.
public boolean $gift
- Visibility: public
- Source: classes/order/Order.php line 73.
public string $gift_message
- Visibility: public
- Source: classes/order/Order.php line 76.
public integer $id_address_delivery
- Visibility: public
- Source: classes/order/Order.php line 30.
public integer $id_address_invoice
- Visibility: public
- Source: classes/order/Order.php line 33.
public integer $id_carrier
- Visibility: public
- Source: classes/order/Order.php line 52.
public integer $id_cart
- Visibility: public
- Source: classes/order/Order.php line 40.
public integer $id_currency
- Visibility: public
- Source: classes/order/Order.php line 43.
public integer $id_customer
- Visibility: public
- Source: classes/order/Order.php line 49.
public integer $id_lang
- Visibility: public
- Source: classes/order/Order.php line 46.
public mixed $id_shop
- Visibility: public
- Source: classes/order/Order.php line 37.
public mixed $id_shop_group
- Visibility: public
- Source: classes/order/Order.php line 35.
public string $invoice_date
- Visibility: public
- Source: classes/order/Order.php line 137.
public integer $invoice_number
- Visibility: public
- Source: classes/order/Order.php line 131.
public string $module
- Visibility: public
- Source: classes/order/Order.php line 64.
public string $payment
- Visibility: public
- Source: classes/order/Order.php line 61.
public boolean $recyclable = 1
- Visibility: public
- Source: classes/order/Order.php line 70.
public string $reference
- Visibility: public
- Source: classes/order/Order.php line 154.
public string $secure_key
- Visibility: public
- Source: classes/order/Order.php line 58.
public string $shipping_number
- Visibility: public
- Source: classes/order/Order.php line 83.
public float $total_discounts
- Visibility: public
- Source: classes/order/Order.php line 86.
public mixed $total_discounts_tax_excl
- Visibility: public
- Source: classes/order/Order.php line 89.
public mixed $total_discounts_tax_incl
- Visibility: public
- Source: classes/order/Order.php line 88.
public float $total_paid
- Visibility: public
- Source: classes/order/Order.php line 92.
public float $total_paid_real
- Visibility: public
- Source: classes/order/Order.php line 101.
public float $total_paid_tax_excl
- Visibility: public
- Source: classes/order/Order.php line 98.
public float $total_paid_tax_incl
- Visibility: public
- Source: classes/order/Order.php line 95.
public float $total_products
- Visibility: public
- Source: classes/order/Order.php line 104.
public float $total_products_wt
- Visibility: public
- Source: classes/order/Order.php line 107.
public float $total_shipping
- Visibility: public
- Source: classes/order/Order.php line 110.
public float $total_shipping_tax_excl
- Visibility: public
- Source: classes/order/Order.php line 116.
public float $total_shipping_tax_incl
- Visibility: public
- Source: classes/order/Order.php line 113.
public float $total_wrapping
- Visibility: public
- Source: classes/order/Order.php line 122.
public float $total_wrapping_tax_excl
- Visibility: public
- Source: classes/order/Order.php line 128.
public float $total_wrapping_tax_incl
- Visibility: public
- Source: classes/order/Order.php line 125.
public boolean $valid
- Visibility: public
- Source: classes/order/Order.php line 143.
protected mixed $webserviceParameters = array('objectMethods' => array('add' => 'addWs'), 'objectNodeName' => 'order', 'objectsNodeName' => 'orders', 'fields' => array('id_address_delivery' => array('xlink_resource' => 'addresses'), 'id_address_invoice' => array('xlink_resource' => 'addresses'), 'id_cart' => array('xlink_resource' => 'carts'), 'id_currency' => array('xlink_resource' => 'currencies'), 'id_lang' => array('xlink_resource' => 'languages'), 'id_customer' => array('xlink_resource' => 'customers'), 'id_carrier' => array('xlink_resource' => 'carriers'), 'current_state' => array('xlink_resource' => 'order_states'), 'module' => array('required' => true), 'invoice_number' => array(), 'invoice_date' => array(), 'delivery_number' => array(), 'delivery_date' => array(), 'valid' => array(), 'date_add' => array(), 'date_upd' => array()), 'associations' => array('order_rows' => array('resource' => 'order_row', 'setter' => false, 'virtual_entity' => true, 'fields' => array('id' => array(), 'product_id' => array('required' => true), 'product_attribute_id' => array('required' => true), 'product_quantity' => array('required' => true), 'product_name' => array('setter' => false), 'product_price' => array('setter' => false)))))
- Visibility: protected
- Source: classes/order/Order.php line 208.
protected \Db $db = false
- Visibility: protected
- This property is static.
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 140.
protected array $def
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 130.
protected mixed $fieldsRequired = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 80.
protected mixed $fieldsRequiredDatabase = null
- Visibility: protected
- This property is static.
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 65.
protected mixed $fieldsRequiredLang = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 95.
protected mixed $fieldsSize = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 85.
protected mixed $fieldsSizeLang = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 100.
protected mixed $fieldsValidate = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 90.
protected mixed $fieldsValidateLang = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 105.
protected mixed $get_shop_from_context = true
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 63.
public integer $id
- Visibility: public
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 54.
public mixed $id_shop_list = null
- Visibility: public
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 61.
protected mixed $identifier
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 75.
protected string $image_dir = null
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 116.
protected string $image_format = 'jpg'
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 119.
protected mixed $table
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 70.
protected mixed $tables = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 110.
protected array $update_fields = null
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 135.
mixed OrderCore::__construct($id, $id_lang)
- Visibility: public
- Source: classes/order/Order.php line 248
- $id mixed
- $id_lang mixed
mixed OrderCore::_deleteProduct($orderDetail, $quantity)
- Visibility: protected
- Source: classes/order/Order.php line 335
- $orderDetail mixed
- $quantity mixed
mixed OrderCore::add($autodate, $null_values)
- Visibility: public
- Source: classes/order/Order.php line 272
- $autodate mixed
- $null_values mixed
boolean OrderCore::addCartRule(integer $id_cart_rule, string $name, array $values, integer $id_order_invoice)
- Visibility: public
- Source: classes/order/Order.php line 1030
- $id_cart_rule integer
- $name string
- $values array
- $id_order_invoice integer
boolean OrderCore::addDiscount(integer $id_cart_rule, string $name, float $value)
- Visibility: public
- Source: classes/order/Order.php line 1016
- $id_cart_rule integer
- $name string
- $value float
mixed ObjectModelCore::addFieldsRequiredDatabase($fields)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1144
- $fields mixed
boolean OrderCore::addOrderPayment(float $amount_paid, string $payment_method, string $payment_transaction_id, \Currency $currency, string $date, \OrderInvoice $order_invoice)
This method allows to add a payment to the current order
- Visibility: public
- Source: classes/order/Order.php line 1424
- $amount_paid float
- $payment_method string
- $payment_transaction_id string
- $currency Currency
- $date string
- $order_invoice OrderInvoice
mixed OrderCore::addWs($autodate, $nullValues)
- Visibility: public
- Source: classes/order/Order.php line 1309
- $autodate mixed
- $nullValues mixed
boolean ObjectModelCore::associateTo(integer|array $id_shops)
This function associate an item to its context
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1191
- $id_shops integer|array
mixed ObjectModelCore::clearCache($all)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1158
- $all mixed
boolean ObjectModelCore::delete()
Delete current object from database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 691
mixed OrderCore::deleteAssociations()
- Visibility: public
- Source: classes/order/Order.php line 1318
mixed OrderCore::deleteCustomization($id_customization, $quantity, $orderDetail)
- Visibility: public
- Source: classes/order/Order.php line 405
- $id_customization mixed
- $quantity mixed
- $orderDetail mixed
boolean ObjectModelCore::deleteImage($force_delete)
Delete images associated with the object
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1317
- $force_delete mixed
mixed OrderCore::deleteProduct($order, $orderDetail, $quantity)
- Visibility: public
- Source: classes/order/Order.php line 285
- $order mixed
- $orderDetail mixed
- $quantity mixed
boolean ObjectModelCore::deleteSelection(array $selection)
Delete several objects from database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 737
- $selection array
mixed ObjectModelCore::displayFieldName($field, $class, $htmlentities, \Context $context)
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 937
- $field mixed
- $class mixed
- $htmlentities mixed
- $context Context
\new ObjectModelCore::duplicateObject()
Duplicate current object to database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 527
mixed ObjectModelCore::duplicateShops($id)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1235
- $id mixed
boolean ObjectModelCore::existsInDatabase(integer $id_entity, string $table)
Specify if an ObjectModel is already in database
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1354
- $id_entity integer
- $table string
array ObjectModelCore::formatFields(integer $type, integer $id_lang)
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 334
- $type integer - FORMAT_COMMON or FORMAT_LANG or FORMAT_SHOP
- $id_lang integer - If this parameter is given, only take lang fields
mixed ObjectModelCore::formatValue(mixed $value, integer $type, $with_quotes)
Format a data
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 380
- $value mixed
- $type integer
- $with_quotes mixed
String OrderCore::generateReference()
Gennerate a unique reference for orders generated with the same cart id This references, is usefull for check payment
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 1368
array ObjectModelCore::getAssociatedShops()
Get the list of associated id_shop
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1220
mixed OrderCore::getBrother()
Get all other orders with the same reference
- Visibility: public
- Source: classes/order/Order.php line 1813
mixed OrderCore::getByDelivery($id_delivery)
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 1198
- $id_delivery mixed
\Collection OrderCore::getByReference(string $reference)
Get a collection of orders using reference
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 1216
- $reference string
integer OrderCore::getCartIdStatic(integer $id_order, integer $id_customer)
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 1266
- $id_order integer
- $id_customer integer - optionnal
array OrderCore::getCartProducts()
This function return products of the orders It's similar to Order::getProducts but witrh similar outputs of Cart::getProducts
- Visibility: public
- Source: classes/order/Order.php line 311
mixed OrderCore::getCartRules()
- Visibility: public
- Source: classes/order/Order.php line 706
\OrderState OrderCore::getCurrentOrderState()
- Visibility: public
- Source: classes/order/Order.php line 1792
integer OrderCore::getCurrentState()
Get current order state (eg. Awaiting payment, Delivered.
..)
- Visibility: public
- Source: classes/order/Order.php line 729
array OrderCore::getCurrentStateFull($id_lang)
Get current order state name (eg. Awaiting payment, Delivered.
..)
- Visibility: public
- Source: classes/order/Order.php line 739
- $id_lang mixed
\Customer OrderCore::getCustomer()
Get order customer
- Visibility: public
- Source: classes/order/Order.php line 965
array OrderCore::getCustomerNbOrders(integer $id_customer)
Get customer orders number
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 980
- $id_customer integer - Customer id
array OrderCore::getCustomerOrders(integer $id_customer, boolean $showHiddenStatus, \Context $context)
Get customer orders
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 803
- $id_customer integer - Customer id
- $showHiddenStatus boolean - Display or not hidden order statuses
- $context Context
array ObjectModelCore::getDefinition(string $class, string $field)
Get object definition
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1460
- $class string - Name of object
- $field string - Name of field if we want the definition of one field only
\Collection OrderCore::getDeliverySlipsCollection()
Get all delivery slips for the current order
- Visibility: public
- Source: classes/order/Order.php line 1550
mixed OrderCore::getDiscounts($details)
- Visibility: public
- Source: classes/order/Order.php line 700
- $details mixed
mixed OrderCore::getDiscountsCustomer($id_customer, $id_cart_rule)
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 715
- $id_customer mixed
- $id_cart_rule mixed
array OrderCore::getDocuments()
Returns the correct product taxes breakdown.
Get all documents linked to the current order
- Visibility: public
- Source: classes/order/Order.php line 1467
array OrderCore::getEcoTaxTaxesBreakdown()
Returns the ecotax taxes breakdown
- Visibility: public
- Source: classes/order/Order.php line 1742
mixed ObjectModelCore::getFieldByLang($field_name, null $id_lang)
Return the field value for the specified language if the field is multilang, else the field value.
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1548
- $field_name mixed
- $id_lang null
array OrderCore::getFields()
- Visibility: public
- Source: classes/order/Order.php line 264
array ObjectModelCore::getFieldsLang()
Prepare multilang fields
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 299
mixed ObjectModelCore::getFieldsRequiredDatabase($all)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1136
- $all mixed
array ObjectModelCore::getFieldsShop()
Prepare fields for multishop Fields are not validated here, we considere they are already validated in getFields() method, this not the best solution but this is the only one possible for retro compatibility.
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 285
mixed OrderCore::getFirstMessage()
- Visibility: public
- Source: classes/order/Order.php line 489
array OrderCore::getHistory(integer $id_lang, integer $id_order_state, integer $no_hidden, integer $filters)
Get order history
- Visibility: public
- Source: classes/order/Order.php line 431
- $id_lang integer - Language id
- $id_order_state integer - Filter a specific order state
- $no_hidden integer - Filter no hidden status
- $filters integer - Flag to use specific field filter
mixed OrderCore::getIdOrderProduct($id_customer, $id_product)
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 580
- $id_customer mixed
- $id_product mixed
mixed OrderCore::getInvoice(integer $id_invoice)
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 1238
- $id_invoice integer
\Collection OrderCore::getInvoicesCollection()
Get all invoices for the current order
- Visibility: public
- Source: classes/order/Order.php line 1537
mixed OrderCore::getLastInvoiceNumber()
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 1068
integer OrderCore::getNextOrderId()
This method return the ID of the next order
- Visibility: public
- Source: classes/order/Order.php line 1344
\Collection OrderCore::getNotPaidInvoicesCollection()
Get all not paid invoices for the current order
- Visibility: public
- Source: classes/order/Order.php line 1563
mixed OrderCore::getNumberOfDays()
- Visibility: public
- Source: classes/order/Order.php line 1042
array OrderCore::getOrderByCartId(integer $id_cart)
Get an order by its cart id
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 997
- $id_cart integer - Cart id
array OrderCore::getOrderDetailList()
Get the an order detail list of the current order
- Visibility: public
- Source: classes/order/Order.php line 1357
array OrderCore::getOrderIdsByStatus($id_order_state)
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 908
- $id_order_state mixed
\Collection OrderCore::getOrderPaymentCollection()
This method allows to get all Order Payment for the current order
- Visibility: public
- Source: classes/order/Order.php line 1405
mixed OrderCore::getOrderPayments()
Get a collection of order payments
- Visibility: public
- Source: classes/order/Order.php line 1826
\Collection OrderCore::getOrderSlipsCollection()
Get all order_slips for the current order
- Visibility: public
- Source: classes/order/Order.php line 1524
mixed OrderCore::getOrdersIdByDate($date_from, $date_to, $id_customer, $type)
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 835
- $date_from mixed
- $date_to mixed
- $id_customer mixed
- $type mixed
array OrderCore::getOrdersIdInvoiceByDate($date_from, $date_to, $id_customer, $type)
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 883
- $date_from mixed
- $date_to mixed
- $id_customer mixed
- $type mixed
float OrderCore::getOrdersTotalPaid()
Get the sum of total_paid_tax_incl of the orders with similar reference
- Visibility: public
- Source: classes/order/Order.php line 1610
mixed OrderCore::getOrdersWithInformations($limit, \Context $context)
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 851
- $limit mixed
- $context Context
integer OrderCore::getPreviousOrderId()
This method return the ID of the previous order
- Visibility: public
- Source: classes/order/Order.php line 1330
array OrderCore::getProductTaxesBreakdown()
Returns the correct product taxes breakdown.
- Visibility: public
- Source: classes/order/Order.php line 1649
array OrderCore::getProducts($products, $selectedProducts, $selectedQty)
Get order products
- Visibility: public
- Source: classes/order/Order.php line 531
- $products mixed
- $selectedProducts mixed
- $selectedQty mixed
mixed OrderCore::getProductsDetail()
- Visibility: public
- Source: classes/order/Order.php line 479
mixed OrderCore::getReturn()
- Visibility: public
- Source: classes/order/Order.php line 1493
array OrderCore::getShipping()
- Visibility: public
- Source: classes/order/Order.php line 1501
array OrderCore::getShippingTaxesBreakdown()
Returns the shipping taxes breakdown
- Visibility: public
- Source: classes/order/Order.php line 1708
mixed OrderCore::getTaxCalculationMethod()
- Visibility: public
- Source: classes/order/Order.php line 279
mixed OrderCore::getTaxesAverageUsed()
- Visibility: public
- Source: classes/order/Order.php line 650
float OrderCore::getTotalPaid(\Currency $currency)
Get total paid
- Visibility: public
- Source: classes/order/Order.php line 1579
- $currency Currency - currency used for the total paid of the current order
\Product OrderCore::getTotalProductsWithTaxes($products)
Get product total with taxes
- Visibility: public
- Source: classes/order/Order.php line 939
- $products mixed
\Product OrderCore::getTotalProductsWithoutTaxes($products)
Get product total without taxes
- Visibility: public
- Source: classes/order/Order.php line 929
- $products mixed
mixed OrderCore::getTotalWeight()
- Visibility: public
- Source: classes/order/Order.php line 1223
mixed ObjectModelCore::getTranslationsFields($fields_array)
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 769
- $fields_array mixed
mixed OrderCore::getUniqReference()
Return a unique reference like : GWJTHMZUN#2
With multishipping, order reference are the same for all orders made with the same cart in this case this method suffix the order reference by a # and the order number
- Visibility: public
- Source: classes/order/Order.php line 1839
mixed OrderCore::getUniqReferenceOf($id_order)
Return a unique reference like : GWJTHMZUN#2
With multishipping, order reference are the same for all orders made with the same cart in this case this method suffix the order reference by a # and the order number
- Visibility: public
- This method is static.
- Source: classes/order/Order.php line 1862
- $id_order mixed
array ObjectModelCore::getValidationRules(string $class)
Returns object validation rules (fields validity)
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 148
- $class string - Child class name for static use (optional)
integer OrderCore::getVirtualProducts()
Count virtual products in order
- Visibility: public
- Source: classes/order/Order.php line 660
mixed OrderCore::getWarehouseList()
Get warehouse associated to the order
return array List of warehouse
- Visibility: public
- Source: classes/order/Order.php line 1771
mixed OrderCore::getWebserviceObjectList($sql_join, $sql_filter, $sql_sort, $sql_limit)
- Visibility: public
- Source: classes/order/Order.php line 1802
- $sql_join mixed
- $sql_filter mixed
- $sql_sort mixed
- $sql_limit mixed
mixed ObjectModelCore::getWebserviceParameters($ws_params_attribute_name)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1004
- $ws_params_attribute_name mixed
array OrderCore::getWrappingTaxesBreakdown()
Returns the wrapping taxes breakdown
- Visibility: public
- Source: classes/order/Order.php line 1730
mixed OrderCore::getWsOrderRows()
- Visibility: public
- Source: classes/order/Order.php line 1275
mixed OrderCore::hasBeenDelivered()
- Visibility: public
- Source: classes/order/Order.php line 748
mixed OrderCore::hasBeenPaid()
- Visibility: public
- Source: classes/order/Order.php line 768
mixed OrderCore::hasBeenShipped()
- Visibility: public
- Source: classes/order/Order.php line 773
boolean OrderCore::hasInvoice()
Has invoice return true if this order has already an invoice
- Visibility: public
- Source: classes/order/Order.php line 1756
boolean ObjectModelCore::hasMultishopEntries()
Check if there is more than one entries in associated shop table for current entity
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1260
mixed OrderCore::hasProductReturned()
Has products returned by the merchant or by the customer?
- Visibility: public
- Source: classes/order/Order.php line 756
mixed ObjectModelCore::hydrate(array $data, integer $id_lang)
Fill an object with given data. Data must be an array with this syntax: array(objProperty => value, objProperty2 => value, etc.)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1392
- $data array
- $id_lang integer
array ObjectModelCore::hydrateCollection(string $class, array $datas, integer $id_lang)
Fill (hydrate) a list of objects in order to get a collection of these objects
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1411
- $class string - Class of objects to hydrate
- $datas array - List of data (multi-dimensional array)
- $id_lang integer
mixed OrderCore::isAssociatedAtGuest($email)
- Visibility: public
- Source: classes/order/Order.php line 1247
- $email mixed
boolean ObjectModelCore::isAssociatedToShop(integer $id_shop)
Check if current object is associated to a shop
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1173
- $id_shop integer
boolean ObjectModelCore::isCurrentlyUsed(string $table, boolean $has_active_column)
This method is allow to know if a entity is currently used
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1372
- $table string - name of table linked to entity
- $has_active_column boolean - true if the table has an active column
mixed OrderCore::isInPreparation()
- Visibility: public
- Source: classes/order/Order.php line 778
mixed ObjectModelCore::isLangMultishop()
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1272
mixed ObjectModelCore::isMultishop()
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1267
boolean OrderCore::isPaidAndShipped()
Checks if the current order state is paid and shipped
- Visibility: public
- Source: classes/order/Order.php line 788
boolean OrderCore::isReturnable()
Can this order be returned by the client?
- Visibility: public
- Source: classes/order/Order.php line 1060
boolean OrderCore::isVirtual(boolean $strict)
Check if order contains (only) virtual products
- Visibility: public
- Source: classes/order/Order.php line 677
- $strict boolean - If false return true if there are at least one product virtual
mixed ObjectModelCore::makeTranslationFields($fields, $fields_array, $id_language)
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 785
- $fields mixed
- $fields_array mixed
- $id_language mixed
mixed OrderCore::orderContainProduct($id_product)
- Visibility: public
- Source: classes/order/Order.php line 1373
- $id_product mixed
boolean ObjectModelCore::save(boolean $null_values, boolean $autodate)
Save current object to database (add or update)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 424
- $null_values boolean
- $autodate boolean
mixed OrderCore::setCurrentState(integer $id_order_state, integer $id_employee)
Set current order state
- Visibility: public
- Source: classes/order/Order.php line 1288
- $id_order_state integer
- $id_employee integer - (/!\ not optional except for Webservice.
mixed ObjectModelCore::setDefinitionRetrocompatibility()
Retrocompatibility for classes without $definition static Remove this in 1.6 !
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1488
mixed OrderCore::setDelivery()
- Visibility: public
- Source: classes/order/Order.php line 1166
mixed ObjectModelCore::setFieldsToUpdate(array $fields)
Set a list of specific fields to update array(field1 => true, field2 => false, langfield1 => array(1 => true, 2 => false))
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1574
- $fields array
mixed OrderCore::setInvoice($use_existing_payment)
This method allows to generate first invoice of the current order
- Visibility: public
- Source: classes/order/Order.php line 1079
- $use_existing_payment mixed
mixed OrderCore::setProductCurrentStock($product)
This method allow to add stock information on a product detail
If advanced stock management is active, get physical stock of this product in the warehouse associated to the ptoduct for the current order Else get the available quantity of the product in fucntion of the shop associated to the order
- Visibility: protected
- Source: classes/order/Order.php line 611
- $product mixed
mixed OrderCore::setProductCustomizedDatas($product, $customized_datas)
- Visibility: protected
- Source: classes/order/Order.php line 593
- $product mixed
- $customized_datas mixed
mixed OrderCore::setProductImageInformations($product)
This method allow to add image information on a product detail
- Visibility: protected
- Source: classes/order/Order.php line 626
- $product mixed
mixed OrderCore::setProductPrices($row)
Marked as deprecated but should not throw any "deprecated" message This function is used in order to keep front office backward compatibility 14 -> 1.5 (Order History)
- Visibility: public
- Source: classes/order/Order.php line 506
- $row mixed
boolean ObjectModelCore::toggleStatus()
Toggle object status in database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 753
boolean ObjectModelCore::update(boolean $null_values)
Update current object to database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 576
- $null_values boolean
boolean ObjectModelCore::updateMultishopTable(string $classname, array $data, string $where, string $specific_where)
Update a table and splits the common datas and the shop datas
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1287
- $classname string
- $data array
- $where string
- $specific_where string - Only executed for common table
boolean OrderCore::updateShippingCost(float $amount)
This method allows to change the shipping cost of the current order
- Visibility: public
- Source: classes/order/Order.php line 1627
- $amount float
boolean OrderCore::useOneAfterAnotherTaxComputationMethod()
This method returns true if at least one order details uses the One After Another tax computation method.
- Visibility: public
- Source: classes/order/Order.php line 1388
mixed ObjectModelCore::validateControler($htmlentities)
TODO: refactor rename all calls to this to validateController
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 952
- $htmlentities mixed
mixed ObjectModelCore::validateController($htmlentities)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 958
- $htmlentities mixed
boolean|string ObjectModelCore::validateField(string $field, mixed $value, integer $id_lang)
Validate a single field
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 890
- $field string - Field name
- $value mixed - Field value
- $id_lang integer
boolean|string ObjectModelCore::validateFields(boolean $die, boolean $error_return)
Check for fields validity before database interaction
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 823
- $die boolean
- $error_return boolean
boolean|string ObjectModelCore::validateFieldsLang(boolean $die, boolean $error_return)
Check for multilingual fields validity before database interaction
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 852
- $die boolean
- $error_return boolean
mixed ObjectModelCore::validateFieldsRequiredDatabase($htmlentities)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1114
- $htmlentities mixed