439 lines
16 KiB
PHP
439 lines
16 KiB
PHP
<?php
|
|
/*************************************************************************************/
|
|
/* This file is part of the Thelia package. */
|
|
/* */
|
|
/* Copyright (c) OpenStudio */
|
|
/* email : dev@thelia.net */
|
|
/* web : http://www.thelia.net */
|
|
/* */
|
|
/* For the full copyright and license information, please view the LICENSE.txt */
|
|
/* file that was distributed with this source code. */
|
|
/*************************************************************************************/
|
|
|
|
namespace ChronopostHomeDelivery;
|
|
|
|
use ChronopostHomeDelivery\Config\ChronopostHomeDeliveryConst;
|
|
use ChronopostHomeDelivery\Model\ChronopostHomeDeliveryAreaFreeshippingQuery;
|
|
use ChronopostHomeDelivery\Model\ChronopostHomeDeliveryDeliveryMode;
|
|
use ChronopostHomeDelivery\Model\ChronopostHomeDeliveryDeliveryModeQuery;
|
|
use ChronopostHomeDelivery\Model\ChronopostHomeDeliveryPriceQuery;
|
|
use PDO;
|
|
use Propel\Runtime\ActiveQuery\Criteria;
|
|
use Propel\Runtime\Connection\ConnectionInterface;
|
|
use Propel\Runtime\Propel;
|
|
use Symfony\Component\Filesystem\Filesystem;
|
|
use Thelia\Core\HttpFoundation\Request;
|
|
use Thelia\Core\HttpFoundation\Session\Session;
|
|
use Thelia\Install\Database;
|
|
use Thelia\Model\ConfigQuery;
|
|
use Thelia\Model\Country;
|
|
use Thelia\Model\CountryArea;
|
|
use Thelia\Model\Message;
|
|
use Thelia\Model\MessageQuery;
|
|
use Thelia\Model\ModuleQuery;
|
|
use Thelia\Module\AbstractDeliveryModule;
|
|
use Thelia\Module\BaseModule;
|
|
use Thelia\Module\Exception\DeliveryException;
|
|
|
|
class ChronopostHomeDelivery extends AbstractDeliveryModule
|
|
{
|
|
/** @var string */
|
|
const DOMAIN_NAME = 'chronopostHomeDelivery';
|
|
|
|
const CHRONOPOST_CONFIRMATION_MESSAGE_NAME = 'chronopost_home_delivery_confirmation_message_name';
|
|
|
|
/**
|
|
* @param ConnectionInterface|null $con
|
|
*/
|
|
public function postActivation(ConnectionInterface $con = null)
|
|
{
|
|
try {
|
|
/** Security to not erase user configuration on reactivation */
|
|
ChronopostHomeDeliveryDeliveryModeQuery::create()->findOne();
|
|
ChronopostHomeDeliveryAreaFreeshippingQuery::create()->findOne();
|
|
} catch (\Exception $e) {
|
|
$database = new Database($con->getWrappedConnection());
|
|
$database->insertSql(null, array(__DIR__ . '/Config/thelia.sql'));
|
|
}
|
|
|
|
/** Default config values */
|
|
$defaultConfig = [
|
|
ChronopostHomeDeliveryConst::CHRONOPOST_HOME_DELIVERY_CODE_CLIENT => null,
|
|
ChronopostHomeDeliveryConst::CHRONOPOST_HOME_DELIVERY_PASSWORD => null,
|
|
];
|
|
|
|
/** Defaults the delivery types status as false */
|
|
foreach (ChronopostHomeDeliveryConst::getDeliveryTypesStatusKeys() as $statusKey) {
|
|
$defaultConfig[$statusKey] = false;
|
|
}
|
|
|
|
/** Set the default config values in the DB table if it doesn't exists yet */
|
|
foreach ($defaultConfig as $key => $value) {
|
|
if (null === self::getConfigValue($key, null)) {
|
|
self::setConfigValue($key, $value);
|
|
}
|
|
}
|
|
|
|
/** Set the delivery types as not enabled in the ChronopostHomeDeliveryDeliveryMode table
|
|
* when activating the module for the first time
|
|
*/
|
|
foreach (ChronopostHomeDeliveryConst::CHRONOPOST_HOME_DELIVERY_DELIVERY_CODES as $title => $code) {
|
|
if (null === $this->isDeliveryTypeSet($code)) {
|
|
$this->setDeliveryType($code, $title);
|
|
}
|
|
}
|
|
|
|
if (null === MessageQuery::create()->findOneByName(self::CHRONOPOST_CONFIRMATION_MESSAGE_NAME)) {
|
|
$message = new Message();
|
|
|
|
$message
|
|
->setName(self::CHRONOPOST_CONFIRMATION_MESSAGE_NAME)
|
|
->setHtmlLayoutFileName('order_shipped.html')
|
|
->setTextLayoutFileName('order_shipped.txt')
|
|
->setLocale('en_US')
|
|
->setTitle('Order send confirmation')
|
|
->setSubject('Order send confirmation')
|
|
|
|
->setLocale('fr_FR')
|
|
->setTitle('Confirmation d\'envoi de commande')
|
|
->setSubject('Confirmation d\'envoi de commande')
|
|
|
|
->save()
|
|
;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if a given delivery type exists in the ChronopostHomeDeliveryDeliveryMode table
|
|
*
|
|
* @param $code
|
|
* @return ChronopostHomeDeliveryDeliveryMode
|
|
*/
|
|
public function isDeliveryTypeSet($code)
|
|
{
|
|
return ChronopostHomeDeliveryDeliveryModeQuery::create()->findOneByCode($code);
|
|
}
|
|
|
|
/**
|
|
* Add a delivery type to the ChronopostHomeDeliveryDeliveryMode table
|
|
*
|
|
* @param $code
|
|
* @param $title
|
|
*/
|
|
public function setDeliveryType($code, $title)
|
|
{
|
|
$newDeliveryType = new ChronopostHomeDeliveryDeliveryMode();
|
|
|
|
try {
|
|
$newDeliveryType
|
|
->setCode($code)
|
|
->setTitle($title)
|
|
->setFreeshippingActive(false)
|
|
->setFreeshippingFrom(null)
|
|
->save();
|
|
} catch (\Exception $e) {
|
|
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Verify if the are asked by the user is in the list of areas added to the shipping zones
|
|
*
|
|
* @param Country $country
|
|
* @return bool
|
|
*/
|
|
public function isValidDelivery(Country $country)
|
|
{
|
|
if (empty($this->getAllAreasForCountry($country))) {
|
|
return false;
|
|
}
|
|
|
|
$countryAreas = $country->getCountryAreas();
|
|
$areasArray = [];
|
|
|
|
/** @var CountryArea $countryArea */
|
|
foreach ($countryAreas as $countryArea) {
|
|
$areasArray[] = $countryArea->getAreaId();
|
|
}
|
|
|
|
$prices = ChronopostHomeDeliveryPriceQuery::create()
|
|
->filterByAreaId($areasArray)
|
|
->findOne();
|
|
|
|
$freeShipping = ChronopostHomeDeliveryDeliveryModeQuery::create()
|
|
->findOneByFreeshippingActive(true);
|
|
|
|
/** Check if Chronopost delivers in the asked area */
|
|
if (null !== $prices || null !== $freeShipping) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Return the delivery type of an ongoing order.
|
|
*
|
|
* @param Request|Session $request
|
|
* @return null|string
|
|
*/
|
|
public function getDeliveryType($request)
|
|
{
|
|
$deliveryMode = $request->get('chronopost-home-delivery-delivery-mode');
|
|
|
|
$deliveryCodes = array_change_key_case(ChronopostHomeDeliveryConst::CHRONOPOST_HOME_DELIVERY_DELIVERY_CODES, CASE_LOWER);
|
|
|
|
if ($deliveryMode) {
|
|
return $deliveryCodes[strtolower($deliveryMode)];
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Return the postage price for a given area, cart weight, cart amount, and delivery type
|
|
*
|
|
* @param $areaId
|
|
* @param $weight
|
|
* @param int $cartAmount
|
|
* @param null $deliveryCode
|
|
* @return int
|
|
* @throws \Exception
|
|
*/
|
|
public static function getPostageAmount($areaId, $weight, $cartAmount = 0, $deliveryCode = null)
|
|
{
|
|
if (null === $deliveryType = ChronopostHomeDeliveryDeliveryModeQuery::create()->findOneByCode($deliveryCode)) {
|
|
throw new \Exception("The delivery code given is not supported by the module.");
|
|
}
|
|
|
|
/** Check if freeshipping is activated for this delivery type */
|
|
try {
|
|
$freeShipping = $deliveryType->getFreeshippingActive();
|
|
} catch (\Exception $e) {
|
|
$freeShipping = false;
|
|
}
|
|
|
|
/** Get the total cart price needed to have a free shipping for all areas, if it exists */
|
|
try {
|
|
$freeShippingFrom = $deliveryType->getFreeshippingFrom();
|
|
} catch (\Exception $er) {
|
|
$freeShippingFrom = null;
|
|
}
|
|
|
|
/** Set the initial postage price as 0 */
|
|
$postage = 0;
|
|
|
|
/** If free shipping is enabled, skip and return 0 */
|
|
if (!$freeShipping) {
|
|
|
|
/** If a minimum price for free shipping is defined and the amount of the cart reach this limit, return 0. */
|
|
if (null !== $freeShippingFrom && $freeShippingFrom <= $cartAmount) {
|
|
return $postage;
|
|
}
|
|
|
|
/** Get the minimum price for free shipping in the area of the order */
|
|
$cartAmountFreeShipping = ChronopostHomeDeliveryAreaFreeshippingQuery::create()
|
|
->filterByAreaId($areaId)
|
|
->filterByDeliveryModeId($deliveryType->getId())
|
|
->findOne();
|
|
|
|
if (null !== $cartAmountFreeShipping) {
|
|
$cartAmountFreeShipping = $cartAmountFreeShipping->getCartAmount();
|
|
}
|
|
|
|
/** If the cart price is superior to the minimum price for free shipping in the area of the order,
|
|
* return the postage as free.
|
|
*/
|
|
if ($cartAmountFreeShipping !== null && $cartAmountFreeShipping <= $cartAmount) {
|
|
return 0;
|
|
}
|
|
|
|
/** Search the list of prices and order it in ascending order */
|
|
$areaPrices = ChronopostHomeDeliveryPriceQuery::create()
|
|
->filterByDeliveryModeId($deliveryType->getId())
|
|
->filterByAreaId($areaId)
|
|
->filterByWeightMax($weight, Criteria::GREATER_EQUAL)
|
|
->_or()
|
|
->filterByWeightMax(null)
|
|
->filterByPriceMax($cartAmount, Criteria::GREATER_EQUAL)
|
|
->_or()
|
|
->filterByPriceMax(null)
|
|
->orderByWeightMax()
|
|
->orderByPriceMax();
|
|
|
|
/** Find the correct postage price for the cart weight and price according to the area and delivery mode in $areaPrices*/
|
|
$firstPrice = $areaPrices
|
|
->find()
|
|
->getFirst()
|
|
;
|
|
|
|
/** If no price was found, return null */
|
|
if (null === $firstPrice) {
|
|
return null;
|
|
}
|
|
|
|
$postage = $firstPrice->getPrice();
|
|
}
|
|
|
|
return $postage;
|
|
}
|
|
|
|
/**
|
|
* Return the minimum postage price of a list of areas, for a given cart weight, price, and delivery type.
|
|
*
|
|
* @param $areaIdArray
|
|
* @param $cartWeight
|
|
* @param $cartAmount
|
|
* @param $deliveryType
|
|
* @return int|null
|
|
*/
|
|
public function getMinPostage($areaIdArray, $cartWeight, $cartAmount, $deliveryType)
|
|
{
|
|
$minPostage = null;
|
|
|
|
foreach ($areaIdArray as $areaId) {
|
|
try {
|
|
$postage = self::getPostageAmount($areaId, $cartWeight, $cartAmount, $deliveryType);
|
|
if (null === $postage) {
|
|
continue ;
|
|
}
|
|
if ($minPostage === null || $postage < $minPostage) {
|
|
$minPostage = $postage;
|
|
if ($minPostage === 0) {
|
|
break;
|
|
}
|
|
}
|
|
} catch (\Exception $ex) {
|
|
throw new DeliveryException($ex->getMessage()); //todo : Make a better catch, duh
|
|
}
|
|
}
|
|
|
|
return $minPostage;
|
|
}
|
|
|
|
/**
|
|
* Return an array of the codes of all delivery types that have been activated
|
|
* in the backOffice configuration page.
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function getActivatedDeliveryTypes()
|
|
{
|
|
$config = ChronopostHomeDeliveryConst::getConfig();
|
|
$deliveryTypes = ChronopostHomeDeliveryConst::CHRONOPOST_HOME_DELIVERY_DELIVERY_CODES;
|
|
$activatedDeliveryTypes = [];
|
|
|
|
foreach (ChronopostHomeDeliveryConst::getDeliveryTypesStatusKeys() as $deliveryTypeName => $statusKey) {
|
|
if (true === (bool)$config[$statusKey]) {
|
|
$activatedDeliveryTypes[] = $deliveryTypes[$deliveryTypeName];
|
|
}
|
|
}
|
|
|
|
return $activatedDeliveryTypes;
|
|
}
|
|
|
|
/**
|
|
* Return the postage of an ongoing order, or the minimum expected postage before the user chooses what delivery types he wants.
|
|
*
|
|
* @param Country $country
|
|
* @return float|int|\Thelia\Model\OrderPostage
|
|
* @throws \Propel\Runtime\Exception\PropelException
|
|
*/
|
|
public function getPostage(Country $country)
|
|
{
|
|
$request = $this->getRequest();
|
|
|
|
$cartWeight = $request->getSession()->getSessionCart($this->getDispatcher())->getWeight();
|
|
$cartAmount = $request->getSession()->getSessionCart($this->getDispatcher())->getTaxedAmount($country);
|
|
|
|
|
|
/** Get the delivery type of an ongoing order by looking at the request */
|
|
$deliveryType = $this->getDeliveryType($request);
|
|
|
|
/** If no delivery type was found, search again in the session. */
|
|
if (null === $deliveryType) {
|
|
$deliveryType = $this->getDeliveryType($request->getSession());
|
|
}
|
|
|
|
$deliveryArray[] = $deliveryType;
|
|
|
|
/** If still no delivery type is found, create an array of all activated delivery types to search
|
|
* which one has the lowest delivery price.
|
|
*/
|
|
if (null === $deliveryType) {
|
|
$deliveryArray = $this->getActivatedDeliveryTypes();
|
|
}
|
|
|
|
/** Check what areas are covered in the shipping zones defined by the admin */
|
|
$areaIdArray = $this->getAllAreasForCountry($country);
|
|
if (empty($areaIdArray)) {
|
|
throw new DeliveryException("Your delivery country is not covered by Chronopost");
|
|
}
|
|
|
|
$postage = null;
|
|
|
|
/** If no delivery type was given, the loop should continue until the postage for each delivery types was
|
|
* found, then return the minimum one. Otherwise, the loop should stop after the first iteration.
|
|
*/
|
|
if ($deliveryArray !== null) {
|
|
$y = 0;
|
|
$postage = $this->getMinPostage($areaIdArray, $cartWeight, $cartAmount, $deliveryArray[$y]);
|
|
|
|
while (isset($deliveryArray[$y]) && !empty($deliveryArray[$y]) && null !== $deliveryArray[$y]) {
|
|
if (($postage > ($minPost = $this->getMinPostage($areaIdArray, $cartWeight, $cartAmount, $deliveryArray[$y])) || $postage === null)
|
|
&& $minPost !== null
|
|
) {
|
|
$postage = $minPost;
|
|
}
|
|
$y++;
|
|
}
|
|
}
|
|
|
|
/** If no postage was found, we throw an exception */
|
|
if (null === $postage) {
|
|
throw new DeliveryException("Chronopost delivery unavailable for your cart weight or delivery country");
|
|
}
|
|
|
|
/** Get the postage for the shipping zones we've just got */
|
|
|
|
///** If delivery is free, set it to a minimal number so the price will still appear. It will be rounded up to 0 */
|
|
//if (0 == $postage) {
|
|
// $postage = 0.000001;
|
|
//}
|
|
|
|
return (float)$postage;
|
|
}
|
|
|
|
/**
|
|
* Returns ids of area containing this country and covers by this module
|
|
* @param Country $country
|
|
* @return array Area ids
|
|
*/
|
|
public function getAllAreasForCountry(Country $country)
|
|
{
|
|
$areaArray = [];
|
|
|
|
$sql = "SELECT ca.area_id as area_id FROM country_area ca
|
|
INNER JOIN area_delivery_module adm ON (ca.area_id = adm.area_id AND adm.delivery_module_id = :p0)
|
|
WHERE ca.country_id = :p1";
|
|
|
|
$con = Propel::getConnection();
|
|
|
|
$stmt = $con->prepare($sql);
|
|
$stmt->bindValue(':p0', $this->getModuleModel()->getId(), PDO::PARAM_INT);
|
|
$stmt->bindValue(':p1', $country->getId(), PDO::PARAM_INT);
|
|
$stmt->execute();
|
|
|
|
while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
|
|
$areaArray[] = $row['area_id'];
|
|
}
|
|
|
|
return $areaArray;
|
|
}
|
|
|
|
public function getDeliveryMode()
|
|
{
|
|
return "delivery";
|
|
}
|
|
}
|