275 lines
9.1 KiB
PHP
275 lines
9.1 KiB
PHP
<?php
|
|
/**
|
|
* For the full copyright and license information, please view the
|
|
* docs/licenses/LICENSE.txt file that was distributed with this source code.
|
|
*/
|
|
|
|
/**
|
|
* Represents one product ordered.
|
|
*
|
|
* @deprecated since 9.0 and will be removed in 10.0
|
|
*/
|
|
class SupplyOrderDetailCore extends ObjectModel
|
|
{
|
|
/**
|
|
* @var int Supply order
|
|
*/
|
|
public $id_supply_order;
|
|
|
|
/**
|
|
* @var int Product ordered
|
|
*/
|
|
public $id_product;
|
|
|
|
/**
|
|
* @var int Product attribute ordered
|
|
*/
|
|
public $id_product_attribute;
|
|
|
|
/**
|
|
* @var string Product reference
|
|
*/
|
|
public $reference;
|
|
|
|
/**
|
|
* @var string Product supplier reference
|
|
*/
|
|
public $supplier_reference;
|
|
|
|
/**
|
|
* @var int Product name
|
|
*/
|
|
public $name;
|
|
|
|
/**
|
|
* @var int Product EAN13
|
|
*/
|
|
public $ean13;
|
|
|
|
/**
|
|
* @var string Product ISBN
|
|
*/
|
|
public $isbn;
|
|
|
|
/**
|
|
* @var string UPC
|
|
*/
|
|
public $upc;
|
|
|
|
/**
|
|
* @var string MPN
|
|
*/
|
|
public $mpn;
|
|
|
|
/**
|
|
* @var int Currency used to buy this particular product
|
|
*/
|
|
public $id_currency;
|
|
|
|
/**
|
|
* @var float Exchange rate between and SupplyOrder::$id_ref_currency, at the time
|
|
*/
|
|
public $exchange_rate;
|
|
|
|
/**
|
|
* @var float Unit price without discount, without tax
|
|
*/
|
|
public $unit_price_te = 0;
|
|
|
|
/**
|
|
* @var int Quantity ordered
|
|
*/
|
|
public $quantity_expected = 0;
|
|
|
|
/**
|
|
* @var int Quantity received
|
|
*/
|
|
public $quantity_received = 0;
|
|
|
|
/**
|
|
* @var float this defines the price of the product, considering the number of units to buy.
|
|
* ($unit_price_te * $quantity), without discount, without tax
|
|
*/
|
|
public $price_te = 0;
|
|
|
|
/**
|
|
* @var float Supplier discount rate for a given product
|
|
*/
|
|
public $discount_rate = 0;
|
|
|
|
/**
|
|
* @var float Supplier discount value (($discount_rate / 100) *), without tax
|
|
*/
|
|
public $discount_value_te = 0;
|
|
|
|
/**
|
|
* @var float ($price_te -), with discount, without tax
|
|
*/
|
|
public $price_with_discount_te = 0;
|
|
|
|
/**
|
|
* @var int Tax rate for the given product
|
|
*/
|
|
public $tax_rate = 0;
|
|
|
|
/**
|
|
* @var float Tax value for the given product
|
|
*/
|
|
public $tax_value = 0;
|
|
|
|
/**
|
|
* @var float ($price_with_discount_te +)
|
|
*/
|
|
public $price_ti = 0;
|
|
|
|
/**
|
|
* @var float Tax value of the given product after applying the global order discount (i.e. if SupplyOrder::discount_rate is set)
|
|
*/
|
|
public $tax_value_with_order_discount = 0;
|
|
|
|
/**
|
|
* @var float This is like, considering the global order discount.
|
|
* (i.e. if SupplyOrder::discount_rate is set)
|
|
*/
|
|
public $price_with_order_discount_te = 0;
|
|
|
|
/**
|
|
* @see ObjectModel::$definition
|
|
*/
|
|
public static $definition = [
|
|
'table' => 'supply_order_detail',
|
|
'primary' => 'id_supply_order_detail',
|
|
'fields' => [
|
|
'id_supply_order' => ['type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true],
|
|
'id_product' => ['type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true],
|
|
'id_product_attribute' => ['type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true],
|
|
'reference' => ['type' => self::TYPE_STRING, 'validate' => 'isReference'],
|
|
'supplier_reference' => ['type' => self::TYPE_STRING, 'validate' => 'isReference'],
|
|
'name' => ['type' => self::TYPE_STRING, 'validate' => 'isGenericName', 'required' => true],
|
|
'ean13' => ['type' => self::TYPE_STRING, 'validate' => 'isEan13'],
|
|
'isbn' => ['type' => self::TYPE_STRING, 'validate' => 'isIsbn'],
|
|
'upc' => ['type' => self::TYPE_STRING, 'validate' => 'isUpc'],
|
|
'mpn' => ['type' => self::TYPE_STRING, 'validate' => 'isMpn'],
|
|
'id_currency' => ['type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true],
|
|
'exchange_rate' => ['type' => self::TYPE_FLOAT, 'validate' => 'isFloat', 'required' => true],
|
|
'unit_price_te' => ['type' => self::TYPE_FLOAT, 'validate' => 'isPrice', 'required' => true],
|
|
'quantity_expected' => ['type' => self::TYPE_INT, 'validate' => 'isUnsignedInt', 'required' => true],
|
|
'quantity_received' => ['type' => self::TYPE_INT, 'validate' => 'isUnsignedInt'],
|
|
'price_te' => ['type' => self::TYPE_FLOAT, 'validate' => 'isPrice', 'required' => true],
|
|
'discount_rate' => ['type' => self::TYPE_FLOAT, 'validate' => 'isFloat', 'required' => true],
|
|
'discount_value_te' => ['type' => self::TYPE_FLOAT, 'validate' => 'isPrice', 'required' => true],
|
|
'price_with_discount_te' => ['type' => self::TYPE_FLOAT, 'validate' => 'isPrice', 'required' => true],
|
|
'tax_rate' => ['type' => self::TYPE_FLOAT, 'validate' => 'isFloat', 'required' => true],
|
|
'tax_value' => ['type' => self::TYPE_FLOAT, 'validate' => 'isPrice', 'required' => true],
|
|
'price_ti' => ['type' => self::TYPE_FLOAT, 'validate' => 'isPrice', 'required' => true],
|
|
'tax_value_with_order_discount' => ['type' => self::TYPE_FLOAT, 'validate' => 'isFloat', 'required' => true],
|
|
'price_with_order_discount_te' => ['type' => self::TYPE_FLOAT, 'validate' => 'isPrice', 'required' => true],
|
|
],
|
|
];
|
|
|
|
/**
|
|
* @see ObjectModel::$webserviceParameters
|
|
*/
|
|
protected $webserviceParameters = [
|
|
'objectsNodeName' => 'supply_order_details',
|
|
'objectNodeName' => 'supply_order_detail',
|
|
'fields' => [
|
|
'id_supply_order' => ['xlink_resource' => 'supply_orders'],
|
|
'id_product' => ['xlink_resource' => 'products'],
|
|
'id_product_attribute' => ['xlink_resource' => 'combinations'],
|
|
],
|
|
'hidden_fields' => [
|
|
'id_currency',
|
|
],
|
|
];
|
|
|
|
/**
|
|
* @see ObjectModel::update()
|
|
*/
|
|
public function update($null_values = false)
|
|
{
|
|
$this->calculatePrices();
|
|
|
|
return parent::update($null_values);
|
|
}
|
|
|
|
/**
|
|
* @see ObjectModel::add()
|
|
*/
|
|
public function add($autodate = true, $null_values = false)
|
|
{
|
|
$this->calculatePrices();
|
|
|
|
return parent::add($autodate, $null_values);
|
|
}
|
|
|
|
/**
|
|
* Calculates all prices for this product based on its quantity and unit price
|
|
* Applies discount if necessary
|
|
* Calculates tax value, function of tax rate.
|
|
*/
|
|
protected function calculatePrices()
|
|
{
|
|
// calculates entry price
|
|
$this->price_te = Tools::ps_round((float) $this->unit_price_te * (int) $this->quantity_expected, 6);
|
|
|
|
// calculates entry discount value
|
|
if ($this->discount_rate != null && is_numeric($this->discount_rate) && $this->discount_rate > 0) {
|
|
$this->discount_value_te = Tools::ps_round((float) $this->price_te * ($this->discount_rate / 100), 6);
|
|
}
|
|
|
|
// calculates entry price with discount
|
|
$this->price_with_discount_te = Tools::ps_round($this->price_te - $this->discount_value_te, 6);
|
|
|
|
// calculates tax value
|
|
$this->tax_value = Tools::ps_round($this->price_with_discount_te * ((float) $this->tax_rate / 100), 6);
|
|
$this->price_ti = Tools::ps_round($this->price_with_discount_te + $this->tax_value, 6);
|
|
|
|
// defines default values for order discount fields
|
|
$this->tax_value_with_order_discount = Tools::ps_round($this->tax_value, 6);
|
|
$this->price_with_order_discount_te = Tools::ps_round($this->price_with_discount_te, 6);
|
|
}
|
|
|
|
/**
|
|
* Applies a global order discount rate, for the current product (i.e detail)
|
|
* Calls ObjectModel::update().
|
|
*
|
|
* @param float|int $discount_rate The discount rate in percent (Ex. 5 for 5 percents)
|
|
*/
|
|
public function applyGlobalDiscount($discount_rate)
|
|
{
|
|
if ($discount_rate != null && is_numeric($discount_rate) && (float) $discount_rate > 0) {
|
|
// calculates new price, with global order discount, tax ecluded
|
|
$discount_value = $this->price_with_discount_te - (($this->price_with_discount_te * (float) $discount_rate) / 100);
|
|
|
|
$this->price_with_order_discount_te = Tools::ps_round($discount_value, 6);
|
|
|
|
// calculates new tax value, with global order discount
|
|
$this->tax_value_with_order_discount = Tools::ps_round($this->price_with_order_discount_te * ((float) $this->tax_rate / 100), 6);
|
|
|
|
parent::update();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @see ObjectModel::hydrate()
|
|
*/
|
|
public function hydrate(array $data, $id_lang = null)
|
|
{
|
|
$this->id_lang = $id_lang;
|
|
if (isset($data[$this->def['primary']])) {
|
|
$this->id = $data[$this->def['primary']];
|
|
}
|
|
foreach ($data as $key => $value) {
|
|
if (array_key_exists($key, get_object_vars($this))) {
|
|
// formats prices and floats
|
|
if ($this->def['fields'][$key]['validate'] == 'isFloat'
|
|
|| $this->def['fields'][$key]['validate'] == 'isPrice') {
|
|
$value = Tools::ps_round($value, 6);
|
|
}
|
|
$this->$key = $value;
|
|
}
|
|
}
|
|
}
|
|
}
|