PrestaShop/classes/stock/SupplierOrder.php

<?php
/*
* 2007-2011 PrestaShop
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://opensource.org/licenses/osl-3.0.php
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to http://www.prestashop.com for more information.
*
*  @author PrestaShop SA <contact@prestashop.com>
*  @copyright  2007-2011 PrestaShop SA
*  @version  Release: $Revision$
*  @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
*  International Registered Trademark & Property of PrestaShop SA
*/

/**
 * @since 1.5.0
 */
class SupplierOrderCore extends ObjectModel
{
	/**
	 * @var int Supplier
	 */
	public $id_supplier;

	/**
	 * @var int Employee who initiated the order
	 */
	public $id_employee;

	/**
	 * @var int Warehouse where products will be delivered
	 */
	public $id_warehouse;

	/**
	 * @var int State of the order
	 */
	public $id_supplier_order_state;

	/**
	 * @var int Currency used for the order
	 */
	public $id_currency;

	/**
	 * @var int Currency used by default in main global configuration (i.e. by default for all shops)
	 */
	public $id_ref_currency;

	/**
	 * @var string Reference of the order
	 */
	public $reference;

	/**
	 * @var string Date when added
	 */
	public $date_add;

	/**
	 * @var string Date when updated
	 */
	public $date_upd;

	/**
	 * @var string Expected delivery date
	 */
	public $date_delivery_expected;

	/**
	 * @var float Total price without tax
	 */
	public $total_te = 0;

	/**
	 * @var float Total price after discount, without tax
	 */
	public $total_with_discount_te = 0;

	/**
	 * @var float Total price with tax
	 */
	public $total_ti = 0;

	/**
	 * @var float Total tax value
	 */
	public $total_tax = 0;

	/**
	 * @var float Supplier discount rate (for the whole order)
	 */
	public $discount_rate = 0;

	/**
	 * @var float Supplier discount value without tax (for the whole order)
	 */
	public $discount_value_te = 0;

	protected $fieldsRequired = array(
		'id_supplier',
		'id_employee',
		'id_warehouse',
		'id_supplier_order_state',
		'id_currency',
		'id_ref_currency',
		'reference',
		'discount_rate',
		'date_delivery_expected'
	);

	protected $fieldsValidate = array(
		'id_supplier' => 'isUnsignedId',
		'id_employee' => 'isUnsignedId',
		'id_warehouse' => 'isUnsignedId',
		'id_supplier_order_state' => 'isUnsignedId',
		'id_currency' => 'isUnsignedId',
		'id_ref_currency' => 'isUnsignedId',
		'reference' => 'isGenericName',
		'date_add' => 'isDate',
		'date_upd' => 'isDate',
		'date_delivery_expected' => 'isDate',
		'total_te' => 'isPrice',
		'total_with_discount_te' => 'isPrice',
		'total_ti' => 'isPrice',
		'total_tax' => 'isPrice',
		'discount_rate' => 'isFloat',
		'discount_value_te' => 'isPrice'
	);

	/**
	 * @var string Database table name
	 */
	protected $table = 'supplier_order';

	/**
	 * @var string Database ID name
	 */
	protected $identifier = 'id_supplier_order';

	public function getFields()
	{
		$this->validateFields();

		$fields['id_supplier'] = (int)$this->id_supplier;
		$fields['id_employee'] = (int)$this->id_employee;
		$fields['id_warehouse'] = (int)$this->id_warehouse;
		$fields['id_supplier_order_state'] = (int)$this->id_supplier_order_state;
		$fields['id_currency'] = (int)$this->id_currency;
		$fields['id_ref_currency'] = (int)$this->id_ref_currency;
		$fields['reference'] = pSQL($this->reference);
		$fields['date_add'] = pSQL($this->date_add);
		$fields['date_upd'] = pSQL($this->date_upd);
		$fields['date_delivery_expected'] = pSQL($this->date_delivery_expected);
		$fields['total_te'] = (float)$this->total_te;
		$fields['total_with_discount_te'] = (float)$this->total_with_discount_te;
		$fields['total_ti'] = (float)$this->total_ti;
		$fields['total_tax'] = (float)$this->total_tax;
		$fields['discount_rate'] = (float)$this->discount_rate;
		$fields['discount_value_te'] = (float)$this->discount_value_te;

		return $fields;
	}

	/**
	 * @see ObjectModel::update()
	 */
	public function update($null_values = false)
	{
		$this->calculatePrices();

		$return = parent::update($null_values);

		if ($return)
			$this->addHistory();

		return $return;
	}

	/**
	 * @see ObjectModel::update()
	 */
	public function add($autodate = true, $null_values = false)
	{
		$this->calculatePrices();

		$return = parent::add($autodate, $null_values);

		if ($return)
			$this->addHistory();

		return $return;
	}

	/**
	 * Check all products in this order and calculate prices
	 * Apply global discount if necessary
	 *
	 * @return array
	 */
	protected function calculatePrices()
	{
		$this->total_te = 0;
		$this->total_with_discount_te = 0;
		$this->total_tax = 0;
		$this->total_ti = 0;

		$is_discount = false;
		if (is_numeric($this->discount_rate) && (float)$this->discount_rate > 0)
			$is_discount = true;

		// get all product entries in this order
		$entries = $this->getEntriesCollection();

		foreach ($entries as $entry)
		{
			// apply global discount rate on each product if possible
			if ($is_discount)
			{
				$entry->applyGlobalDiscount((float)$this->discount_rate);
				$entry->save();
			}

			// add new prices to the total
			$this->total_te += $entry->price_with_discount_te;
			$this->total_with_discount_te += $entry->price_with_order_discount_te;
			$this->total_tax += $entry->tax_value_with_order_discount;
			$this->total_ti = $this->total_tax + $this->total_with_discount_te;
		}

		// apply global discount rate if possible
		if ($is_discount)
			$this->discount_value_te = $this->total_te - $this->total_with_discount_te;
	}

	/**
	 * Retrieves the product entries collection for the current order
	 *
	 * @return array
	 */
	public function getEntriesCollection()
	{
		// build query
		$query = new DbQuery();
		$query->select('s.*');
		$query->from('supplier_order_detail s');
		$query->where('s.id_supplier_order = '.(int)$this->id);

		$results = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($query);

		return ObjectModel::hydrateCollection('SupplierOrderDetail', $results);
	}

	/**
	 * Check if the current state allow to edit the current order
	 *
	 * @return bool
	 */
	protected function isEditable()
	{
		// build query
		$query = new DbQuery();
		$query->select('s.editable');
		$query->from('supplier_order_state s');
		$query->where('s.id_supplier_order_state = '.(int)$this->id_supplier_order_state);

		return (Db::getInstance(_PS_USE_SQL_SLAVE_)->getValue($query) == 1);
	}

	/**
	 * Check if the current state allow to generate delivery_note for this order
	 *
	 * @return bool
	 */
	protected function isDeliveryNoteAvailable()
	{
		// build query
		$query = new DbQuery();
		$query->select('s.delivery_note');
		$query->from('supplier_order_state s');
		$query->where('s.id_supplier_order_state = '.(int)$this->id_supplier_order_state);

		return (Db::getInstance(_PS_USE_SQL_SLAVE_)->getValue($query) == 1);
	}

	/**
	 * Check if the current state allow add products in stock
	 *
	 * @return bool
	 */
	protected function isInReceiptState()
	{
		// build query
		$query = new DbQuery();
		$query->select('s.receipt_state');
		$query->from('supplier_order_state s');
		$query->where('s.id_supplier_order_state = '.(int)$this->id_supplier_order_state);

		return (Db::getInstance(_PS_USE_SQL_SLAVE_)->getValue($query) == 1);
	}

	/**
	 * Add order history
	 *
	 * @return bool
	 */
	protected function addHistory()
	{
		$history = new SupplierOrderHistory();
		$history->id_supplier_order = $this->id;
		$history->id_state = $this->id_supplier_order_state;
		$history->id_employee = $this->id_employee;

		$history->save();
	}
}