368 lines
10 KiB
PHP
368 lines
10 KiB
PHP
<?php
|
|
|
|
namespace Thelia\Model;
|
|
|
|
use Propel\Runtime\ActiveQuery\Criteria;
|
|
use Propel\Runtime\Connection\ConnectionInterface;
|
|
use Thelia\Core\Event\Order\OrderEvent;
|
|
use Thelia\Core\Event\TheliaEvents;
|
|
use Thelia\Model\Map\OrderProductTableMap;
|
|
use Thelia\Model\Map\OrderProductTaxTableMap;
|
|
use Thelia\Model\Base\Order as BaseOrder;
|
|
use Thelia\Model\Tools\ModelEventDispatcherTrait;
|
|
use Thelia\TaxEngine\Calculator;
|
|
|
|
class Order extends BaseOrder
|
|
{
|
|
use ModelEventDispatcherTrait;
|
|
|
|
/** @var int|null */
|
|
protected $choosenDeliveryAddress = null;
|
|
/** @var int|null */
|
|
protected $choosenInvoiceAddress = null;
|
|
|
|
protected $disableVersioning = false;
|
|
|
|
/**
|
|
* @param int $choosenDeliveryAddress the choosen delivery address ID
|
|
* @return $this
|
|
*/
|
|
public function setChoosenDeliveryAddress($choosenDeliveryAddress)
|
|
{
|
|
$this->choosenDeliveryAddress = $choosenDeliveryAddress;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param boolean $disableVersioning
|
|
* @return $this
|
|
*/
|
|
public function setDisableVersioning($disableVersioning)
|
|
{
|
|
$this->disableVersioning = (bool) $disableVersioning;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function isVersioningDisable()
|
|
{
|
|
return $this->disableVersioning;
|
|
}
|
|
|
|
public function isVersioningNecessary($con = null)
|
|
{
|
|
if ($this->isVersioningDisable()) {
|
|
return false;
|
|
} else {
|
|
return parent::isVersioningNecessary($con);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return int|null the choosen delivery address ID
|
|
*/
|
|
public function getChoosenDeliveryAddress()
|
|
{
|
|
return $this->choosenDeliveryAddress;
|
|
}
|
|
|
|
/**
|
|
* @param int $choosenInvoiceAddress the choosen invoice address
|
|
* @return $this
|
|
*/
|
|
public function setChoosenInvoiceAddress($choosenInvoiceAddress)
|
|
{
|
|
$this->choosenInvoiceAddress = $choosenInvoiceAddress;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return int|null the choosen invoice address ID
|
|
*/
|
|
public function getChoosenInvoiceAddress()
|
|
{
|
|
return $this->choosenInvoiceAddress;
|
|
}
|
|
|
|
public function preSave(ConnectionInterface $con = null)
|
|
{
|
|
if ($this->isPaid(false) && null === $this->getInvoiceDate()) {
|
|
$this
|
|
->setInvoiceDate(time());
|
|
}
|
|
|
|
return parent::preSave($con);
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function preInsert(ConnectionInterface $con = null)
|
|
{
|
|
$this->dispatchEvent(TheliaEvents::ORDER_BEFORE_CREATE, new OrderEvent($this));
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function postInsert(ConnectionInterface $con = null)
|
|
{
|
|
$this->setRef($this->generateRef())
|
|
->setDisableVersioning(true)
|
|
->save($con);
|
|
$this->dispatchEvent(TheliaEvents::ORDER_AFTER_CREATE, new OrderEvent($this));
|
|
}
|
|
|
|
public function generateRef()
|
|
{
|
|
return sprintf('ORD%s', str_pad($this->getId(), 12, 0, STR_PAD_LEFT));
|
|
}
|
|
|
|
/**
|
|
* Compute this order amount.
|
|
*
|
|
* The order amount is only available once the order is persisted in database.
|
|
* During invoice process, use all cart methods instead of order methods (the order doest not exists at this moment)
|
|
*
|
|
* @param float|int $tax (output only) returns the tax amount for this order
|
|
* @param bool $includePostage if true, the postage cost is included to the total
|
|
* @param bool $includeDiscount if true, the discount will be included to the total
|
|
* @return float
|
|
*/
|
|
public function getTotalAmount(&$tax = 0, $includePostage = true, $includeDiscount = true)
|
|
{
|
|
$orderInfo = OrderProductQuery::create()
|
|
->filterByOrderId($this->getId())
|
|
->leftJoinOrderProductTax()
|
|
->withColumn('SUM(
|
|
' . OrderProductTableMap::QUANTITY . '
|
|
* IF('.OrderProductTableMap::WAS_IN_PROMO.' = 1, '.OrderProductTaxTableMap::PROMO_AMOUNT.', '.OrderProductTaxTableMap::AMOUNT.')
|
|
)', 'total_tax')
|
|
->withColumn('SUM(
|
|
' . OrderProductTableMap::QUANTITY . '
|
|
* IF('.OrderProductTableMap::WAS_IN_PROMO.' = 1, '.OrderProductTableMap::PROMO_PRICE.', '.OrderProductTableMap::PRICE.')
|
|
)', 'total_amount')
|
|
->select([ 'total_tax', 'total_amount' ])
|
|
->findOne();
|
|
|
|
$tax = $orderInfo['total_tax'];
|
|
$amount = $orderInfo['total_amount'];
|
|
|
|
$total = $amount + $tax;
|
|
|
|
// @todo : manage discount : free postage ?
|
|
if (true === $includeDiscount) {
|
|
$total -= $this->getDiscount();
|
|
|
|
if ($total<0) {
|
|
$total = 0;
|
|
} else {
|
|
$total = round($total, 2);
|
|
}
|
|
}
|
|
|
|
if (false !== $includePostage) {
|
|
$total += $this->getPostage();
|
|
$tax += $this->getPostageTax();
|
|
}
|
|
|
|
return $total;
|
|
}
|
|
|
|
/**
|
|
* Compute this order weight.
|
|
*
|
|
* The order weight is only available once the order is persisted in database.
|
|
* During invoice process, use all cart methods instead of order methods (the order doest not exists at this moment)
|
|
*
|
|
* @return float
|
|
*/
|
|
public function getWeight()
|
|
{
|
|
$weight = 0;
|
|
|
|
/* browse all products */
|
|
foreach ($this->getOrderProducts() as $orderProduct) {
|
|
$weight += $orderProduct->getQuantity() * (double)$orderProduct->getWeight();
|
|
}
|
|
|
|
return $weight;
|
|
}
|
|
|
|
/**
|
|
* Return the postage without tax
|
|
* @return float|int
|
|
*/
|
|
public function getUntaxedPostage()
|
|
{
|
|
if (0 < $this->getPostageTax()) {
|
|
$untaxedPostage = round($this->getPostage() - $this->getPostageTax(), 2);
|
|
} else {
|
|
$untaxedPostage = $this->getPostage();
|
|
}
|
|
|
|
return $untaxedPostage;
|
|
}
|
|
|
|
/**
|
|
* Check if the current order contains at less 1 virtual product with a file to download
|
|
*
|
|
* @return bool true if this order have at less 1 file to download, false otherwise.
|
|
*/
|
|
public function hasVirtualProduct()
|
|
{
|
|
$virtualProductCount = OrderProductQuery::create()
|
|
->filterByOrderId($this->getId())
|
|
->filterByVirtual(1, Criteria::EQUAL)
|
|
->count()
|
|
;
|
|
|
|
return ($virtualProductCount !== 0);
|
|
}
|
|
|
|
/**
|
|
* Set the status of the current order to NOT PAID
|
|
*/
|
|
public function setNotPaid()
|
|
{
|
|
$this->setStatusHelper(OrderStatus::CODE_NOT_PAID);
|
|
}
|
|
|
|
/**
|
|
* Check if the current status of this order is NOT PAID
|
|
*
|
|
* @return bool true if this order is NOT PAID, false otherwise.
|
|
*/
|
|
public function isNotPaid()
|
|
{
|
|
return $this->hasStatusHelper(OrderStatus::CODE_NOT_PAID);
|
|
}
|
|
|
|
/**
|
|
* Set the status of the current order to PAID
|
|
*/
|
|
public function setPaid()
|
|
{
|
|
$this->setStatusHelper(OrderStatus::CODE_PAID);
|
|
}
|
|
|
|
/**
|
|
* Check if the current status of this order is PAID
|
|
*
|
|
* @param bool $exact if true, the method will check if the current status is exactly OrderStatus::CODE_PAID.
|
|
* if false, it will check if the order has been paid, whatever the current status is. The default is true.
|
|
* @return bool true if this order is PAID, false otherwise.
|
|
*/
|
|
public function isPaid($exact = true)
|
|
{
|
|
return $this->hasStatusHelper(
|
|
$exact ?
|
|
OrderStatus::CODE_PAID :
|
|
[ OrderStatus::CODE_PAID, OrderStatus::CODE_PROCESSING, OrderStatus::CODE_SENT ]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Set the status of the current order to PROCESSING
|
|
*/
|
|
public function setProcessing()
|
|
{
|
|
$this->setStatusHelper(OrderStatus::CODE_PROCESSING);
|
|
}
|
|
|
|
/**
|
|
* Check if the current status of this order is PROCESSING
|
|
*
|
|
* @return bool true if this order is PROCESSING, false otherwise.
|
|
*/
|
|
public function isProcessing()
|
|
{
|
|
return $this->hasStatusHelper(OrderStatus::CODE_PROCESSING);
|
|
}
|
|
|
|
/**
|
|
* Set the status of the current order to SENT
|
|
*/
|
|
public function setSent()
|
|
{
|
|
$this->setStatusHelper(OrderStatus::CODE_SENT);
|
|
}
|
|
|
|
/**
|
|
* Check if the current status of this order is SENT
|
|
*
|
|
* @return bool true if this order is SENT, false otherwise.
|
|
*/
|
|
public function isSent()
|
|
{
|
|
return $this->hasStatusHelper(OrderStatus::CODE_SENT);
|
|
}
|
|
|
|
/**
|
|
* Set the status of the current order to CANCELED
|
|
*/
|
|
public function setCancelled()
|
|
{
|
|
$this->setStatusHelper(OrderStatus::CODE_CANCELED);
|
|
}
|
|
|
|
/**
|
|
* Check if the current status of this order is CANCELED
|
|
*
|
|
* @return bool true if this order is CANCELED, false otherwise.
|
|
*/
|
|
public function isCancelled()
|
|
{
|
|
return $this->hasStatusHelper(OrderStatus::CODE_CANCELED);
|
|
}
|
|
|
|
/**
|
|
* Set the status of the current order to REFUNDED
|
|
*/
|
|
public function setRefunded()
|
|
{
|
|
$this->setStatusHelper(OrderStatus::CODE_REFUNDED);
|
|
}
|
|
|
|
/**
|
|
* Check if the current status of this order is REFUNDED
|
|
*
|
|
* @return bool true if this order is REFUNDED, false otherwise.
|
|
*/
|
|
public function isRefunded()
|
|
{
|
|
return $this->hasStatusHelper(OrderStatus::CODE_REFUNDED);
|
|
}
|
|
|
|
/**
|
|
* Set the status of the current order to the provided status
|
|
*
|
|
* @param string $statusCode the status code, one of OrderStatus::CODE_xxx constants.
|
|
*/
|
|
public function setStatusHelper($statusCode)
|
|
{
|
|
if (null !== $ordeStatus = OrderStatusQuery::create()->findOneByCode($statusCode)) {
|
|
$this->setOrderStatus($ordeStatus)->save();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if the current status of this order is $statusCode or, if $statusCode is an array, if the current
|
|
* status is in the $statusCode array.
|
|
*
|
|
* @param string|array $statusCode the status code, one of OrderStatus::CODE_xxx constants.
|
|
* @return bool true if this order have the provided status, false otherwise.
|
|
*/
|
|
public function hasStatusHelper($statusCode)
|
|
{
|
|
if (is_array($statusCode)) {
|
|
return in_array($this->getOrderStatus()->getCode(), $statusCode);
|
|
} else {return $this->getOrderStatus()->getCode() == $statusCode;
|
|
}
|
|
}
|
|
}
|