TheCoreDev/domokits-NEW
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[11/06/2024] Les premières modifs + installation de quelques modules indispensables

Browse Source
This commit is contained in:
TheCoreDev
2024-06-11 14:57:59 +02:00
parent 5ac5653ae5
commit 77cf2c7cc6
1626 changed files with 171457 additions and 131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
domokits/local/modules/CustomDelivery/.github/workflows/release.yml vendored Normal file
View File

@@ -0,0 +1,7 @@
name: "Auto Release"
on:
push:
branches: [ master, main ]
jobs:
release:
uses: thelia-modules/ReusableWorkflow/.github/workflows/auto_release.yml@main

17
domokits/local/modules/CustomDelivery/CHANGELOG.md Normal file
View File

@@ -0,0 +1,17 @@
# 1.0.7
- The dispatcher is now passed to Session::getSessionCart()
# 1.0.3
- Fixed stability tag in module.xml
# 1.0.2
- Removed bootbox dependency
- Added alert when no shipping zones defined
- Better float validation
# 1.0.1
- Resolve #4 Add js dependency bootbox

38
domokits/local/modules/CustomDelivery/Config/config.xml Normal file
View File

@@ -0,0 +1,38 @@
<?xml version="1.0" encoding="UTF-8" ?>
<config xmlns="http://thelia.net/schema/dic/config"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://thelia.net/schema/dic/config http://thelia.net/schema/dic/config/thelia-1.0.xsd">
<loops>
<loop name="custom-delivery-slice" class="CustomDelivery\Loop\CustomDeliverySliceLoop" />
</loops>
<forms>
<form name="customdelivery.configuration.form" class="CustomDelivery\Form\ConfigurationForm" />
<form name="customdelivery.slice.form" class="CustomDelivery\Form\SliceForm" />
</forms>
<services>
<service id="customdelivery.events" class="CustomDelivery\EventListeners\CustomDeliveryEvents" scope="request">
<argument type="service" id="thelia.parser" />
<argument type="service" id="mailer"/>
<tag name="kernel.event_subscriber"/>
</service>
<service id="customdelivery.openapi" class="CustomDelivery\EventListeners\ApiListener" scope="request">
<argument type="service" id="service_container"/>
<argument type="service" id="request_stack"/>
<tag name="kernel.event_subscriber"/>
</service>
</services>
<hooks>
<hook id="customdelivery.hook" class="CustomDelivery\Hook\HookManager" scope="request">
<!-- Back -->
<tag name="hook.event_listener" event="module.configuration" type="back" />
<tag name="hook.event_listener" event="module.config-js" type="back" />
</hook>
</hooks>
</config>

24
domokits/local/modules/CustomDelivery/Config/module.xml Normal file
View File

@@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<module xmlns="http://thelia.net/schema/dic/module"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://thelia.net/schema/dic/module http://thelia.net/schema/dic/module/module-2_1.xsd">
<fullnamespace>CustomDelivery\CustomDelivery</fullnamespace>
<descriptive locale="en_US">
<title>Custom Delivery</title>
</descriptive>
<descriptive locale="fr_FR">
<title>Livraison Personnalisée</title>
</descriptive>
<languages>
<language>en_US</language>
<language>fr_FR</language>
</languages>
<version>3.1.3</version>
<author>
<name>Julien Chanséaume</name>
<email>julien@thelia.net</email>
</author>
<type>delivery</type>
<thelia>2.5.0</thelia>
<stability>prod</stability>
</module>

19
domokits/local/modules/CustomDelivery/Config/routing.xml Normal file
View File

@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/routing http://symfony.com/schema/routing/routing-1.0.xsd">
<route id="customdelivery.admin.update" path="/admin/module/customdelivery/save" methods="post">
<default key="_controller">CustomDelivery\Controller\BackController::saveAction</default>
</route>
<route id="customdelivery.admin.delete" path="/admin/module/customdelivery/delete" methods="post">
<default key="_controller">CustomDelivery\Controller\BackController::deleteAction</default>
</route>
<route id="customdelivery.admin.configuration" path="/admin/module/customdelivery/configuration" methods="post">
<default key="_controller">CustomDelivery\Controller\BackController::saveConfigurationAction</default>
</route>
</routes>

23
domokits/local/modules/CustomDelivery/Config/schema.xml Normal file
View File

@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<database defaultIdMethod="native" name="TheliaMain"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="../../../../core/vendor/propel/propel/resources/xsd/database.xsd" >
<table name="custom_delivery_slice" namespace="CustomDelivery\Model">
<column autoIncrement="true" name="id" primaryKey="true" required="true" type="INTEGER" />
<column name="area_id" type="INTEGER" required="true" />
<column defaultValue="0" name="price_max" type="FLOAT" />
<column defaultValue="0" name="weight_max" type="FLOAT" />
<column defaultValue="0" name="price" type="FLOAT" />
<foreign-key foreignTable="area" name="fk_area_id" onDelete="CASCADE" onUpdate="RESTRICT">
<reference foreign="id" local="area_id" />
</foreign-key>
</table>
<external-schema filename="local/config/schema.xml" referenceOnly="true" />
</database>

2
domokits/local/modules/CustomDelivery/Config/sqldb.map Normal file
View File

@@ -0,0 +1,2 @@
# Sqlfile -> Database map
thelia.sql=thelia

29
domokits/local/modules/CustomDelivery/Config/thelia.sql Normal file
View File

@@ -0,0 +1,29 @@
# This is a fix for InnoDB in MySQL >= 4.1.x
# It "suspends judgement" for fkey relationships until are tables are set.
SET FOREIGN_KEY_CHECKS = 0;
-- ---------------------------------------------------------------------
-- custom_delivery_slice
-- ---------------------------------------------------------------------
DROP TABLE IF EXISTS `custom_delivery_slice`;
CREATE TABLE `custom_delivery_slice`
(
`id` INTEGER NOT NULL AUTO_INCREMENT,
`area_id` INTEGER NOT NULL,
`price_max` FLOAT DEFAULT 0,
`weight_max` FLOAT DEFAULT 0,
`price` FLOAT DEFAULT 0,
PRIMARY KEY (`id`),
INDEX `FI_area_id` (`area_id`),
CONSTRAINT `fk_area_id`
FOREIGN KEY (`area_id`)
REFERENCES `area` (`id`)
ON UPDATE RESTRICT
ON DELETE CASCADE
) ENGINE=InnoDB;
# This restores the fkey checks, after having unset them earlier
SET FOREIGN_KEY_CHECKS = 1;

245
domokits/local/modules/CustomDelivery/Controller/BackController.php Normal file
View File

@@ -0,0 +1,245 @@
<?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 CustomDelivery\Controller;
use CustomDelivery\CustomDelivery;
use CustomDelivery\Model\CustomDeliverySlice;
use CustomDelivery\Model\CustomDeliverySliceQuery;
use Propel\Runtime\Map\TableMap;
use Symfony\Component\HttpFoundation\Response;
use Thelia\Controller\Admin\BaseAdminController;
use Thelia\Core\HttpFoundation\Request;
use Thelia\Core\Security\AccessManager;
use Thelia\Core\Security\Resource\AdminResources;
use Thelia\Core\Template\ParserContext;
use Thelia\Core\Translation\Translator;
use Thelia\Model\ConfigQuery;
use Thelia\Tools\URL;
/**
* Class BackController
* @package CustomDelivery\Controller
* @author Julien Chanséaume <julien@thelia.net>
*/
class BackController extends BaseAdminController
{
protected $currentRouter = 'router.customdelivery';
protected $useFallbackTemplate = true;
/**
* Save slice
*
* @return \Symfony\Component\HttpFoundation\Response
*/
public function saveAction(Request $request)
{
$response = $this->checkAuth([], ['customdelivery'], AccessManager::UPDATE);
if (null !== $response) {
return $response;
}
$this->checkXmlHttpRequest();
$responseData = [
"success" => false,
"message" => '',
"slice" => null
];
$messages = [];
$response = null;
$config = CustomDelivery::getConfig();
try {
if (0 !== $id = (int)$request->get('id', 0)) {
$slice = CustomDeliverySliceQuery::create()->findPk($id);
} else {
$slice = new CustomDeliverySlice();
}
if (0 !== $areaId = (int)$request->get('area', 0)) {
$slice->setAreaId($areaId);
} else {
$messages[] = Translator::getInstance()->trans(
'The area is not valid',
[],
CustomDelivery::MESSAGE_DOMAIN
);
}
if ($config['method'] !== CustomDelivery::METHOD_WEIGHT) {
$priceMax = $this->getFloatVal($request->get('priceMax', 0));
if (0 < $priceMax) {
$slice->setPriceMax($priceMax);
} else {
$messages[] = Translator::getInstance()->trans(
'The price max value is not valid',
[],
CustomDelivery::MESSAGE_DOMAIN
);
}
}
if ($config['method'] !== CustomDelivery::METHOD_PRICE) {
$weightMax = $this->getFloatVal($request->get('weightMax', 0));
if (0 < $weightMax) {
$slice->setWeightMax($weightMax);
} else {
$messages[] = Translator::getInstance()->trans(
'The weight max value is not valid',
[],
CustomDelivery::MESSAGE_DOMAIN
);
}
}
$price = $this->getFloatVal($request->get('price', 0));
if (0 <= $price) {
$slice->setPrice($price);
} else {
$messages[] = Translator::getInstance()->trans(
'The price value is not valid',
[],
CustomDelivery::MESSAGE_DOMAIN
);
}
if (0 === count($messages)) {
$slice->save();
$messages[] = Translator::getInstance()->trans(
'Your slice has been saved',
[],
CustomDelivery::MESSAGE_DOMAIN
);
$responseData['success'] = true;
$responseData['slice'] = $slice->toArray(TableMap::TYPE_STUDLYPHPNAME);
}
} catch (\Exception $e) {
$message[] = $e->getMessage();
}
$responseData['message'] = $messages;
return $this->jsonResponse(json_encode($responseData));
}
protected function getFloatVal($val, $default=-1)
{
if (preg_match("#^([\d.,]+)$#", $val, $match)) {
return (float) str_replace(array('.', ','), array('', '.'), $match[0]);
}
return $default;
}
/**
* Save slice
*
* @return Response
*/
public function deleteAction(Request $request)
{
$response = $this->checkAuth([], ['customdelivery'], AccessManager::DELETE);
if (null !== $response) {
return $response;
}
$this->checkXmlHttpRequest();
$responseData = [
"success" => false,
"message" => '',
"slice" => null
];
$response = null;
try {
if (0 !== $id = (int)$request->get('id', 0)) {
$slice = CustomDeliverySliceQuery::create()->findPk($id);
$slice->delete();
$responseData['success'] = true;
} else {
$responseData['message'] = Translator::getInstance()->trans(
'The slice has not been deleted',
[],
CustomDelivery::MESSAGE_DOMAIN
);
}
} catch (\Exception $e) {
$responseData['message'] = $e->getMessage();
}
return $this->jsonResponse(json_encode($responseData));
}
/**
* Save module configuration
*
* @param ParserContext $parserContext
* @return \Symfony\Component\HttpFoundation\Response
*/
public function saveConfigurationAction()
{
$response = $this->checkAuth([AdminResources::MODULE], ['customdelivery'], AccessManager::UPDATE);
if (null !== $response) {
return $response;
}
$form = $this->createForm('customdelivery.configuration.form');
$message = "";
$response = null;
try {
$vform = $this->validateForm($form);
$data = $vform->getData();
ConfigQuery::write(
CustomDelivery::CONFIG_TRACKING_URL,
$data['url']
);
ConfigQuery::write(
CustomDelivery::CONFIG_PICKING_METHOD,
$data['method']
);
ConfigQuery::write(
CustomDelivery::CONFIG_TAX_RULE_ID,
$data['tax']
);
} catch (\Exception $e) {
$message = $e->getMessage();
}
if ($message) {
$form->setErrorMessage($message);
$this->getParserContext()
->addForm($form)
->setGeneralError($message);
return $this->render(
"module-configure",
["module_code" => CustomDelivery::getModuleCode()]
);
}
return $this->generateRedirect(
URL::getInstance()->absoluteUrl("/admin/module/" . CustomDelivery::getModuleCode())
);
}
}

288
domokits/local/modules/CustomDelivery/CustomDelivery.php Executable file
View File

@@ -0,0 +1,288 @@
<?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 CustomDelivery;
use CustomDelivery\Model\CustomDeliverySlice;
use CustomDelivery\Model\CustomDeliverySliceQuery;
use Propel\Runtime\ActiveQuery\Criteria;
use Propel\Runtime\Connection\ConnectionInterface;
use Thelia\Core\Translation\Translator;
use Thelia\Install\Database;
use Thelia\Model\Base\TaxRuleQuery;
use Thelia\Model\Cart;
use Thelia\Model\ConfigQuery;
use Thelia\Model\Country;
use Thelia\Model\CountryAreaQuery;
use Thelia\Model\Currency;
use Thelia\Model\LangQuery;
use Thelia\Model\Map\CountryAreaTableMap;
use Thelia\Model\Message;
use Thelia\Model\MessageQuery;
use Thelia\Model\OrderPostage;
use Thelia\Model\State;
use Thelia\Module\AbstractDeliveryModuleWithState;
use Thelia\Module\BaseModule;
use Thelia\Module\DeliveryModuleInterface;
use Thelia\Module\Exception\DeliveryException;
use Thelia\TaxEngine\Calculator;
use Thelia\Tools\I18n;
class CustomDelivery extends AbstractDeliveryModuleWithState
{
const MESSAGE_DOMAIN = "customdelivery";
const CONFIG_TRACKING_URL = 'custom_delivery_tracking_url';
const CONFIG_PICKING_METHOD = 'custom_delivery_picking_method';
const CONFIG_TAX_RULE_ID = 'custom_delivery_taxe_rule';
const DEFAULT_TRACKING_URL = '%ID%';
const DEFAULT_PICKING_METHOD = 0;
const METHOD_PRICE_WEIGHT = 0;
const METHOD_PRICE = 1;
const METHOD_WEIGHT = 2;
/** @var Translator */
protected $translator;
public static function getConfig()
{
$config = [
'url' => (
ConfigQuery::read(self::CONFIG_TRACKING_URL, self::DEFAULT_TRACKING_URL)
),
'method' => (
intval(ConfigQuery::read(self::CONFIG_PICKING_METHOD, self::DEFAULT_PICKING_METHOD))
),
'tax' => (
intval(ConfigQuery::read(self::CONFIG_TAX_RULE_ID))
)
];
return $config;
}
public function postActivation(ConnectionInterface $con = null): void
{
if (!$this->getConfigValue('is_initialized', false)) {
$database = new Database($con);
$database->insertSql(null, array(__DIR__ . '/Config/thelia.sql'));
$this->setConfigValue('is_initialized', true);
}
// register config variables
if (null === ConfigQuery::read(self::CONFIG_TRACKING_URL, null)) {
ConfigQuery::write(self::CONFIG_TRACKING_URL, self::DEFAULT_TRACKING_URL);
}
if (null === ConfigQuery::read(self::CONFIG_PICKING_METHOD, null)) {
ConfigQuery::write(self::CONFIG_PICKING_METHOD, self::DEFAULT_PICKING_METHOD);
}
// create new message
if (null === MessageQuery::create()->findOneByName('mail_custom_delivery')) {
$message = new Message();
$message
->setName('mail_custom_delivery')
->setHtmlTemplateFileName('custom-delivery-shipping.html')
->setHtmlLayoutFileName('')
->setTextTemplateFileName('custom-delivery-shipping.txt')
->setTextLayoutFileName('')
->setSecured(0);
$languages = LangQuery::create()->find();
foreach ($languages as $language) {
$locale = $language->getLocale();
$message->setLocale($locale);
$message->setTitle(
$this->trans('Custom delivery shipping message', [], $locale)
);
$message->setSubject(
$this->trans('Your order {$order_ref} has been shipped', [], $locale)
);
}
$message->save();
}
}
/**
* This method is called by the Delivery loop, to check if the current module has to be displayed to the customer.
* Override it to implements your delivery rules/
*
* If you return true, the delivery method will de displayed to the customer
* If you return false, the delivery method will not be displayed
*
* @param Country $country the country to deliver to.
* @param State $state the state to deliver to.
*
* @return boolean
*/
public function isValidDelivery(Country $country, State $state = null)
{
// Retrieve the cart
$cart = $this->getRequest()->getSession()->getSessionCart($this->getDispatcher());
/** @var CustomDeliverySlice $slice */
$slice = $this->getSlicePostage($cart, $country, $state);
return null !== $slice;
}
/**
* Calculate and return delivery price in the shop's default currency
*
* @param Country $country the country to deliver to.
* @param State $state the state to deliver to.
*
* @return OrderPostage the delivery price
* @throws DeliveryException if the postage price cannot be calculated.
*/
public function getPostage(Country $country, State $state = null)
{
$cart = $this->getRequest()->getSession()->getSessionCart($this->getDispatcher());
/** @var CustomDeliverySlice $slice */
$postage = $this->getSlicePostage($cart, $country, $state);
if (null === $postage) {
throw new DeliveryException();
}
return $postage;
}
/**
*
* This method return true if your delivery manages virtual product delivery.
*
* @return bool
*/
public function handleVirtualProductDelivery()
{
return false;
}
protected function trans($id, array $parameters = [], $locale = null)
{
if (null === $this->translator) {
$this->translator = Translator::getInstance();
}
return $this->translator->trans($id, $parameters, CustomDelivery::MESSAGE_DOMAIN, $locale);
}
public function getDeliveryMode()
{
return 'delivery';
}
/**
* If a state is given and has slices, use them.
* If state is given but has no slices, check if the country has slices.
* If the country has slices, use them.
* If the country has no slices, the module is not valid for delivery
*
* @param Cart $cart
* @param Country $country
* @param State $state
* @return OrderPostage|null
*/
protected function getSlicePostage(Cart $cart, Country $country, State $state = null)
{
$config = self::getConfig();
$currency = $cart->getCurrency();
/** @var CustomDeliverySlice $slice */
$slice = null;
if (null !== $state && null !== $areas = CountryAreaQuery::create()
->filterByStateId($state->getId())
->select([CountryAreaTableMap::AREA_ID])
->find()
) {
$slice = $this->getAreaSlice($areas, $cart, $currency, $config);
}
if (null === $slice && null !== $areas = CountryAreaQuery::create()
->filterByCountryId($country->getId())
->filterByStateId(null)
->select([CountryAreaTableMap::AREA_ID])
->find()
) {
$slice = $this->getAreaSlice($areas, $cart, $currency, $config);
}
if ($slice === null) {
return null;
}
return $this->getAreaPostage($slice, $currency, $country, $config);
}
/**
* @param $areas
* @param Cart $cart
* @param Currency $currency
* @param $config
* @return CustomDeliverySlice
*/
protected function getAreaSlice($areas, Cart $cart, Currency $currency, $config)
{
$query = CustomDeliverySliceQuery::create()->filterByAreaId($areas, Criteria::IN);
if ($config['method'] != CustomDelivery::METHOD_PRICE) {
$query->filterByWeightMax($cart->getWeight(), Criteria::GREATER_THAN);
$query->orderByWeightMax(Criteria::ASC);
}
if ($config['method'] != CustomDelivery::METHOD_WEIGHT) {
$total = $cart->getTotalAmount();
// convert amount to the default currency
if (0 == $currency->getByDefault()) {
$total = $total / $currency->getRate();
}
$query->filterByPriceMax($total, Criteria::GREATER_THAN);
$query->orderByPriceMax(Criteria::ASC);
}
return $query->findOne();
}
/**
* @param CustomDeliverySlice $slice
* @param Currency $currency
* @param Country $country
* @param $config
* @return OrderPostage
*/
protected function getAreaPostage(CustomDeliverySlice $slice, Currency $currency, Country $country, $config)
{
if (0 == $currency->getByDefault()) {
$untaxedPostage = $slice->getPrice() * $currency->getRate();
} else {
$untaxedPostage = $slice->getPrice();
}
$untaxedPostage = round($untaxedPostage, 2);
$locale = $this->getRequest()->getSession()->getLang()->getLocale();
return $this->buildOrderPostage($untaxedPostage, $country, $locale, $config['tax']);
}
}

104
domokits/local/modules/CustomDelivery/EventListeners/ApiListener.php Normal file
View File

@@ -0,0 +1,104 @@
<?php
namespace CustomDelivery\EventListeners;
use CustomDelivery\CustomDelivery;
use OpenApi\Events\DeliveryModuleOptionEvent;
use OpenApi\Events\OpenApiEvents;
use OpenApi\Model\Api\DeliveryModuleOption;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpFoundation\RequestStack;
use Thelia\Core\HttpFoundation\Request;
use Thelia\Core\Translation\Translator;
use Thelia\Model\Base\ModuleQuery;
use Thelia\Model\OrderPostage;
use Thelia\Module\Exception\DeliveryException;
class ApiListener implements EventSubscriberInterface
{
/** @var ContainerInterface */
protected $container;
/** @var Request */
protected $request;
/**
* APIListener constructor.
* @param ContainerInterface $container We need the container because we use a service from another module
* which is not mandatory, and using its service without it being installed will crash
*/
public function __construct(
ContainerInterface $container,
RequestStack $requestStack
)
{
$this->container = $container;
$this->request = $requestStack->getCurrentRequest();
}
public function getDeliveryModuleOptions(DeliveryModuleOptionEvent $deliveryModuleOptionEvent)
{
if ($deliveryModuleOptionEvent->getModule()->getId() !== CustomDelivery::getModuleId()) {
return ;
}
$isValid = true;
$postage = null;
$postageTax = null;
$locale = $this->request->getSession()->getLang()->getLocale();
$propelModule = ModuleQuery::create()
->filterById(CustomDelivery::getModuleId())
->findOne()
->setLocale($locale);
try {
$module = $propelModule->getModuleInstance($this->container);
$country = $deliveryModuleOptionEvent->getCountry();
$state = $deliveryModuleOptionEvent->getState();
if (empty($module->isValidDelivery($country, $state))) {
throw new DeliveryException(Translator::getInstance()->trans("Custom delivery is not available"));
}
/** @var OrderPostage $orderPostage */
$orderPostage = $module->getPostage($country, $state);
$postage = $orderPostage->getAmount();
$postageTax = $orderPostage->getAmountTax();
} catch (\Exception $exception) {
$isValid = false;
}
$minimumDeliveryDate = ''; // TODO (calculate delivery date from day of order)
$maximumDeliveryDate = ''; // TODO (calculate delivery date from day of order
/** @var DeliveryModuleOption $deliveryModuleOption */
$deliveryModuleOption = ($this->container->get('open_api.model.factory'))->buildModel('DeliveryModuleOption');
$deliveryModuleOption
->setCode(CustomDelivery::getModuleCode())
->setValid($isValid)
->setTitle($propelModule->getTitle())
->setImage('')
->setMinimumDeliveryDate($minimumDeliveryDate)
->setMaximumDeliveryDate($maximumDeliveryDate)
->setPostage($postage)
->setPostageTax($postageTax)
->setPostageUntaxed($postage - $postageTax)
;
$deliveryModuleOptionEvent->appendDeliveryModuleOptions($deliveryModuleOption);
}
public static function getSubscribedEvents()
{
$listenedEvents = [];
/** Check for old versions of Thelia where the events used by the API didn't exists */
if (class_exists(DeliveryModuleOptionEvent::class)) {
$listenedEvents[OpenApiEvents::MODULE_DELIVERY_GET_OPTIONS] = array("getDeliveryModuleOptions", 129);
}
return $listenedEvents;
}
}

127
domokits/local/modules/CustomDelivery/EventListeners/CustomDeliveryEvents.php Normal file
View File

@@ -0,0 +1,127 @@
<?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 CustomDelivery\EventListeners;
use CustomDelivery\CustomDelivery;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Thelia\Core\Event\Order\OrderEvent;
use Thelia\Core\Event\TheliaEvents;
use Thelia\Core\Template\ParserInterface;
use Thelia\Log\Tlog;
use Thelia\Mailer\MailerFactory;
use Thelia\Model\ConfigQuery;
use Thelia\Model\MessageQuery;
/**
* Class CustomDeliveryEvents
* @package CustomDelivery\EventListeners
* @author Julien Chanséaume <julien@thelia.net>
*/
class CustomDeliveryEvents implements EventSubscriberInterface
{
protected $parser;
protected $mailer;
public function __construct(ParserInterface $parser, MailerFactory $mailer)
{
$this->parser = $parser;
$this->mailer = $mailer;
}
/**
* Returns an array of event names this subscriber wants to listen to.
*
* The array keys are event names and the value can be:
*
* * The method name to call (priority defaults to 0)
* * An array composed of the method name to call and the priority
* * An array of arrays composed of the method names to call and respective
* priorities, or 0 if unset
*
* For instance:
*
* * array('eventName' => 'methodName')
* * array('eventName' => array('methodName', $priority))
* * array('eventName' => array(array('methodName1', $priority), array('methodName2'))
*
* @return array The event names to listen to
*
* @api
*/
public static function getSubscribedEvents()
{
return [
TheliaEvents::ORDER_UPDATE_STATUS => ["updateStatus", 128]
];
}
public function updateStatus(OrderEvent $event)
{
$order = $event->getOrder();
$customDelivery = new CustomDelivery();
if ($order->isSent() && $order->getDeliveryModuleId() == $customDelivery->getModuleModel()->getId()) {
$contactEmail = ConfigQuery::getStoreEmail();
if ($contactEmail) {
$message = MessageQuery::create()
->filterByName('mail_custom_delivery')
->findOne();
if (false === $message) {
throw new \Exception("Failed to load message 'mail_custom_delivery'.");
}
$order = $event->getOrder();
$customer = $order->getCustomer();
$package = $order->getDeliveryRef();
$trackingUrl = null;
if (!empty($package)) {
$config = CustomDelivery::getConfig();
$trackingUrl = $config['url'];
if (!empty($trackingUrl)) {
$trackingUrl = str_replace('%ID%', $package, $trackingUrl);
}
}
$this->mailer->sendEmailMessage(
'mail_custom_delivery',
[$contactEmail => ConfigQuery::getStoreName()],
[$customer->getEmail() => $customer->getFirstname() . " " . $customer->getLastname()],
[
'customer_id' => $customer->getId(),
'order_id' => $order->getId(),
'order_ref' => $order->getRef(),
'order_date' => $order->getCreatedAt(),
'update_date' => $order->getUpdatedAt(),
'package' => $package,
'tracking_url' => $trackingUrl
]
);
Tlog::getInstance()->debug(
"Custom Delivery shipping message sent to customer " . $customer->getEmail()
);
} else {
$customer = $order->getCustomer();
Tlog::getInstance()->debug(
"Custom Delivery shipping message no contact email customer_id ".$customer->getId()
);
}
}
}
}

130
domokits/local/modules/CustomDelivery/Form/ConfigurationForm.php Normal file
View File

@@ -0,0 +1,130 @@
<?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 CustomDelivery\Form;
use CustomDelivery\CustomDelivery;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Validator\Constraints\Callback;
use Symfony\Component\Validator\Constraints\GreaterThanOrEqual;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Context\ExecutionContextInterface;
use Thelia\Core\Form\Type\Field\TaxRuleIdType;
use Thelia\Form\BaseForm;
use Thelia\Model\Base\TaxRuleQuery;
/**
* Class ConfigurationForm
* @author Julien Chanséaume <julien@thelia.net>
*/
class ConfigurationForm extends BaseForm
{
public function checkTaxRuleId($value, ExecutionContextInterface $context)
{
if (0 !== intval($value)) {
if (null === TaxRuleQuery::create()->findPk($value)) {
$context->addViolation(
$this->trans(
"The Tax Rule id '%id' doesn't exist",
[
"%id" => $value,
]
)
);
}
}
}
/**
* @return string the name of you form. This name must be unique
*/
public static function getName()
{
return "customdelivery-configuration-form";
}
protected function buildForm()
{
$form = $this->formBuilder;
$config = CustomDelivery::getConfig();
$form
->add(
"url",
TextType::class,
[
'constraints' => [
new NotBlank()
],
'data' => $config['url'],
'label' => $this->trans("Tracking URL"),
'label_attr' => [
'for' => "url",
'help' => $this->trans(
"The tracking URL. %ID% will be replaced by the tracking number entered in the order"
)
],
]
)
->add(
"method",
ChoiceType::class,
[
'constraints' => [
new NotBlank(),
new GreaterThanOrEqual(['value' => 0])
],
"choices" => [
$this->trans("Price and weight") => CustomDelivery::METHOD_PRICE_WEIGHT,
$this->trans("Price") => CustomDelivery::METHOD_PRICE,
$this->trans("Weight") =>CustomDelivery::METHOD_WEIGHT
],
'data' => $config['method'],
'label' => $this->trans("Method"),
'label_attr' => [
'for' => "method",
'help' => $this->trans(
"The method used to select the right slice."
)
],
]
)
->add(
"tax",
TaxRuleIdType::class,
[
"constraints" => [
new Callback(
[$this, 'checkTaxRuleId']
),
],
'required' => false,
'data' => $config['tax'],
'label' => $this->trans("Tax rule"),
'label_attr' => [
'for' => "method",
'help' => $this->trans(
"The tax rule used to calculate postage taxes."
)
],
]
);
}
protected function trans($id, array $parameters = [])
{
return $this->translator->trans($id, $parameters, CustomDelivery::MESSAGE_DOMAIN);
}
}

92
domokits/local/modules/CustomDelivery/Form/SliceForm.php Normal file
View File

@@ -0,0 +1,92 @@
<?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 CustomDelivery\Form;
use CustomDelivery\CustomDelivery;
use Symfony\Component\Form\Extension\Core\Type\NumberType;
use Symfony\Component\Validator\Constraints\GreaterThanOrEqual;
use Symfony\Component\Validator\Constraints\NotBlank;
use Thelia\Core\Form\Type\Field\AreaIdType;
use Thelia\Form\BaseForm;
use Thelia\Type\FloatType;
/**
* Class SliceForm
* @author Julien Chanséaume <julien@thelia.net>
*/
class SliceForm extends BaseForm
{
/**
* @return string the name of you form. This name must be unique
*/
public static function getName()
{
return "customdelivery-configuration-form";
}
protected function buildForm()
{
$form = $this->formBuilder;
$form
->add(
"id",
NumberType::class,
[
'constraints' => [
new NotBlank()
],
'label' => $this->trans("Id")
]
)
->add(
"area",
AreaIdType::class,
[
'constraints' => [
new NotBlank(),
new GreaterThanOrEqual(['value' => 0])
],
'label' => $this->trans("Area"),
]
)
->add(
"priceMax",
FloatType::class,
[
'constraints' => [
new NotBlank(),
new GreaterThanOrEqual(['value' => 0])
],
'label' => $this->trans("Area"),
]
)
->add(
"weightMax",
FloatType::class,
[
'constraints' => [
new NotBlank(),
new GreaterThanOrEqual(['value' => 0])
],
'label' => $this->trans("Area"),
]
);
}
protected function trans($id, array $parameters = [])
{
return $this->translator->trans($id, $parameters, CustomDelivery::MESSAGE_DOMAIN);
}
}

67
domokits/local/modules/CustomDelivery/Hook/HookManager.php Normal file
View File

@@ -0,0 +1,67 @@
<?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 CustomDelivery\Hook;
use CustomDelivery\CustomDelivery;
use Thelia\Core\Event\Hook\HookRenderEvent;
use Thelia\Core\Hook\BaseHook;
/**
* Class HookManager
* @package CustomDelivery\Hook
* @author Julien Chanséaume <julien@thelia.net>
*/
class HookManager extends BaseHook
{
public function onAccountOrderAfterProducts(HookRenderEvent $event)
{
$orderId = $event->getArgument('order');
if (null !== $orderId) {
$render = $this->render(
'account-order-after-products.html',
[
"order_id" => $orderId
]
);
$event->add($render);
}
$event->stopPropagation();
}
public function onModuleConfiguration(HookRenderEvent $event)
{
$moduleId = $this->getModule()->getModuleId();
$config = CustomDelivery::getConfig();
$event->add(
$this->render(
"module-configuration.html",
[
'module_id' => $moduleId,
'method' => $config['method']
]
)
);
}
public function onModuleConfigJs(HookRenderEvent $event)
{
$event->add(
$this->render("module-config-js.html")
);
}
}

19
domokits/local/modules/CustomDelivery/I18n/backOffice/default/en_US.php Normal file
View File

@@ -0,0 +1,19 @@
<?php
return array(
'Actions' => 'Actions',
'Add this price slice' => 'Add this price slice',
'Area : ' => 'Area : ',
'Configuration.' => 'Configuration.',
'Delete this price slice' => 'Delete this price slice',
'Message' => 'Message',
'No taxes' => 'No taxes',
'Price (%symbol)' => 'Price (%symbol)',
'Save' => 'Save',
'Save this price slice' => 'Save this price slice',
'Slices.' => 'Slices.',
'Untaxed Price up to ... %symbol' => 'Untaxed Price up to ... %symbol',
'Weight up to ... kg' => 'Weight up to ... kg',
'You should first attribute shipping zones to the modules: ' => 'You should first attribute shipping zones to the module: ',
'manage shipping zones' => 'manage shipping zones',
);

19
domokits/local/modules/CustomDelivery/I18n/backOffice/default/fr_FR.php Normal file
View File

@@ -0,0 +1,19 @@
<?php
return array(
'Actions' => 'Actions',
'Add this price slice' => 'Ajouter cette tranche',
'Area : ' => 'Zone :',
'Configuration.' => 'Configuration.',
'Delete this price slice' => 'Supprimer cette tranche',
'Message' => 'Message',
'No taxes' => 'Pas de taxe',
'Price (%symbol)' => 'Prix (%symbol)',
'Save' => 'Enregistrer',
'Save this price slice' => 'Enregistrer cette tranche',
'Slices.' => 'Tranches.',
'Untaxed Price up to ... %symbol' => 'Prix HT jusqu\'à ... %symbol',
'Weight up to ... kg' => 'Poids jusqu\'à ... kg',
'You should first attribute shipping zones to the modules: ' => 'Vous devez d\'abord attribuer des zones de livraisons au module :',
'manage shipping zones' => 'gèrer les zones de livraisons',
);

11
domokits/local/modules/CustomDelivery/I18n/email/default/en_US.php Normal file
View File

@@ -0,0 +1,11 @@
<?php
return array(
'Best Regards.' => 'Best Regards.',
'Dear' => 'Dear',
'Feel free to contact us for any further information' => 'Feel free to contact us for any further information',
'Please check this URL to track your parcel : %tracking_url' => 'Please check this URL to track your parcel : %tracking_url',
'Thank you for your order on our online store %store_name' => 'Thank you for your order on our online store %store_name',
'The tracking number for this delivery is: %package' => 'The tracking number for this delivery is: %package',
'Your order %order_ref dated %order_date has been shipped on %update_date' => 'Your order %order_ref dated %order_date has been shipped on %update_date',
);

11
domokits/local/modules/CustomDelivery/I18n/email/default/fr_FR.php Normal file
View File

@@ -0,0 +1,11 @@
<?php
return array(
'Best Regards.' => 'Cordialement.',
'Dear' => 'Chère',
'Feel free to contact us for any further information' => 'Vous pouvez nous contacter pour toutes informations complémentaires',
'Please check this URL to track your parcel : %tracking_url' => 'Vous pouvez suivre votre colis en ligne à cette adresse : %tracking_url',
'Thank you for your order on our online store %store_name' => 'Merci pour votre commande sur notre boutique en ligne %store_name',
'The tracking number for this delivery is: %package' => 'Le numéro de suivi pour cette commande est: %package',
'Your order %order_ref dated %order_date has been shipped on %update_date' => 'Votre commande %order_ref datée du %order_date a été expédié le %update_date',
);

24
domokits/local/modules/CustomDelivery/I18n/en_US.php Normal file
View File

@@ -0,0 +1,24 @@
<?php
return array(
'Area' => 'Area',
'Custom delivery shipping message' => 'Custom delivery shipping message',
'Id' => 'Id',
'Method' => 'Method',
'Price' => 'Price',
'Price and weight' => 'Price and weight',
'Tax rule' => 'Tax rule',
'The Tax Rule id \'%id\' doesn\'t exist' => 'The Tax Rule id \'%id\' doesn\'t exist',
'The area is not valid' => 'The area is not valid',
'The method used to select the right slice.' => 'The method used to select the right slice.',
'The price max value is not valid' => 'The price max value is not valid',
'The price value is not valid' => 'The price value is not valid',
'The slice has not been deleted' => 'The slice has not been deleted',
'The tax rule used to calculate postage taxes.' => 'The tax rule used to calculate postage taxes.',
'The tracking URL. %ID% will be replaced by the tracking number entered in the order' => 'The tracking URL. %ID% will be replaced by the tracking number entered in the order',
'The weight max value is not valid' => 'The weight max value is not valid',
'Tracking URL' => 'Tracking URL',
'Weight' => 'Weight',
'Your order {$order_ref} has been shipped' => 'Your order {$order_ref} has been shipped',
'Your slice has been saved' => 'Your slice has been saved',
);

24
domokits/local/modules/CustomDelivery/I18n/fr_FR.php Normal file
View File

@@ -0,0 +1,24 @@
<?php
return array(
'Area' => 'Zone',
'Custom delivery shipping message' => 'Message d\'envoi pour la livraison personnalisée',
'Id' => 'Id',
'Method' => 'Méthode',
'Price' => 'Prix',
'Price and weight' => 'Prix et poids',
'Tax rule' => 'Règle de taxe',
'The Tax Rule id \'%id\' doesn\'t exist' => 'La règle de taxe id \'%id\' n\'existe pas',
'The area is not valid' => 'La zone n\'est pas valide',
'The method used to select the right slice.' => 'La méthode utilisée pour sélectionner la bonne tranche.',
'The price max value is not valid' => 'La valeur du prix max n\'est pas valide',
'The price value is not valid' => 'La valeur du prix n\'est pas valide',
'The slice has not been deleted' => 'Votre tranche n\'a pas été supprimé',
'The tax rule used to calculate postage taxes.' => 'La règle de taxe utilisée pour calculer les taxes associés à la livraison.',
'The tracking URL. %ID% will be replaced by the tracking number entered in the order' => 'L\'URL de suivi. %ID% sera remplacé par le numéro de suivi saisi dans la commande',
'The weight max value is not valid' => 'La valeur du poids max n\'est pas valide',
'Tracking URL' => 'URL de suivi',
'Weight' => 'Poids',
'Your order {$order_ref} has been shipped' => 'Votre commande {$order_ref} vient d\'être expédiée',
'Your slice has been saved' => 'Votre tranche a été sauvegardé',
);

166
domokits/local/modules/CustomDelivery/LICENSE Normal file
View File

@@ -0,0 +1,166 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.

168
domokits/local/modules/CustomDelivery/Loop/CustomDeliverySliceLoop.php Normal file
View File

@@ -0,0 +1,168 @@
<?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 CustomDelivery\Loop;
use CustomDelivery\Model\Base\CustomDeliverySliceQuery;
use CustomDelivery\Model\CustomDeliverySlice;
use Propel\Runtime\ActiveQuery\Criteria;
use Thelia\Core\Template\Element\BaseLoop;
use Thelia\Core\Template\Element\LoopResult;
use Thelia\Core\Template\Element\LoopResultRow;
use Thelia\Core\Template\Element\PropelSearchLoopInterface;
use Thelia\Core\Template\Loop\Argument\Argument;
use Thelia\Core\Template\Loop\Argument\ArgumentCollection;
use Thelia\Type\EnumListType;
use Thelia\Type\TypeCollection;
/**
* Class CustomDeliverySlideLoop
* @package CustomDelivery\Loop
* @author Julien Chanséaume <julien@thelia.net>
*/
class CustomDeliverySliceLoop extends BaseLoop implements PropelSearchLoopInterface
{
protected $timestampable = false;
protected $versionable = false;
/**
* @param LoopResult $loopResult
*
* @return LoopResult
*/
public function parseResults(LoopResult $loopResult)
{
/** @var CustomDeliverySlice $slice */
foreach ($loopResult->getResultDataCollection() as $slice) {
$loopResultRow = new LoopResultRow($slice);
$loopResultRow
->set("ID", $slice->getId())
->set("AREA_ID", $slice->getAreaId())
->set("PRICE_MAX", $slice->getPriceMax())
->set("WEIGHT_MAX", $slice->getWeightMax())
->set("PRICE", $slice->getPrice());
$this->addOutputFields($loopResultRow, $slice);
$loopResult->addRow($loopResultRow);
}
return $loopResult;
}
/**
* this method returns a Propel ModelCriteria
*
* @return \Propel\Runtime\ActiveQuery\ModelCriteria
*/
public function buildModelCriteria()
{
$query = CustomDeliverySliceQuery::create();
$id = $this->getArgValue('id');
if (null !== $id) {
$query->filterById($id, Criteria::IN);
}
$id = $this->getArgValue('area_id');
if (null !== $id) {
$query->filterByAreaId($id, Criteria::IN);
}
$orders = $this->getArgValue('order');
foreach ($orders as $order) {
switch ($order) {
case "id":
$query->orderById(Criteria::ASC);
break;
case "id_reverse":
$query->orderById(Criteria::DESC);
break;
case "weight_max":
$query->orderByWeightMax(Criteria::ASC);
break;
case "weight_max_reverse":
$query->orderByWeightMax(Criteria::DESC);
break;
case "price_max":
$query->orderByPriceMax(Criteria::ASC);
break;
case "price_max_reverse":
$query->orderByPriceMax(Criteria::DESC);
break;
case "price":
$query->orderByPrice(Criteria::ASC);
break;
case "price_reverse":
$query->orderByPrice(Criteria::DESC);
break;
}
}
return $query;
}
/**
* Definition of loop arguments
*
* example :
*
* public function getArgDefinitions()
* {
* return new ArgumentCollection(
*
* Argument::createIntListTypeArgument('id'),
* new Argument(
* 'ref',
* new TypeCollection(
* new Type\AlphaNumStringListType()
* )
* ),
* Argument::createIntListTypeArgument('category'),
* Argument::createBooleanTypeArgument('new'),
* ...
* );
* }
*
* @return \Thelia\Core\Template\Loop\Argument\ArgumentCollection
*/
protected function getArgDefinitions()
{
return new ArgumentCollection(
Argument::createIntListTypeArgument('id'),
Argument::createIntListTypeArgument('area_id'),
new Argument(
'order',
new TypeCollection(
new EnumListType(
[
'id',
'id_reverse',
'weight_max',
'weight_max_reverse',
'price_max',
'price_max_reverse',
'price',
'price_reverse',
]
)
),
'id'
)
);
}
}

10
domokits/local/modules/CustomDelivery/Model/CustomDeliverySlice.php Normal file
View File

@@ -0,0 +1,10 @@
<?php
namespace CustomDelivery\Model;
use CustomDelivery\Model\Base\CustomDeliverySlice as BaseCustomDeliverySlice;
class CustomDeliverySlice extends BaseCustomDeliverySlice
{
}

21
domokits/local/modules/CustomDelivery/Model/CustomDeliverySliceQuery.php Normal file
View File

@@ -0,0 +1,21 @@
<?php
namespace CustomDelivery\Model;
use CustomDelivery\Model\Base\CustomDeliverySliceQuery as BaseCustomDeliverySliceQuery;
/**
* Skeleton subclass for performing query and update operations on the 'custom_delivery_slice' table.
*
*
*
* You should add additional methods to this class to meet the
* application requirements. This class will only be generated as
* long as it does not already exist in the output directory.
*
*/
class CustomDeliverySliceQuery extends BaseCustomDeliverySliceQuery
{
} // CustomDeliverySliceQuery

32
domokits/local/modules/CustomDelivery/Readme.md Normal file
View File

@@ -0,0 +1,32 @@
# Custom delivery
With this module, you can use a flat fee for your areas.
This module is compatible with Thelia version 2.1 or greater.
## Installation
### Manually
* Copy the module into ```<thelia_root>/local/modules/``` directory and be sure that the name of the module is CustomDelivery.
* Activate it in your thelia administration panel
### Composer
Add it in your main thelia composer.json file
```
composer require thelia/custom-delivery-module:~1.0
```
## Usage
Just enter the price you want for each area in the configuration page of the module.
You can create as many slices you want. These slices are based on the amount price and/or the weight of an order. You
can associate an optional taxe rule to the module to include taxes for the shipment.
# customization
You can customize the mails sent by the module in the **Mailing templates** configuration page in the back-office. The
template used is called `mail_custom_delivery`.

11
domokits/local/modules/CustomDelivery/composer.json Normal file
View File

@@ -0,0 +1,11 @@
{
"name": "thelia/custom-delivery-module",
"license": "LGPL-3.0+",
"type": "thelia-module",
"require": {
"thelia/installer": "~1.1"
},
"extra": {
"installer-name": "CustomDelivery"
}
}

127
domokits/local/modules/CustomDelivery/templates/backOffice/default/module-config-js.html Normal file
View File

@@ -0,0 +1,127 @@
{javascripts file='assets/js/libs/underscore-min.js'}
<script src="{$asset_url}"></script>
{/javascripts}
<script type="text/javascript">
(function ($) {
var config = {
'urlAdd': '{url path="/admin/module/customdelivery/save"}',
'urlDelete': '{url path="/admin/module/customdelivery/delete"}',
'urlSave': '{url path="/admin/module/customdelivery/save"}'
};
{literal}
$(document).ready(function () {
var tpl = _.template($("#tpl-slice").html());
var showMessage = function showMessage(message) {
$('#custom_delivery_dialog')
.find('.modal-body')
.html(message)
.end()
.modal("show");
};
var getSliceData = function getSliceData($slice) {
var data = {
id: $slice.data("id"),
area: $slice.data("area"),
price: $slice.find(".js-slice-price").first().val(),
priceMax: $slice.find(".js-slice-price-max").first().val(),
weightMax: $slice.find(".js-slice-weight-max").first().val()
};
return data;
};
// add new slice
$('.js-slice-add').on('click', function(){
var $slice = $(this).parents('tr').first();
var data = getSliceData($slice);
$.ajax({
type: "POST",
dataType: 'json',
data: data,
url: config.urlAdd
}).done(function(data, textStatus, jqXHR){
var sliceHtml = '';
if (data.success) {
// reset form
$slice.find('input').val('');
// add slice
sliceHtml = tpl(data.slice);
$(sliceHtml).insertBefore($slice);
} else {
showMessage(data.message.join('<br>'));
}
}).fail(function(jqXHR, textStatus, errorThrown){
showMessage(textStatus);
});
});
// save new slice
$('#slices').on('click', '.js-slice-save', function(){
var $slice = $(this).parents('tr').first();
var data = getSliceData($slice);
$.ajax({
type: "POST",
dataType: 'json',
data: data,
url: config.urlAdd
}).done(function(data, textStatus, jqXHR){
if (!data.success) {
showMessage(data.message.join('<br>'));
} else {
var sliceHtml = tpl(data.slice);
$(sliceHtml).insertBefore($slice);
$slice.remove();
// $slice.find('.js-slice-save').removeClass('btn-success');
}
}).fail(function(jqXHR, textStatus, errorThrown){
showMessage(textStatus);
});
});
$('#slices').on('change', '.js-slice input', function() {
$(this).parents('tr').first().find('.js-slice-save').addClass('btn-success');
});
// delete new slice
$('#slices').on('click', '.js-slice-delete', function(){
var $slice = $(this).parents('tr').first();
var data = getSliceData($slice);
$.ajax({
type: "POST",
dataType: 'json',
data: data,
url: config.urlDelete
}).done(function(data, textStatus, jqXHR){
var sliceHtml = '';
if (data.success) {
$slice.remove();
} else {
showMessage(data.message);
}
}).fail(function(jqXHR, textStatus, errorThrown){
showMessage(textStatus);
});
});
// add new slice
$('.js-slice input').on('change', function(){
});
});
{/literal}
})(jQuery);
</script>

195
domokits/local/modules/CustomDelivery/templates/backOffice/default/module-configuration.html Normal file
View File

@@ -0,0 +1,195 @@
<!-- Configuration -->
<div class="general-block-decorator">
<div class="row">
<div class="col-md-12 title title-without-tabs">
{intl d='customdelivery.bo.default' l='Configuration.'}
</div>
<div class="form-container">
<div class="col-md-12">
{form name="customdelivery.configuration.form"}
<form method="POST" id="customdelivery-form" action="{url path="/admin/module/customdelivery/configuration"}" {form_enctype form=$form} class="clearfix">
{if $form_error_message}<div class="alert alert-danger">{$form_error_message}</div>{/if}
{form_hidden_fields form=$form}
{render_form_field form=$form field="url"}
{render_form_field form=$form field="method"}
{form_field form=$form field="tax"}
<div class="form-group {if $error}has-error{/if}">
<label for="{$label_attr.for}" class="control-label">{$label} : </label>
<select id="{$label_attr.for}" name="{$name}" class="form-control">
<option value="" {if $value == 0}selected="selected"{/if}>{intl l="No taxes" d="customdelivery.bo.default"}</option>
{loop name='tax-rule-admin' type="tax-rule" backend_context="on"}
<option value="{$ID}" {if $value == $ID}selected="selected"{/if}>{$ID}: {$TITLE}</option>
{/loop}
</select>
</div>
{/form_field}
<button type="submit" id="vpg-save" name="customdelivery_save" value="save" class="form-submit-button btn btn-sm btn-default" title="{intl d='customdelivery.bo.default' l='Save'}">{intl d='customdelivery.bo.default' l='Save'}</button>
</form>
{/form}
</div>
</div>
</div>
</div>
<!-- slices -->
{* default currency *}
{loop type="currency" name="default_currency" default_only="1"}
{$currencySymbol=$SYMBOL}
{/loop}
<div class="general-block-decorator">
<div class="row">
<div class="col-md-12 title title-without-tabs">
{intl d='customdelivery.bo.default' l='Slices.'}
</div>
<div id="slices" class="form-container">
{loop type="area" name="area" module_id=$module_id backend_context=true}
{$area_id=$ID}
<div class="col-md-12">
<div class="table-responsive">
<table class="table table-striped table-condensed table-left-aligned">
<caption class="clearfix">
<small>{intl d='customdelivery.bo.default' l="Area : "}</small> {$NAME}
</caption>
<thead>
<tr>
{if $method != 2}<th class="col-md-3">{intl d='customdelivery.bo.default' l="Untaxed Price up to ... %symbol" symbol=$currencySymbol}</th>{/if}
{if $method != 1}<th class="col-md-3">{intl d='customdelivery.bo.default' l="Weight up to ... kg"}</th>{/if}
<th class="col-md-5">{intl d='customdelivery.bo.default' l="Price (%symbol)" symbol=$currencySymbol}</th>
<th class="col-md-1">{intl d='customdelivery.bo.default' l="Actions"}</th>
</tr>
</thead>
<tbody>
{loop type="custom-delivery-slice" name="custom-delivery-slice" area_id=$area_id order="weight_max,price_max" }
<tr class="js-slice" data-area="{$area_id}" data-id="{$ID}">
{if $method != 2}
<th class="col-md-3">
<input type="text" data-field="price-max" class="form-control js-slice-price-max" value="{$PRICE_MAX}" data-old="{$PRICE_MAX}" />
</th>
{/if}
{if $method != 1}
<th class="col-md-3">
<input type="text" data-field="weight-max" class="form-control js-slice-weight-max" value="{$WEIGHT_MAX}" data-old="{$WEIGHT_MAX}" />
</th>
{/if}
<th class="col-md-5">
<input type="text" data-field="price" class="form-control js-slice-price" value="{$PRICE}" data-old="{$PRICE}" />
</th>
<th class="col-md-1">
<div class="btn-group">
{loop type="auth" name="can_change" role="ADMIN" module="customdelivery" access="UPDATE"}
<a class="btn btn-default btn-xs js-slice-save" title="{intl d='customdelivery.bo.default' l='Save this price slice'}">
<span class="glyphicon glyphicon-floppy-disk"></span>
</a>
{/loop}
{loop type="auth" name="can_change" role="ADMIN" module="customdelivery" access="DELETE"}
<a class="btn btn-default btn-xs js-slice-delete" title="{intl d='customdelivery.bo.default' l='Delete this price slice'}" data-id="{$ID}">
<span class="glyphicon glyphicon-trash"></span>
</a>
{/loop}
</div>
</th>
</tr>
{/loop}
{* New slice *}
{loop type="auth" name="can_change" role="ADMIN" module="customdelivery" access="CREATE"}
<tr class="js-slice-new" data-area="{$area_id}" data-id="0">
{if $method != 2}
<th class="col-md-3">
<input type="text" data-field="price-max" class="form-control js-slice-price-max" value="" />
</th>
{/if}
{if $method != 1}
<th class="col-md-3">
<input type="text" data-field="weight-max" class="form-control js-slice-weight-max" value="" />
</th>
{/if}
<th class="col-md-5">
<input type="text" data-field="price" class="form-control js-slice-price" value="" />
</th>
<th class="col-md-1">
<a class="btn btn-default btn-xs js-slice-add" title="{intl d='customdelivery.bo.default' l='Add this price slice'}" >
<span class="glyphicon glyphicon-plus"></span>
</a>
</th>
</tr>
{/loop}
</tbody>
</table>
</div>
</div>
{/loop}
{elseloop rel="area"}
<div class="col-md-12">
<div class="alert alert-warning">
{intl d='customdelivery.bo.default' l="You should first attribute shipping zones to the modules: "}
<a href="{url path="/admin/configuration/shipping_zones/update/$module_id"}">
{intl d='customdelivery.bo.default' l="manage shipping zones"}
</a>
</div>
</div>
{/elseloop}
</div>
</div>
</div>
{include
file = "includes/generic-warning-dialog.html"
dialog_id = "custom_delivery_dialog"
dialog_title = {intl d='customdelivery.bo.default' l="Message"}
dialog_body = ""
}
{* JS Templates *}
<script id="tpl-slice" type="text/html">
<tr class="js-slice" data-area="<%=areaId %>" data-id="<%=id %>">
{if $method != 2}
<th class="col-md-3">
<input type="text" data-field="price-max" class="form-control js-slice-price-max" value="<%=priceMax %>" data-old="<%=priceMax %>" />
</th>
{/if}
{if $method != 1}
<th class="col-md-3">
<input type="text" data-field="weight-max" class="form-control js-slice-weight-max" value="<%=weightMax %>" data-old="<%=weightMax %>" />
</th>
{/if}
<th class="col-md-5">
<input type="text" data-field="price" class="form-control js-slice-price" value="<%=price %>" data-old="<%=price %>" />
</th>
<th class="col-md-1">
<div class="btn-group">
{loop type="auth" name="can_change" role="ADMIN" module="customdelivery" access="UPDATE"}
<a class="btn btn-default btn-xs js-slice-save" title="{intl d='customdelivery.bo.default' l='Save this price slice'}">
<span class="glyphicon glyphicon-floppy-disk"></span>
</a>
{/loop}
{loop type="auth" name="can_change" role="ADMIN" module="customdelivery" access="DELETE"}
<a class="btn btn-default btn-xs js-slice-delete" title="{intl d='customdelivery.bo.default' l='Delete this price slice'}" data-id="<%=id %>">
<span class="glyphicon glyphicon-trash"></span>
</a>
{/loop}
</div>
</th>
</tr>
</script>

17
domokits/local/modules/CustomDelivery/templates/email/default/custom-delivery-shipping.html Normal file
View File

@@ -0,0 +1,17 @@
{default_translation_domain domain="customdelivery.email.default"}
{loop type="customer" name="customer.order" current="false" id="$customer_id" backend_context="1"}
<p>{intl l="Dear" } {$LASTNAME} {$FIRSTNAME},</p>
{/loop}
<p>{intl l="Thank you for your order on our online store %store_name" store_name={config key="store_name"}}</p>
<p>{intl l="Your order %order_ref dated %order_date has been shipped on %update_date" order_ref={$order_ref} order_date={format_date date=$order_date} update_date={format_date date=$update_date}}</p>
{if $package}
<p>{intl l="The tracking number for this delivery is: %package" package={$package}}</p>
{if $tracking_url}
<p>{intl l="Please check this URL to track your parcel : %tracking_url" tracking_url={$tracking_url}}</p>
{/if}
{/if}
<p>{intl l="Feel free to contact us for any further information"}</p>
<p>{intl l="Best Regards."}</p>

18
domokits/local/modules/CustomDelivery/templates/email/default/custom-delivery-shipping.txt Normal file
View File

@@ -0,0 +1,18 @@
{default_translation_domain domain="customdelivery.email.default"}
{loop type="customer" name="customer.order" current="false" id="$customer_id" backend_context="1"}
{intl l="Dear" } {$LASTNAME} {$FIRSTNAME},
{/loop}
{intl l="Thank you for your order on our online store %store_name" store_name={config key="store_name"}}
{intl l="Your order %order_ref dated %order_date has been shipped on %update_date" order_ref={$order_ref} order_date={format_date date=$order_date} update_date={format_date date=$update_date}}
{if $package}
{intl l="The tracking number for this delivery is: %package" package={$package}}
{if $tracking_url}
{intl l="Please check this URL to track your parcel : %tracking_url" tracking_url={$tracking_url}}
{/if}
{/if}
{intl l="Feel free to contact us for any further information"}
{intl l="Best Regards."}