From 4e8ac75bad9060996a4033e02b61cde9031757f9 Mon Sep 17 00:00:00 2001 From: TheCoreDev Date: Fri, 8 Dec 2023 16:24:23 +0100 Subject: [PATCH] Ajout du module CustomDelivery v 1.0.7 (avant le AbstractDeliveryModuleWithState) --- local/modules/CustomDelivery/CHANGELOG.md | 17 + .../modules/CustomDelivery/Config/config.xml | 33 + .../modules/CustomDelivery/Config/module.xml | 24 + .../modules/CustomDelivery/Config/routing.xml | 19 + .../modules/CustomDelivery/Config/schema.xml | 23 + local/modules/CustomDelivery/Config/sqldb.map | 2 + .../modules/CustomDelivery/Config/thelia.sql | 29 + .../Controller/BackController.php | 251 +++ .../modules/CustomDelivery/CustomDelivery.php | 279 ++++ .../EventListeners/CustomDeliveryEvents.php | 135 ++ .../CustomDelivery/Form/ConfigurationForm.php | 130 ++ .../modules/CustomDelivery/Form/SliceForm.php | 92 ++ .../CustomDelivery/Hook/HookManager.php | 67 + .../I18n/backOffice/default/en_US.php | 19 + .../I18n/backOffice/default/fr_FR.php | 19 + .../I18n/email/default/en_US.php | 11 + .../I18n/email/default/fr_FR.php | 11 + local/modules/CustomDelivery/I18n/en_US.php | 24 + local/modules/CustomDelivery/I18n/fr_FR.php | 24 + local/modules/CustomDelivery/LICENSE | 166 ++ .../Loop/CustomDeliverySliceLoop.php | 168 ++ .../Model/Base/CustomDeliverySlice.php | 1400 +++++++++++++++++ .../Model/Base/CustomDeliverySliceQuery.php | 609 +++++++ .../Model/CustomDeliverySlice.php | 10 + .../Model/CustomDeliverySliceQuery.php | 21 + .../Model/Map/CustomDeliverySliceTableMap.php | 435 +++++ local/modules/CustomDelivery/Readme.md | 32 + local/modules/CustomDelivery/composer.json | 11 + .../backOffice/default/configuration.html | 195 +++ .../backOffice/default/module-config-js.html | 127 ++ .../default/custom-delivery-shipping.html | 17 + .../default/custom-delivery-shipping.txt | 18 + 32 files changed, 4418 insertions(+) create mode 100644 local/modules/CustomDelivery/CHANGELOG.md create mode 100644 local/modules/CustomDelivery/Config/config.xml create mode 100644 local/modules/CustomDelivery/Config/module.xml create mode 100644 local/modules/CustomDelivery/Config/routing.xml create mode 100644 local/modules/CustomDelivery/Config/schema.xml create mode 100644 local/modules/CustomDelivery/Config/sqldb.map create mode 100644 local/modules/CustomDelivery/Config/thelia.sql create mode 100644 local/modules/CustomDelivery/Controller/BackController.php create mode 100644 local/modules/CustomDelivery/CustomDelivery.php create mode 100644 local/modules/CustomDelivery/EventListeners/CustomDeliveryEvents.php create mode 100644 local/modules/CustomDelivery/Form/ConfigurationForm.php create mode 100644 local/modules/CustomDelivery/Form/SliceForm.php create mode 100644 local/modules/CustomDelivery/Hook/HookManager.php create mode 100644 local/modules/CustomDelivery/I18n/backOffice/default/en_US.php create mode 100644 local/modules/CustomDelivery/I18n/backOffice/default/fr_FR.php create mode 100644 local/modules/CustomDelivery/I18n/email/default/en_US.php create mode 100644 local/modules/CustomDelivery/I18n/email/default/fr_FR.php create mode 100644 local/modules/CustomDelivery/I18n/en_US.php create mode 100644 local/modules/CustomDelivery/I18n/fr_FR.php create mode 100644 local/modules/CustomDelivery/LICENSE create mode 100644 local/modules/CustomDelivery/Loop/CustomDeliverySliceLoop.php create mode 100644 local/modules/CustomDelivery/Model/Base/CustomDeliverySlice.php create mode 100644 local/modules/CustomDelivery/Model/Base/CustomDeliverySliceQuery.php create mode 100644 local/modules/CustomDelivery/Model/CustomDeliverySlice.php create mode 100644 local/modules/CustomDelivery/Model/CustomDeliverySliceQuery.php create mode 100644 local/modules/CustomDelivery/Model/Map/CustomDeliverySliceTableMap.php create mode 100644 local/modules/CustomDelivery/Readme.md create mode 100644 local/modules/CustomDelivery/composer.json create mode 100644 local/modules/CustomDelivery/templates/backOffice/default/configuration.html create mode 100644 local/modules/CustomDelivery/templates/backOffice/default/module-config-js.html create mode 100644 local/modules/CustomDelivery/templates/email/default/custom-delivery-shipping.html create mode 100644 local/modules/CustomDelivery/templates/email/default/custom-delivery-shipping.txt diff --git a/local/modules/CustomDelivery/CHANGELOG.md b/local/modules/CustomDelivery/CHANGELOG.md new file mode 100644 index 00000000..c9970d4d --- /dev/null +++ b/local/modules/CustomDelivery/CHANGELOG.md @@ -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 diff --git a/local/modules/CustomDelivery/Config/config.xml b/local/modules/CustomDelivery/Config/config.xml new file mode 100644 index 00000000..c1a2f573 --- /dev/null +++ b/local/modules/CustomDelivery/Config/config.xml @@ -0,0 +1,33 @@ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + diff --git a/local/modules/CustomDelivery/Config/module.xml b/local/modules/CustomDelivery/Config/module.xml new file mode 100644 index 00000000..820bcfca --- /dev/null +++ b/local/modules/CustomDelivery/Config/module.xml @@ -0,0 +1,24 @@ + + + CustomDelivery\CustomDelivery + + Custom Delivery + + + Livraison Personnalisée + + + en_US + fr_FR + + 1.0.7 + + Julien Chanséaume + julien@thelia.net + + delivery + 2.1.0 + prod + diff --git a/local/modules/CustomDelivery/Config/routing.xml b/local/modules/CustomDelivery/Config/routing.xml new file mode 100644 index 00000000..413e2b82 --- /dev/null +++ b/local/modules/CustomDelivery/Config/routing.xml @@ -0,0 +1,19 @@ + + + + + + CustomDelivery\Controller\BackController::saveAction + + + + CustomDelivery\Controller\BackController::deleteAction + + + + CustomDelivery\Controller\BackController::saveConfigurationAction + + + diff --git a/local/modules/CustomDelivery/Config/schema.xml b/local/modules/CustomDelivery/Config/schema.xml new file mode 100644 index 00000000..7ce19812 --- /dev/null +++ b/local/modules/CustomDelivery/Config/schema.xml @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + +
+ + + diff --git a/local/modules/CustomDelivery/Config/sqldb.map b/local/modules/CustomDelivery/Config/sqldb.map new file mode 100644 index 00000000..63a93baa --- /dev/null +++ b/local/modules/CustomDelivery/Config/sqldb.map @@ -0,0 +1,2 @@ +# Sqlfile -> Database map +thelia.sql=thelia diff --git a/local/modules/CustomDelivery/Config/thelia.sql b/local/modules/CustomDelivery/Config/thelia.sql new file mode 100644 index 00000000..298b2938 --- /dev/null +++ b/local/modules/CustomDelivery/Config/thelia.sql @@ -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; diff --git a/local/modules/CustomDelivery/Controller/BackController.php b/local/modules/CustomDelivery/Controller/BackController.php new file mode 100644 index 00000000..0e60fa12 --- /dev/null +++ b/local/modules/CustomDelivery/Controller/BackController.php @@ -0,0 +1,251 @@ + + */ +class BackController extends BaseAdminController +{ + protected $currentRouter = 'router.customdelivery'; + + protected $useFallbackTemplate = true; + + /** + * Save slice + * + * @return \Symfony\Component\HttpFoundation\RedirectResponse + */ + public function saveAction() + { + $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 { + $requestData = $this->getRequest()->request; + + if (0 !== $id = intval($requestData->get('id', 0))) { + $slice = CustomDeliverySliceQuery::create()->findPk($id); + } else { + $slice = new CustomDeliverySlice(); + } + + if (0 !== $areaId = intval($requestData->get('area', 0))) { + $slice->setAreaId($areaId); + } else { + $messages[] = $this->getTranslator()->trans( + 'The area is not valid', + [], + CustomDelivery::MESSAGE_DOMAIN + ); + } + + if ($config['method'] != CustomDelivery::METHOD_WEIGHT) { + $priceMax = $this->getFloatVal($requestData->get('priceMax', 0)); + if (0 < $priceMax) { + $slice->setPriceMax($priceMax); + } else { + $messages[] = $this->getTranslator()->trans( + 'The price max value is not valid', + [], + CustomDelivery::MESSAGE_DOMAIN + ); + } + } + + if ($config['method'] != CustomDelivery::METHOD_PRICE) { + $weightMax = $this->getFloatVal($requestData->get('weightMax', 0)); + if (0 < $weightMax) { + $slice->setWeightMax($weightMax); + } else { + $messages[] = $this->getTranslator()->trans( + 'The weight max value is not valid', + [], + CustomDelivery::MESSAGE_DOMAIN + ); + } + } + + $price = $this->getFloatVal($requestData->get('price', 0)); + if (0 <= $price) { + $slice->setPrice($price); + } else { + $messages[] = $this->getTranslator()->trans( + 'The price value is not valid', + [], + CustomDelivery::MESSAGE_DOMAIN + ); + } + + if (0 === count($messages)) { + $slice->save(); + $messages[] = $this->getTranslator()->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("#^([0-9\.,]+)$#", $val, $match)) { + $val = $match[0]; + if(strstr($val, ",")) { + $val = str_replace(".", "", $val); + $val = str_replace(",", ".", $val); + } + $val = floatval($val); + + return $val; + } + + return $default; + } + + /** + * Save slice + * + * @return \Thelia\Core\HttpFoundation\Response + */ + public function deleteAction() + { + $response = $this->checkAuth([], ['customdelivery'], AccessManager::DELETE); + + if (null !== $response) { + return $response; + } + + $this->checkXmlHttpRequest(); + + $responseData = [ + "success" => false, + "message" => '', + "slice" => null + ]; + + $response = null; + + try { + $requestData = $this->getRequest()->request; + + if (0 !== $id = intval($requestData->get('id', 0))) { + $slice = CustomDeliverySliceQuery::create()->findPk($id); + $slice->delete(); + $responseData['success'] = true; + } else { + $responseData['message'] = $this->getTranslator()->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 + * + * @return \Symfony\Component\HttpFoundation\RedirectResponse + */ + public function saveConfigurationAction() + { + $response = $this->checkAuth([AdminResources::MODULE], ['customdelivery'], AccessManager::UPDATE); + + if (null !== $response) { + return $response; + } + + $form = $this->createForm('customdelivery.configuration.form', '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); + $this->getParserContext()->setGeneralError($message); + + return $this->render( + "module-configure", + ["module_code" => CustomDelivery::getModuleCode()] + ); + } + + return RedirectResponse::create( + URL::getInstance()->absoluteUrl("/admin/module/" . CustomDelivery::getModuleCode()) + ); + } +} diff --git a/local/modules/CustomDelivery/CustomDelivery.php b/local/modules/CustomDelivery/CustomDelivery.php new file mode 100644 index 00000000..4a805c86 --- /dev/null +++ b/local/modules/CustomDelivery/CustomDelivery.php @@ -0,0 +1,279 @@ +findOne(); + } catch (\Exception $ex) { + // the table doest not exist + $injectSql = true; + } + + if (true === $injectSql) { + $database = new Database($con); + $database->insertSql(null, [__DIR__ . '/Config/thelia.sql']); + } + + return true; + } + + public function postActivation(ConnectionInterface $con = null) + { + // 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); + } + + if (null === ConfigQuery::read(self::CONFIG_TAX_RULE_ID, null)) { + ConfigQuery::write(self::CONFIG_TAX_RULE_ID, self::DEFAULT_TAX_RULE_ID); + } + + // 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(); + } + } + + 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); + } + + /** + * 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. + * + * @return boolean + */ + public function isValidDelivery(Country $country) + { + // Retrieve the cart + $cart = $this->getRequest()->getSession()->getSessionCart($this->getDispatcher()); + + /** @var CustomDeliverySlice $slice */ + $slice = $this->getSlicePostage($cart, $country); + + return null !== $slice; + } + + /** + * @param Cart $cart + * @param $areaId + * @return |null + */ + protected function getSlicePostage(Cart $cart, Country $country) + { + $config = self::getConfig(); + + $currency = $cart->getCurrency(); + + $areas = CountryAreaQuery::create() + ->select([ CountryAreaTableMap::AREA_ID ]) + ->findByCountryId($country->getId()) + ; + + $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); + } + + $slice = $query->findOne(); + $postage = null; + + if (null !== $slice) { + $postage = new OrderPostage(); + + if (0 == $currency->getByDefault()) { + $price = $slice->getPrice() * $currency->getRate(); + } else { + $price = $slice->getPrice(); + } + $price = round($price, 2); + + $postage->setAmount($price); + $postage->setAmountTax(0); + + // taxed amount + if (0 !== $config['tax']) { + $taxRuleI18N = I18n::forceI18nRetrieving( + $this->getRequest()->getSession()->getLang()->getLocale(), + 'TaxRule', + $config['tax'] + ); + $taxRule = TaxRuleQuery::create()->findPk($config['tax']); + if (null !== $taxRule) { + $taxCalculator = new Calculator(); + $taxCalculator->loadTaxRuleWithoutProduct($taxRule, $country); + + $postage->setAmount( + round($taxCalculator->getTaxedPrice($price), 2) + ); + + $postage->setAmountTax($postage->getAmount() - $price); + + $postage->setTaxRuleTitle($taxRuleI18N->getTitle()); + } + } + } + + return $postage; + } + + 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, self::DEFAULT_TAX_RULE_ID)) + ) + ]; + + return $config; + } + + /** + * Calculate and return delivery price in the shop's default currency + * + * @param Country $country the country to deliver to. + * + * @return OrderPostage the delivery price + * @throws DeliveryException if the postage price cannot be calculated. + */ + public function getPostage(Country $country) + { + $areaId = $country->getAreaId(); + $cart = $this->getRequest()->getSession()->getSessionCart($this->getDispatcher()); + + /** @var CustomDeliverySlice $slice */ + $postage = $this->getSlicePostage($cart, $country); + + 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; + } +} diff --git a/local/modules/CustomDelivery/EventListeners/CustomDeliveryEvents.php b/local/modules/CustomDelivery/EventListeners/CustomDeliveryEvents.php new file mode 100644 index 00000000..1e376869 --- /dev/null +++ b/local/modules/CustomDelivery/EventListeners/CustomDeliveryEvents.php @@ -0,0 +1,135 @@ + + */ +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()) { + $contact_email = ConfigQuery::getStoreEmail(); + + if ($contact_email) { + + $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(); + + $this->parser->assign('customer_id', $customer->getId()); + $this->parser->assign('order_id', $order->getId()); + $this->parser->assign('order_ref', $order->getRef()); + $this->parser->assign('order_date', $order->getCreatedAt()); + $this->parser->assign('update_date', $order->getUpdatedAt()); + + $package = $order->getDeliveryRef(); + $trackingUrl = null; + + if (!empty($package)) { + $config = CustomDelivery::getConfig(); + $trackingUrl = $config['url']; + if (!empty($trackingUrl)) { + $trackingUrl = str_replace('%ID%', $package, $trackingUrl); + } + } + $this->parser->assign('package', $package); + $this->parser->assign('tracking_url', $trackingUrl); + + $message + ->setLocale($order->getLang()->getLocale()); + + $instance = \Swift_Message::newInstance() + ->addTo($customer->getEmail(), $customer->getFirstname() . " " . $customer->getLastname()) + ->addFrom($contact_email, ConfigQuery::getStoreName()); + + // Build subject and body + + $message->buildMessage($this->parser, $instance); + + $this->mailer->send($instance); + + 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() + ); + } + } + } +} diff --git a/local/modules/CustomDelivery/Form/ConfigurationForm.php b/local/modules/CustomDelivery/Form/ConfigurationForm.php new file mode 100644 index 00000000..c5fbf5fb --- /dev/null +++ b/local/modules/CustomDelivery/Form/ConfigurationForm.php @@ -0,0 +1,130 @@ + + */ +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 function getName() + { + return "customdelivery-configuration-form"; + } + + protected function buildForm() + { + $form = $this->formBuilder; + + $config = CustomDelivery::getConfig(); + + $form + ->add( + "url", + "text", + [ + '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", + "choice", + [ + 'constraints' => [ + new NotBlank(), + new GreaterThanOrEqual(['value' => 0]) + ], + "choices" => [ + CustomDelivery::METHOD_PRICE_WEIGHT => $this->trans("Price and weight"), + CustomDelivery::METHOD_PRICE => $this->trans("Price"), + CustomDelivery::METHOD_WEIGHT => $this->trans("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", + "tax_rule_id", + [ + "constraints" => [ + new Callback([ + "methods" => [ + [$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); + } +} diff --git a/local/modules/CustomDelivery/Form/SliceForm.php b/local/modules/CustomDelivery/Form/SliceForm.php new file mode 100644 index 00000000..b760172b --- /dev/null +++ b/local/modules/CustomDelivery/Form/SliceForm.php @@ -0,0 +1,92 @@ + + */ +class SliceForm extends BaseForm +{ + /** + * @return string the name of you form. This name must be unique + */ + public function getName() + { + return "customdelivery-configuration-form"; + } + + protected function buildForm() + { + $form = $this->formBuilder; + + $config = CustomDelivery::getConfig(); + + $form + ->add( + "id", + "number", + [ + 'constraints' => [ + new NotBlank() + ], + 'label' => $this->trans("Id") + ] + ) + ->add( + "area", + "area_id", + [ + 'constraints' => [ + new NotBlank(), + new GreaterThanOrEqual(['value' => 0]) + ], + 'label' => $this->trans("Area"), + ] + ) + ->add( + "priceMax", + "float", + [ + 'constraints' => [ + new NotBlank(), + new GreaterThanOrEqual(['value' => 0]) + ], + 'label' => $this->trans("Area"), + ] + ) + ->add( + "weightMax", + "float", + [ + '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); + } +} diff --git a/local/modules/CustomDelivery/Hook/HookManager.php b/local/modules/CustomDelivery/Hook/HookManager.php new file mode 100644 index 00000000..24f37247 --- /dev/null +++ b/local/modules/CustomDelivery/Hook/HookManager.php @@ -0,0 +1,67 @@ + + */ +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( + "configuration.html", + [ + 'module_id' => $moduleId, + 'method' => $config['method'] + ] + ) + ); + } + + public function onModuleConfigJs(HookRenderEvent $event) + { + $event->add( + $this->render("module-config-js.html") + ); + } +} diff --git a/local/modules/CustomDelivery/I18n/backOffice/default/en_US.php b/local/modules/CustomDelivery/I18n/backOffice/default/en_US.php new file mode 100644 index 00000000..4c34c001 --- /dev/null +++ b/local/modules/CustomDelivery/I18n/backOffice/default/en_US.php @@ -0,0 +1,19 @@ + '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', +); diff --git a/local/modules/CustomDelivery/I18n/backOffice/default/fr_FR.php b/local/modules/CustomDelivery/I18n/backOffice/default/fr_FR.php new file mode 100644 index 00000000..6b6e2efa --- /dev/null +++ b/local/modules/CustomDelivery/I18n/backOffice/default/fr_FR.php @@ -0,0 +1,19 @@ + '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', +); diff --git a/local/modules/CustomDelivery/I18n/email/default/en_US.php b/local/modules/CustomDelivery/I18n/email/default/en_US.php new file mode 100644 index 00000000..865088d3 --- /dev/null +++ b/local/modules/CustomDelivery/I18n/email/default/en_US.php @@ -0,0 +1,11 @@ + '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', +); diff --git a/local/modules/CustomDelivery/I18n/email/default/fr_FR.php b/local/modules/CustomDelivery/I18n/email/default/fr_FR.php new file mode 100644 index 00000000..f86e3cdf --- /dev/null +++ b/local/modules/CustomDelivery/I18n/email/default/fr_FR.php @@ -0,0 +1,11 @@ + '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', +); diff --git a/local/modules/CustomDelivery/I18n/en_US.php b/local/modules/CustomDelivery/I18n/en_US.php new file mode 100644 index 00000000..79bfd283 --- /dev/null +++ b/local/modules/CustomDelivery/I18n/en_US.php @@ -0,0 +1,24 @@ + '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', +); diff --git a/local/modules/CustomDelivery/I18n/fr_FR.php b/local/modules/CustomDelivery/I18n/fr_FR.php new file mode 100644 index 00000000..52731646 --- /dev/null +++ b/local/modules/CustomDelivery/I18n/fr_FR.php @@ -0,0 +1,24 @@ + '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é', +); diff --git a/local/modules/CustomDelivery/LICENSE b/local/modules/CustomDelivery/LICENSE new file mode 100644 index 00000000..fb6d90b9 --- /dev/null +++ b/local/modules/CustomDelivery/LICENSE @@ -0,0 +1,166 @@ +GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + diff --git a/local/modules/CustomDelivery/Loop/CustomDeliverySliceLoop.php b/local/modules/CustomDelivery/Loop/CustomDeliverySliceLoop.php new file mode 100644 index 00000000..ff26d649 --- /dev/null +++ b/local/modules/CustomDelivery/Loop/CustomDeliverySliceLoop.php @@ -0,0 +1,168 @@ + + */ +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' + ) + ); + } +} diff --git a/local/modules/CustomDelivery/Model/Base/CustomDeliverySlice.php b/local/modules/CustomDelivery/Model/Base/CustomDeliverySlice.php new file mode 100644 index 00000000..af4897ef --- /dev/null +++ b/local/modules/CustomDelivery/Model/Base/CustomDeliverySlice.php @@ -0,0 +1,1400 @@ +price_max = 0; + $this->weight_max = 0; + $this->price = 0; + } + + /** + * Initializes internal state of CustomDelivery\Model\Base\CustomDeliverySlice object. + * @see applyDefaults() + */ + public function __construct() + { + $this->applyDefaultValues(); + } + + /** + * Returns whether the object has been modified. + * + * @return boolean True if the object has been modified. + */ + public function isModified() + { + return !!$this->modifiedColumns; + } + + /** + * Has specified column been modified? + * + * @param string $col column fully qualified name (TableMap::TYPE_COLNAME), e.g. Book::AUTHOR_ID + * @return boolean True if $col has been modified. + */ + public function isColumnModified($col) + { + return $this->modifiedColumns && isset($this->modifiedColumns[$col]); + } + + /** + * Get the columns that have been modified in this object. + * @return array A unique list of the modified column names for this object. + */ + public function getModifiedColumns() + { + return $this->modifiedColumns ? array_keys($this->modifiedColumns) : []; + } + + /** + * Returns whether the object has ever been saved. This will + * be false, if the object was retrieved from storage or was created + * and then saved. + * + * @return boolean true, if the object has never been persisted. + */ + public function isNew() + { + return $this->new; + } + + /** + * Setter for the isNew attribute. This method will be called + * by Propel-generated children and objects. + * + * @param boolean $b the state of the object. + */ + public function setNew($b) + { + $this->new = (Boolean) $b; + } + + /** + * Whether this object has been deleted. + * @return boolean The deleted state of this object. + */ + public function isDeleted() + { + return $this->deleted; + } + + /** + * Specify whether this object has been deleted. + * @param boolean $b The deleted state of this object. + * @return void + */ + public function setDeleted($b) + { + $this->deleted = (Boolean) $b; + } + + /** + * Sets the modified state for the object to be false. + * @param string $col If supplied, only the specified column is reset. + * @return void + */ + public function resetModified($col = null) + { + if (null !== $col) { + if (isset($this->modifiedColumns[$col])) { + unset($this->modifiedColumns[$col]); + } + } else { + $this->modifiedColumns = array(); + } + } + + /** + * Compares this with another CustomDeliverySlice instance. If + * obj is an instance of CustomDeliverySlice, delegates to + * equals(CustomDeliverySlice). Otherwise, returns false. + * + * @param mixed $obj The object to compare to. + * @return boolean Whether equal to the object specified. + */ + public function equals($obj) + { + $thisclazz = get_class($this); + if (!is_object($obj) || !($obj instanceof $thisclazz)) { + return false; + } + + if ($this === $obj) { + return true; + } + + if (null === $this->getPrimaryKey() + || null === $obj->getPrimaryKey()) { + return false; + } + + return $this->getPrimaryKey() === $obj->getPrimaryKey(); + } + + /** + * If the primary key is not null, return the hashcode of the + * primary key. Otherwise, return the hash code of the object. + * + * @return int Hashcode + */ + public function hashCode() + { + if (null !== $this->getPrimaryKey()) { + return crc32(serialize($this->getPrimaryKey())); + } + + return crc32(serialize(clone $this)); + } + + /** + * Get the associative array of the virtual columns in this object + * + * @return array + */ + public function getVirtualColumns() + { + return $this->virtualColumns; + } + + /** + * Checks the existence of a virtual column in this object + * + * @param string $name The virtual column name + * @return boolean + */ + public function hasVirtualColumn($name) + { + return array_key_exists($name, $this->virtualColumns); + } + + /** + * Get the value of a virtual column in this object + * + * @param string $name The virtual column name + * @return mixed + * + * @throws PropelException + */ + public function getVirtualColumn($name) + { + if (!$this->hasVirtualColumn($name)) { + throw new PropelException(sprintf('Cannot get value of inexistent virtual column %s.', $name)); + } + + return $this->virtualColumns[$name]; + } + + /** + * Set the value of a virtual column in this object + * + * @param string $name The virtual column name + * @param mixed $value The value to give to the virtual column + * + * @return CustomDeliverySlice The current object, for fluid interface + */ + public function setVirtualColumn($name, $value) + { + $this->virtualColumns[$name] = $value; + + return $this; + } + + /** + * Logs a message using Propel::log(). + * + * @param string $msg + * @param int $priority One of the Propel::LOG_* logging levels + * @return boolean + */ + protected function log($msg, $priority = Propel::LOG_INFO) + { + return Propel::log(get_class($this) . ': ' . $msg, $priority); + } + + /** + * Populate the current object from a string, using a given parser format + * + * $book = new Book(); + * $book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}'); + * + * + * @param mixed $parser A AbstractParser instance, + * or a format name ('XML', 'YAML', 'JSON', 'CSV') + * @param string $data The source data to import from + * + * @return CustomDeliverySlice The current object, for fluid interface + */ + public function importFrom($parser, $data) + { + if (!$parser instanceof AbstractParser) { + $parser = AbstractParser::getParser($parser); + } + + $this->fromArray($parser->toArray($data), TableMap::TYPE_PHPNAME); + + return $this; + } + + /** + * Export the current object properties to a string, using a given parser format + * + * $book = BookQuery::create()->findPk(9012); + * echo $book->exportTo('JSON'); + * => {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}'); + * + * + * @param mixed $parser A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV') + * @param boolean $includeLazyLoadColumns (optional) Whether to include lazy load(ed) columns. Defaults to TRUE. + * @return string The exported data + */ + public function exportTo($parser, $includeLazyLoadColumns = true) + { + if (!$parser instanceof AbstractParser) { + $parser = AbstractParser::getParser($parser); + } + + return $parser->fromArray($this->toArray(TableMap::TYPE_PHPNAME, $includeLazyLoadColumns, array(), true)); + } + + /** + * Clean up internal collections prior to serializing + * Avoids recursive loops that turn into segmentation faults when serializing + */ + public function __sleep() + { + $this->clearAllReferences(); + + return array_keys(get_object_vars($this)); + } + + /** + * Get the [id] column value. + * + * @return int + */ + public function getId() + { + + return $this->id; + } + + /** + * Get the [area_id] column value. + * + * @return int + */ + public function getAreaId() + { + + return $this->area_id; + } + + /** + * Get the [price_max] column value. + * + * @return double + */ + public function getPriceMax() + { + + return $this->price_max; + } + + /** + * Get the [weight_max] column value. + * + * @return double + */ + public function getWeightMax() + { + + return $this->weight_max; + } + + /** + * Get the [price] column value. + * + * @return double + */ + public function getPrice() + { + + return $this->price; + } + + /** + * Set the value of [id] column. + * + * @param int $v new value + * @return \CustomDelivery\Model\CustomDeliverySlice The current object (for fluent API support) + */ + public function setId($v) + { + if ($v !== null) { + $v = (int) $v; + } + + if ($this->id !== $v) { + $this->id = $v; + $this->modifiedColumns[CustomDeliverySliceTableMap::ID] = true; + } + + + return $this; + } // setId() + + /** + * Set the value of [area_id] column. + * + * @param int $v new value + * @return \CustomDelivery\Model\CustomDeliverySlice The current object (for fluent API support) + */ + public function setAreaId($v) + { + if ($v !== null) { + $v = (int) $v; + } + + if ($this->area_id !== $v) { + $this->area_id = $v; + $this->modifiedColumns[CustomDeliverySliceTableMap::AREA_ID] = true; + } + + if ($this->aArea !== null && $this->aArea->getId() !== $v) { + $this->aArea = null; + } + + + return $this; + } // setAreaId() + + /** + * Set the value of [price_max] column. + * + * @param double $v new value + * @return \CustomDelivery\Model\CustomDeliverySlice The current object (for fluent API support) + */ + public function setPriceMax($v) + { + if ($v !== null) { + $v = (double) $v; + } + + if ($this->price_max !== $v) { + $this->price_max = $v; + $this->modifiedColumns[CustomDeliverySliceTableMap::PRICE_MAX] = true; + } + + + return $this; + } // setPriceMax() + + /** + * Set the value of [weight_max] column. + * + * @param double $v new value + * @return \CustomDelivery\Model\CustomDeliverySlice The current object (for fluent API support) + */ + public function setWeightMax($v) + { + if ($v !== null) { + $v = (double) $v; + } + + if ($this->weight_max !== $v) { + $this->weight_max = $v; + $this->modifiedColumns[CustomDeliverySliceTableMap::WEIGHT_MAX] = true; + } + + + return $this; + } // setWeightMax() + + /** + * Set the value of [price] column. + * + * @param double $v new value + * @return \CustomDelivery\Model\CustomDeliverySlice The current object (for fluent API support) + */ + public function setPrice($v) + { + if ($v !== null) { + $v = (double) $v; + } + + if ($this->price !== $v) { + $this->price = $v; + $this->modifiedColumns[CustomDeliverySliceTableMap::PRICE] = true; + } + + + return $this; + } // setPrice() + + /** + * Indicates whether the columns in this object are only set to default values. + * + * This method can be used in conjunction with isModified() to indicate whether an object is both + * modified _and_ has some values set which are non-default. + * + * @return boolean Whether the columns in this object are only been set with default values. + */ + public function hasOnlyDefaultValues() + { + if ($this->price_max !== 0) { + return false; + } + + if ($this->weight_max !== 0) { + return false; + } + + if ($this->price !== 0) { + return false; + } + + // otherwise, everything was equal, so return TRUE + return true; + } // hasOnlyDefaultValues() + + /** + * Hydrates (populates) the object variables with values from the database resultset. + * + * An offset (0-based "start column") is specified so that objects can be hydrated + * with a subset of the columns in the resultset rows. This is needed, for example, + * for results of JOIN queries where the resultset row includes columns from two or + * more tables. + * + * @param array $row The row returned by DataFetcher->fetch(). + * @param int $startcol 0-based offset column which indicates which restultset column to start with. + * @param boolean $rehydrate Whether this object is being re-hydrated from the database. + * @param string $indexType The index type of $row. Mostly DataFetcher->getIndexType(). + One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. + * + * @return int next starting column + * @throws PropelException - Any caught Exception will be rewrapped as a PropelException. + */ + public function hydrate($row, $startcol = 0, $rehydrate = false, $indexType = TableMap::TYPE_NUM) + { + try { + + + $col = $row[TableMap::TYPE_NUM == $indexType ? 0 + $startcol : CustomDeliverySliceTableMap::translateFieldName('Id', TableMap::TYPE_PHPNAME, $indexType)]; + $this->id = (null !== $col) ? (int) $col : null; + + $col = $row[TableMap::TYPE_NUM == $indexType ? 1 + $startcol : CustomDeliverySliceTableMap::translateFieldName('AreaId', TableMap::TYPE_PHPNAME, $indexType)]; + $this->area_id = (null !== $col) ? (int) $col : null; + + $col = $row[TableMap::TYPE_NUM == $indexType ? 2 + $startcol : CustomDeliverySliceTableMap::translateFieldName('PriceMax', TableMap::TYPE_PHPNAME, $indexType)]; + $this->price_max = (null !== $col) ? (double) $col : null; + + $col = $row[TableMap::TYPE_NUM == $indexType ? 3 + $startcol : CustomDeliverySliceTableMap::translateFieldName('WeightMax', TableMap::TYPE_PHPNAME, $indexType)]; + $this->weight_max = (null !== $col) ? (double) $col : null; + + $col = $row[TableMap::TYPE_NUM == $indexType ? 4 + $startcol : CustomDeliverySliceTableMap::translateFieldName('Price', TableMap::TYPE_PHPNAME, $indexType)]; + $this->price = (null !== $col) ? (double) $col : null; + $this->resetModified(); + + $this->setNew(false); + + if ($rehydrate) { + $this->ensureConsistency(); + } + + return $startcol + 5; // 5 = CustomDeliverySliceTableMap::NUM_HYDRATE_COLUMNS. + + } catch (Exception $e) { + throw new PropelException("Error populating \CustomDelivery\Model\CustomDeliverySlice object", 0, $e); + } + } + + /** + * Checks and repairs the internal consistency of the object. + * + * This method is executed after an already-instantiated object is re-hydrated + * from the database. It exists to check any foreign keys to make sure that + * the objects related to the current object are correct based on foreign key. + * + * You can override this method in the stub class, but you should always invoke + * the base method from the overridden method (i.e. parent::ensureConsistency()), + * in case your model changes. + * + * @throws PropelException + */ + public function ensureConsistency() + { + if ($this->aArea !== null && $this->area_id !== $this->aArea->getId()) { + $this->aArea = null; + } + } // ensureConsistency + + /** + * Reloads this object from datastore based on primary key and (optionally) resets all associated objects. + * + * This will only work if the object has been saved and has a valid primary key set. + * + * @param boolean $deep (optional) Whether to also de-associated any related objects. + * @param ConnectionInterface $con (optional) The ConnectionInterface connection to use. + * @return void + * @throws PropelException - if this object is deleted, unsaved or doesn't have pk match in db + */ + public function reload($deep = false, ConnectionInterface $con = null) + { + if ($this->isDeleted()) { + throw new PropelException("Cannot reload a deleted object."); + } + + if ($this->isNew()) { + throw new PropelException("Cannot reload an unsaved object."); + } + + if ($con === null) { + $con = Propel::getServiceContainer()->getReadConnection(CustomDeliverySliceTableMap::DATABASE_NAME); + } + + // We don't need to alter the object instance pool; we're just modifying this instance + // already in the pool. + + $dataFetcher = ChildCustomDeliverySliceQuery::create(null, $this->buildPkeyCriteria())->setFormatter(ModelCriteria::FORMAT_STATEMENT)->find($con); + $row = $dataFetcher->fetch(); + $dataFetcher->close(); + if (!$row) { + throw new PropelException('Cannot find matching row in the database to reload object values.'); + } + $this->hydrate($row, 0, true, $dataFetcher->getIndexType()); // rehydrate + + if ($deep) { // also de-associate any related objects? + + $this->aArea = null; + } // if (deep) + } + + /** + * Removes this object from datastore and sets delete attribute. + * + * @param ConnectionInterface $con + * @return void + * @throws PropelException + * @see CustomDeliverySlice::setDeleted() + * @see CustomDeliverySlice::isDeleted() + */ + public function delete(ConnectionInterface $con = null) + { + if ($this->isDeleted()) { + throw new PropelException("This object has already been deleted."); + } + + if ($con === null) { + $con = Propel::getServiceContainer()->getWriteConnection(CustomDeliverySliceTableMap::DATABASE_NAME); + } + + $con->beginTransaction(); + try { + $deleteQuery = ChildCustomDeliverySliceQuery::create() + ->filterByPrimaryKey($this->getPrimaryKey()); + $ret = $this->preDelete($con); + if ($ret) { + $deleteQuery->delete($con); + $this->postDelete($con); + $con->commit(); + $this->setDeleted(true); + } else { + $con->commit(); + } + } catch (Exception $e) { + $con->rollBack(); + throw $e; + } + } + + /** + * Persists this object to the database. + * + * If the object is new, it inserts it; otherwise an update is performed. + * All modified related objects will also be persisted in the doSave() + * method. This method wraps all precipitate database operations in a + * single transaction. + * + * @param ConnectionInterface $con + * @return int The number of rows affected by this insert/update and any referring fk objects' save() operations. + * @throws PropelException + * @see doSave() + */ + public function save(ConnectionInterface $con = null) + { + if ($this->isDeleted()) { + throw new PropelException("You cannot save an object that has been deleted."); + } + + if ($con === null) { + $con = Propel::getServiceContainer()->getWriteConnection(CustomDeliverySliceTableMap::DATABASE_NAME); + } + + $con->beginTransaction(); + $isInsert = $this->isNew(); + try { + $ret = $this->preSave($con); + if ($isInsert) { + $ret = $ret && $this->preInsert($con); + } else { + $ret = $ret && $this->preUpdate($con); + } + if ($ret) { + $affectedRows = $this->doSave($con); + if ($isInsert) { + $this->postInsert($con); + } else { + $this->postUpdate($con); + } + $this->postSave($con); + CustomDeliverySliceTableMap::addInstanceToPool($this); + } else { + $affectedRows = 0; + } + $con->commit(); + + return $affectedRows; + } catch (Exception $e) { + $con->rollBack(); + throw $e; + } + } + + /** + * Performs the work of inserting or updating the row in the database. + * + * If the object is new, it inserts it; otherwise an update is performed. + * All related objects are also updated in this method. + * + * @param ConnectionInterface $con + * @return int The number of rows affected by this insert/update and any referring fk objects' save() operations. + * @throws PropelException + * @see save() + */ + protected function doSave(ConnectionInterface $con) + { + $affectedRows = 0; // initialize var to track total num of affected rows + if (!$this->alreadyInSave) { + $this->alreadyInSave = true; + + // We call the save method on the following object(s) if they + // were passed to this object by their corresponding set + // method. This object relates to these object(s) by a + // foreign key reference. + + if ($this->aArea !== null) { + if ($this->aArea->isModified() || $this->aArea->isNew()) { + $affectedRows += $this->aArea->save($con); + } + $this->setArea($this->aArea); + } + + if ($this->isNew() || $this->isModified()) { + // persist changes + if ($this->isNew()) { + $this->doInsert($con); + } else { + $this->doUpdate($con); + } + $affectedRows += 1; + $this->resetModified(); + } + + $this->alreadyInSave = false; + + } + + return $affectedRows; + } // doSave() + + /** + * Insert the row in the database. + * + * @param ConnectionInterface $con + * + * @throws PropelException + * @see doSave() + */ + protected function doInsert(ConnectionInterface $con) + { + $modifiedColumns = array(); + $index = 0; + + $this->modifiedColumns[CustomDeliverySliceTableMap::ID] = true; + if (null !== $this->id) { + throw new PropelException('Cannot insert a value for auto-increment primary key (' . CustomDeliverySliceTableMap::ID . ')'); + } + + // check the columns in natural order for more readable SQL queries + if ($this->isColumnModified(CustomDeliverySliceTableMap::ID)) { + $modifiedColumns[':p' . $index++] = 'ID'; + } + if ($this->isColumnModified(CustomDeliverySliceTableMap::AREA_ID)) { + $modifiedColumns[':p' . $index++] = 'AREA_ID'; + } + if ($this->isColumnModified(CustomDeliverySliceTableMap::PRICE_MAX)) { + $modifiedColumns[':p' . $index++] = 'PRICE_MAX'; + } + if ($this->isColumnModified(CustomDeliverySliceTableMap::WEIGHT_MAX)) { + $modifiedColumns[':p' . $index++] = 'WEIGHT_MAX'; + } + if ($this->isColumnModified(CustomDeliverySliceTableMap::PRICE)) { + $modifiedColumns[':p' . $index++] = 'PRICE'; + } + + $sql = sprintf( + 'INSERT INTO custom_delivery_slice (%s) VALUES (%s)', + implode(', ', $modifiedColumns), + implode(', ', array_keys($modifiedColumns)) + ); + + try { + $stmt = $con->prepare($sql); + foreach ($modifiedColumns as $identifier => $columnName) { + switch ($columnName) { + case 'ID': + $stmt->bindValue($identifier, $this->id, PDO::PARAM_INT); + break; + case 'AREA_ID': + $stmt->bindValue($identifier, $this->area_id, PDO::PARAM_INT); + break; + case 'PRICE_MAX': + $stmt->bindValue($identifier, $this->price_max, PDO::PARAM_STR); + break; + case 'WEIGHT_MAX': + $stmt->bindValue($identifier, $this->weight_max, PDO::PARAM_STR); + break; + case 'PRICE': + $stmt->bindValue($identifier, $this->price, PDO::PARAM_STR); + break; + } + } + $stmt->execute(); + } catch (Exception $e) { + Propel::log($e->getMessage(), Propel::LOG_ERR); + throw new PropelException(sprintf('Unable to execute INSERT statement [%s]', $sql), 0, $e); + } + + try { + $pk = $con->lastInsertId(); + } catch (Exception $e) { + throw new PropelException('Unable to get autoincrement id.', 0, $e); + } + $this->setId($pk); + + $this->setNew(false); + } + + /** + * Update the row in the database. + * + * @param ConnectionInterface $con + * + * @return Integer Number of updated rows + * @see doSave() + */ + protected function doUpdate(ConnectionInterface $con) + { + $selectCriteria = $this->buildPkeyCriteria(); + $valuesCriteria = $this->buildCriteria(); + + return $selectCriteria->doUpdate($valuesCriteria, $con); + } + + /** + * Retrieves a field from the object by name passed in as a string. + * + * @param string $name name + * @param string $type The type of fieldname the $name is of: + * one of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. + * Defaults to TableMap::TYPE_PHPNAME. + * @return mixed Value of field. + */ + public function getByName($name, $type = TableMap::TYPE_PHPNAME) + { + $pos = CustomDeliverySliceTableMap::translateFieldName($name, $type, TableMap::TYPE_NUM); + $field = $this->getByPosition($pos); + + return $field; + } + + /** + * Retrieves a field from the object by Position as specified in the xml schema. + * Zero-based. + * + * @param int $pos position in xml schema + * @return mixed Value of field at $pos + */ + public function getByPosition($pos) + { + switch ($pos) { + case 0: + return $this->getId(); + break; + case 1: + return $this->getAreaId(); + break; + case 2: + return $this->getPriceMax(); + break; + case 3: + return $this->getWeightMax(); + break; + case 4: + return $this->getPrice(); + break; + default: + return null; + break; + } // switch() + } + + /** + * Exports the object as an array. + * + * You can specify the key type of the array by passing one of the class + * type constants. + * + * @param string $keyType (optional) One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME, + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. + * Defaults to TableMap::TYPE_PHPNAME. + * @param boolean $includeLazyLoadColumns (optional) Whether to include lazy loaded columns. Defaults to TRUE. + * @param array $alreadyDumpedObjects List of objects to skip to avoid recursion + * @param boolean $includeForeignObjects (optional) Whether to include hydrated related objects. Default to FALSE. + * + * @return array an associative array containing the field names (as keys) and field values + */ + public function toArray($keyType = TableMap::TYPE_PHPNAME, $includeLazyLoadColumns = true, $alreadyDumpedObjects = array(), $includeForeignObjects = false) + { + if (isset($alreadyDumpedObjects['CustomDeliverySlice'][$this->getPrimaryKey()])) { + return '*RECURSION*'; + } + $alreadyDumpedObjects['CustomDeliverySlice'][$this->getPrimaryKey()] = true; + $keys = CustomDeliverySliceTableMap::getFieldNames($keyType); + $result = array( + $keys[0] => $this->getId(), + $keys[1] => $this->getAreaId(), + $keys[2] => $this->getPriceMax(), + $keys[3] => $this->getWeightMax(), + $keys[4] => $this->getPrice(), + ); + $virtualColumns = $this->virtualColumns; + foreach ($virtualColumns as $key => $virtualColumn) { + $result[$key] = $virtualColumn; + } + + if ($includeForeignObjects) { + if (null !== $this->aArea) { + $result['Area'] = $this->aArea->toArray($keyType, $includeLazyLoadColumns, $alreadyDumpedObjects, true); + } + } + + return $result; + } + + /** + * Sets a field from the object by name passed in as a string. + * + * @param string $name + * @param mixed $value field value + * @param string $type The type of fieldname the $name is of: + * one of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. + * Defaults to TableMap::TYPE_PHPNAME. + * @return void + */ + public function setByName($name, $value, $type = TableMap::TYPE_PHPNAME) + { + $pos = CustomDeliverySliceTableMap::translateFieldName($name, $type, TableMap::TYPE_NUM); + + return $this->setByPosition($pos, $value); + } + + /** + * Sets a field from the object by Position as specified in the xml schema. + * Zero-based. + * + * @param int $pos position in xml schema + * @param mixed $value field value + * @return void + */ + public function setByPosition($pos, $value) + { + switch ($pos) { + case 0: + $this->setId($value); + break; + case 1: + $this->setAreaId($value); + break; + case 2: + $this->setPriceMax($value); + break; + case 3: + $this->setWeightMax($value); + break; + case 4: + $this->setPrice($value); + break; + } // switch() + } + + /** + * Populates the object using an array. + * + * This is particularly useful when populating an object from one of the + * request arrays (e.g. $_POST). This method goes through the column + * names, checking to see whether a matching key exists in populated + * array. If so the setByName() method is called for that column. + * + * You can specify the key type of the array by additionally passing one + * of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME, + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. + * The default key type is the column's TableMap::TYPE_PHPNAME. + * + * @param array $arr An array to populate the object from. + * @param string $keyType The type of keys the array uses. + * @return void + */ + public function fromArray($arr, $keyType = TableMap::TYPE_PHPNAME) + { + $keys = CustomDeliverySliceTableMap::getFieldNames($keyType); + + if (array_key_exists($keys[0], $arr)) $this->setId($arr[$keys[0]]); + if (array_key_exists($keys[1], $arr)) $this->setAreaId($arr[$keys[1]]); + if (array_key_exists($keys[2], $arr)) $this->setPriceMax($arr[$keys[2]]); + if (array_key_exists($keys[3], $arr)) $this->setWeightMax($arr[$keys[3]]); + if (array_key_exists($keys[4], $arr)) $this->setPrice($arr[$keys[4]]); + } + + /** + * Build a Criteria object containing the values of all modified columns in this object. + * + * @return Criteria The Criteria object containing all modified values. + */ + public function buildCriteria() + { + $criteria = new Criteria(CustomDeliverySliceTableMap::DATABASE_NAME); + + if ($this->isColumnModified(CustomDeliverySliceTableMap::ID)) $criteria->add(CustomDeliverySliceTableMap::ID, $this->id); + if ($this->isColumnModified(CustomDeliverySliceTableMap::AREA_ID)) $criteria->add(CustomDeliverySliceTableMap::AREA_ID, $this->area_id); + if ($this->isColumnModified(CustomDeliverySliceTableMap::PRICE_MAX)) $criteria->add(CustomDeliverySliceTableMap::PRICE_MAX, $this->price_max); + if ($this->isColumnModified(CustomDeliverySliceTableMap::WEIGHT_MAX)) $criteria->add(CustomDeliverySliceTableMap::WEIGHT_MAX, $this->weight_max); + if ($this->isColumnModified(CustomDeliverySliceTableMap::PRICE)) $criteria->add(CustomDeliverySliceTableMap::PRICE, $this->price); + + return $criteria; + } + + /** + * Builds a Criteria object containing the primary key for this object. + * + * Unlike buildCriteria() this method includes the primary key values regardless + * of whether or not they have been modified. + * + * @return Criteria The Criteria object containing value(s) for primary key(s). + */ + public function buildPkeyCriteria() + { + $criteria = new Criteria(CustomDeliverySliceTableMap::DATABASE_NAME); + $criteria->add(CustomDeliverySliceTableMap::ID, $this->id); + + return $criteria; + } + + /** + * Returns the primary key for this object (row). + * @return int + */ + public function getPrimaryKey() + { + return $this->getId(); + } + + /** + * Generic method to set the primary key (id column). + * + * @param int $key Primary key. + * @return void + */ + public function setPrimaryKey($key) + { + $this->setId($key); + } + + /** + * Returns true if the primary key for this object is null. + * @return boolean + */ + public function isPrimaryKeyNull() + { + + return null === $this->getId(); + } + + /** + * Sets contents of passed object to values from current object. + * + * If desired, this method can also make copies of all associated (fkey referrers) + * objects. + * + * @param object $copyObj An object of \CustomDelivery\Model\CustomDeliverySlice (or compatible) type. + * @param boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row. + * @param boolean $makeNew Whether to reset autoincrement PKs and make the object new. + * @throws PropelException + */ + public function copyInto($copyObj, $deepCopy = false, $makeNew = true) + { + $copyObj->setAreaId($this->getAreaId()); + $copyObj->setPriceMax($this->getPriceMax()); + $copyObj->setWeightMax($this->getWeightMax()); + $copyObj->setPrice($this->getPrice()); + if ($makeNew) { + $copyObj->setNew(true); + $copyObj->setId(NULL); // this is a auto-increment column, so set to default value + } + } + + /** + * Makes a copy of this object that will be inserted as a new row in table when saved. + * It creates a new object filling in the simple attributes, but skipping any primary + * keys that are defined for the table. + * + * If desired, this method can also make copies of all associated (fkey referrers) + * objects. + * + * @param boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row. + * @return \CustomDelivery\Model\CustomDeliverySlice Clone of current object. + * @throws PropelException + */ + public function copy($deepCopy = false) + { + // we use get_class(), because this might be a subclass + $clazz = get_class($this); + $copyObj = new $clazz(); + $this->copyInto($copyObj, $deepCopy); + + return $copyObj; + } + + /** + * Declares an association between this object and a ChildArea object. + * + * @param ChildArea $v + * @return \CustomDelivery\Model\CustomDeliverySlice The current object (for fluent API support) + * @throws PropelException + */ + public function setArea(ChildArea $v = null) + { + if ($v === null) { + $this->setAreaId(NULL); + } else { + $this->setAreaId($v->getId()); + } + + $this->aArea = $v; + + // Add binding for other direction of this n:n relationship. + // If this object has already been added to the ChildArea object, it will not be re-added. + if ($v !== null) { + $v->addCustomDeliverySlice($this); + } + + + return $this; + } + + + /** + * Get the associated ChildArea object + * + * @param ConnectionInterface $con Optional Connection object. + * @return ChildArea The associated ChildArea object. + * @throws PropelException + */ + public function getArea(ConnectionInterface $con = null) + { + if ($this->aArea === null && ($this->area_id !== null)) { + $this->aArea = AreaQuery::create()->findPk($this->area_id, $con); + /* The following can be used additionally to + guarantee the related object contains a reference + to this object. This level of coupling may, however, be + undesirable since it could result in an only partially populated collection + in the referenced object. + $this->aArea->addCustomDeliverySlices($this); + */ + } + + return $this->aArea; + } + + /** + * Clears the current object and sets all attributes to their default values + */ + public function clear() + { + $this->id = null; + $this->area_id = null; + $this->price_max = null; + $this->weight_max = null; + $this->price = null; + $this->alreadyInSave = false; + $this->clearAllReferences(); + $this->applyDefaultValues(); + $this->resetModified(); + $this->setNew(true); + $this->setDeleted(false); + } + + /** + * Resets all references to other model objects or collections of model objects. + * + * This method is a user-space workaround for PHP's inability to garbage collect + * objects with circular references (even in PHP 5.3). This is currently necessary + * when using Propel in certain daemon or large-volume/high-memory operations. + * + * @param boolean $deep Whether to also clear the references on all referrer objects. + */ + public function clearAllReferences($deep = false) + { + if ($deep) { + } // if ($deep) + + $this->aArea = null; + } + + /** + * Return the string representation of this object + * + * @return string + */ + public function __toString() + { + return (string) $this->exportTo(CustomDeliverySliceTableMap::DEFAULT_STRING_FORMAT); + } + + /** + * Code to be run before persisting the object + * @param ConnectionInterface $con + * @return boolean + */ + public function preSave(ConnectionInterface $con = null) + { + return true; + } + + /** + * Code to be run after persisting the object + * @param ConnectionInterface $con + */ + public function postSave(ConnectionInterface $con = null) + { + + } + + /** + * Code to be run before inserting to database + * @param ConnectionInterface $con + * @return boolean + */ + public function preInsert(ConnectionInterface $con = null) + { + return true; + } + + /** + * Code to be run after inserting to database + * @param ConnectionInterface $con + */ + public function postInsert(ConnectionInterface $con = null) + { + + } + + /** + * Code to be run before updating the object in database + * @param ConnectionInterface $con + * @return boolean + */ + public function preUpdate(ConnectionInterface $con = null) + { + return true; + } + + /** + * Code to be run after updating the object in database + * @param ConnectionInterface $con + */ + public function postUpdate(ConnectionInterface $con = null) + { + + } + + /** + * Code to be run before deleting the object in database + * @param ConnectionInterface $con + * @return boolean + */ + public function preDelete(ConnectionInterface $con = null) + { + return true; + } + + /** + * Code to be run after deleting the object in database + * @param ConnectionInterface $con + */ + public function postDelete(ConnectionInterface $con = null) + { + + } + + + /** + * Derived method to catches calls to undefined methods. + * + * Provides magic import/export method support (fromXML()/toXML(), fromYAML()/toYAML(), etc.). + * Allows to define default __call() behavior if you overwrite __call() + * + * @param string $name + * @param mixed $params + * + * @return array|string + */ + public function __call($name, $params) + { + if (0 === strpos($name, 'get')) { + $virtualColumn = substr($name, 3); + if ($this->hasVirtualColumn($virtualColumn)) { + return $this->getVirtualColumn($virtualColumn); + } + + $virtualColumn = lcfirst($virtualColumn); + if ($this->hasVirtualColumn($virtualColumn)) { + return $this->getVirtualColumn($virtualColumn); + } + } + + if (0 === strpos($name, 'from')) { + $format = substr($name, 4); + + return $this->importFrom($format, reset($params)); + } + + if (0 === strpos($name, 'to')) { + $format = substr($name, 2); + $includeLazyLoadColumns = isset($params[0]) ? $params[0] : true; + + return $this->exportTo($format, $includeLazyLoadColumns); + } + + throw new BadMethodCallException(sprintf('Call to undefined method: %s.', $name)); + } + +} diff --git a/local/modules/CustomDelivery/Model/Base/CustomDeliverySliceQuery.php b/local/modules/CustomDelivery/Model/Base/CustomDeliverySliceQuery.php new file mode 100644 index 00000000..e94933da --- /dev/null +++ b/local/modules/CustomDelivery/Model/Base/CustomDeliverySliceQuery.php @@ -0,0 +1,609 @@ +setModelAlias($modelAlias); + } + if ($criteria instanceof Criteria) { + $query->mergeWith($criteria); + } + + return $query; + } + + /** + * Find object by primary key. + * Propel uses the instance pool to skip the database if the object exists. + * Go fast if the query is untouched. + * + * + * $obj = $c->findPk(12, $con); + * + * + * @param mixed $key Primary key to use for the query + * @param ConnectionInterface $con an optional connection object + * + * @return ChildCustomDeliverySlice|array|mixed the result, formatted by the current formatter + */ + public function findPk($key, $con = null) + { + if ($key === null) { + return null; + } + if ((null !== ($obj = CustomDeliverySliceTableMap::getInstanceFromPool((string) $key))) && !$this->formatter) { + // the object is already in the instance pool + return $obj; + } + if ($con === null) { + $con = Propel::getServiceContainer()->getReadConnection(CustomDeliverySliceTableMap::DATABASE_NAME); + } + $this->basePreSelect($con); + if ($this->formatter || $this->modelAlias || $this->with || $this->select + || $this->selectColumns || $this->asColumns || $this->selectModifiers + || $this->map || $this->having || $this->joins) { + return $this->findPkComplex($key, $con); + } else { + return $this->findPkSimple($key, $con); + } + } + + /** + * Find object by primary key using raw SQL to go fast. + * Bypass doSelect() and the object formatter by using generated code. + * + * @param mixed $key Primary key to use for the query + * @param ConnectionInterface $con A connection object + * + * @return ChildCustomDeliverySlice A model object, or null if the key is not found + */ + protected function findPkSimple($key, $con) + { + $sql = 'SELECT ID, AREA_ID, PRICE_MAX, WEIGHT_MAX, PRICE FROM custom_delivery_slice WHERE ID = :p0'; + try { + $stmt = $con->prepare($sql); + $stmt->bindValue(':p0', $key, PDO::PARAM_INT); + $stmt->execute(); + } catch (Exception $e) { + Propel::log($e->getMessage(), Propel::LOG_ERR); + throw new PropelException(sprintf('Unable to execute SELECT statement [%s]', $sql), 0, $e); + } + $obj = null; + if ($row = $stmt->fetch(\PDO::FETCH_NUM)) { + $obj = new ChildCustomDeliverySlice(); + $obj->hydrate($row); + CustomDeliverySliceTableMap::addInstanceToPool($obj, (string) $key); + } + $stmt->closeCursor(); + + return $obj; + } + + /** + * Find object by primary key. + * + * @param mixed $key Primary key to use for the query + * @param ConnectionInterface $con A connection object + * + * @return ChildCustomDeliverySlice|array|mixed the result, formatted by the current formatter + */ + protected function findPkComplex($key, $con) + { + // As the query uses a PK condition, no limit(1) is necessary. + $criteria = $this->isKeepQuery() ? clone $this : $this; + $dataFetcher = $criteria + ->filterByPrimaryKey($key) + ->doSelect($con); + + return $criteria->getFormatter()->init($criteria)->formatOne($dataFetcher); + } + + /** + * Find objects by primary key + * + * $objs = $c->findPks(array(12, 56, 832), $con); + * + * @param array $keys Primary keys to use for the query + * @param ConnectionInterface $con an optional connection object + * + * @return ObjectCollection|array|mixed the list of results, formatted by the current formatter + */ + public function findPks($keys, $con = null) + { + if (null === $con) { + $con = Propel::getServiceContainer()->getReadConnection($this->getDbName()); + } + $this->basePreSelect($con); + $criteria = $this->isKeepQuery() ? clone $this : $this; + $dataFetcher = $criteria + ->filterByPrimaryKeys($keys) + ->doSelect($con); + + return $criteria->getFormatter()->init($criteria)->format($dataFetcher); + } + + /** + * Filter the query by primary key + * + * @param mixed $key Primary key to use for the query + * + * @return ChildCustomDeliverySliceQuery The current query, for fluid interface + */ + public function filterByPrimaryKey($key) + { + + return $this->addUsingAlias(CustomDeliverySliceTableMap::ID, $key, Criteria::EQUAL); + } + + /** + * Filter the query by a list of primary keys + * + * @param array $keys The list of primary key to use for the query + * + * @return ChildCustomDeliverySliceQuery The current query, for fluid interface + */ + public function filterByPrimaryKeys($keys) + { + + return $this->addUsingAlias(CustomDeliverySliceTableMap::ID, $keys, Criteria::IN); + } + + /** + * Filter the query on the id column + * + * Example usage: + * + * $query->filterById(1234); // WHERE id = 1234 + * $query->filterById(array(12, 34)); // WHERE id IN (12, 34) + * $query->filterById(array('min' => 12)); // WHERE id > 12 + * + * + * @param mixed $id The value to use as filter. + * Use scalar values for equality. + * Use array values for in_array() equivalent. + * Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return ChildCustomDeliverySliceQuery The current query, for fluid interface + */ + public function filterById($id = null, $comparison = null) + { + if (is_array($id)) { + $useMinMax = false; + if (isset($id['min'])) { + $this->addUsingAlias(CustomDeliverySliceTableMap::ID, $id['min'], Criteria::GREATER_EQUAL); + $useMinMax = true; + } + if (isset($id['max'])) { + $this->addUsingAlias(CustomDeliverySliceTableMap::ID, $id['max'], Criteria::LESS_EQUAL); + $useMinMax = true; + } + if ($useMinMax) { + return $this; + } + if (null === $comparison) { + $comparison = Criteria::IN; + } + } + + return $this->addUsingAlias(CustomDeliverySliceTableMap::ID, $id, $comparison); + } + + /** + * Filter the query on the area_id column + * + * Example usage: + * + * $query->filterByAreaId(1234); // WHERE area_id = 1234 + * $query->filterByAreaId(array(12, 34)); // WHERE area_id IN (12, 34) + * $query->filterByAreaId(array('min' => 12)); // WHERE area_id > 12 + * + * + * @see filterByArea() + * + * @param mixed $areaId The value to use as filter. + * Use scalar values for equality. + * Use array values for in_array() equivalent. + * Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return ChildCustomDeliverySliceQuery The current query, for fluid interface + */ + public function filterByAreaId($areaId = null, $comparison = null) + { + if (is_array($areaId)) { + $useMinMax = false; + if (isset($areaId['min'])) { + $this->addUsingAlias(CustomDeliverySliceTableMap::AREA_ID, $areaId['min'], Criteria::GREATER_EQUAL); + $useMinMax = true; + } + if (isset($areaId['max'])) { + $this->addUsingAlias(CustomDeliverySliceTableMap::AREA_ID, $areaId['max'], Criteria::LESS_EQUAL); + $useMinMax = true; + } + if ($useMinMax) { + return $this; + } + if (null === $comparison) { + $comparison = Criteria::IN; + } + } + + return $this->addUsingAlias(CustomDeliverySliceTableMap::AREA_ID, $areaId, $comparison); + } + + /** + * Filter the query on the price_max column + * + * Example usage: + * + * $query->filterByPriceMax(1234); // WHERE price_max = 1234 + * $query->filterByPriceMax(array(12, 34)); // WHERE price_max IN (12, 34) + * $query->filterByPriceMax(array('min' => 12)); // WHERE price_max > 12 + * + * + * @param mixed $priceMax The value to use as filter. + * Use scalar values for equality. + * Use array values for in_array() equivalent. + * Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return ChildCustomDeliverySliceQuery The current query, for fluid interface + */ + public function filterByPriceMax($priceMax = null, $comparison = null) + { + if (is_array($priceMax)) { + $useMinMax = false; + if (isset($priceMax['min'])) { + $this->addUsingAlias(CustomDeliverySliceTableMap::PRICE_MAX, $priceMax['min'], Criteria::GREATER_EQUAL); + $useMinMax = true; + } + if (isset($priceMax['max'])) { + $this->addUsingAlias(CustomDeliverySliceTableMap::PRICE_MAX, $priceMax['max'], Criteria::LESS_EQUAL); + $useMinMax = true; + } + if ($useMinMax) { + return $this; + } + if (null === $comparison) { + $comparison = Criteria::IN; + } + } + + return $this->addUsingAlias(CustomDeliverySliceTableMap::PRICE_MAX, $priceMax, $comparison); + } + + /** + * Filter the query on the weight_max column + * + * Example usage: + * + * $query->filterByWeightMax(1234); // WHERE weight_max = 1234 + * $query->filterByWeightMax(array(12, 34)); // WHERE weight_max IN (12, 34) + * $query->filterByWeightMax(array('min' => 12)); // WHERE weight_max > 12 + * + * + * @param mixed $weightMax The value to use as filter. + * Use scalar values for equality. + * Use array values for in_array() equivalent. + * Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return ChildCustomDeliverySliceQuery The current query, for fluid interface + */ + public function filterByWeightMax($weightMax = null, $comparison = null) + { + if (is_array($weightMax)) { + $useMinMax = false; + if (isset($weightMax['min'])) { + $this->addUsingAlias(CustomDeliverySliceTableMap::WEIGHT_MAX, $weightMax['min'], Criteria::GREATER_EQUAL); + $useMinMax = true; + } + if (isset($weightMax['max'])) { + $this->addUsingAlias(CustomDeliverySliceTableMap::WEIGHT_MAX, $weightMax['max'], Criteria::LESS_EQUAL); + $useMinMax = true; + } + if ($useMinMax) { + return $this; + } + if (null === $comparison) { + $comparison = Criteria::IN; + } + } + + return $this->addUsingAlias(CustomDeliverySliceTableMap::WEIGHT_MAX, $weightMax, $comparison); + } + + /** + * Filter the query on the price column + * + * Example usage: + * + * $query->filterByPrice(1234); // WHERE price = 1234 + * $query->filterByPrice(array(12, 34)); // WHERE price IN (12, 34) + * $query->filterByPrice(array('min' => 12)); // WHERE price > 12 + * + * + * @param mixed $price The value to use as filter. + * Use scalar values for equality. + * Use array values for in_array() equivalent. + * Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return ChildCustomDeliverySliceQuery The current query, for fluid interface + */ + public function filterByPrice($price = null, $comparison = null) + { + if (is_array($price)) { + $useMinMax = false; + if (isset($price['min'])) { + $this->addUsingAlias(CustomDeliverySliceTableMap::PRICE, $price['min'], Criteria::GREATER_EQUAL); + $useMinMax = true; + } + if (isset($price['max'])) { + $this->addUsingAlias(CustomDeliverySliceTableMap::PRICE, $price['max'], Criteria::LESS_EQUAL); + $useMinMax = true; + } + if ($useMinMax) { + return $this; + } + if (null === $comparison) { + $comparison = Criteria::IN; + } + } + + return $this->addUsingAlias(CustomDeliverySliceTableMap::PRICE, $price, $comparison); + } + + /** + * Filter the query by a related \Thelia\Model\Area object + * + * @param \Thelia\Model\Area|ObjectCollection $area The related object(s) to use as filter + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return ChildCustomDeliverySliceQuery The current query, for fluid interface + */ + public function filterByArea($area, $comparison = null) + { + if ($area instanceof \Thelia\Model\Area) { + return $this + ->addUsingAlias(CustomDeliverySliceTableMap::AREA_ID, $area->getId(), $comparison); + } elseif ($area instanceof ObjectCollection) { + if (null === $comparison) { + $comparison = Criteria::IN; + } + + return $this + ->addUsingAlias(CustomDeliverySliceTableMap::AREA_ID, $area->toKeyValue('PrimaryKey', 'Id'), $comparison); + } else { + throw new PropelException('filterByArea() only accepts arguments of type \Thelia\Model\Area or Collection'); + } + } + + /** + * Adds a JOIN clause to the query using the Area relation + * + * @param string $relationAlias optional alias for the relation + * @param string $joinType Accepted values are null, 'left join', 'right join', 'inner join' + * + * @return ChildCustomDeliverySliceQuery The current query, for fluid interface + */ + public function joinArea($relationAlias = null, $joinType = Criteria::INNER_JOIN) + { + $tableMap = $this->getTableMap(); + $relationMap = $tableMap->getRelation('Area'); + + // create a ModelJoin object for this join + $join = new ModelJoin(); + $join->setJoinType($joinType); + $join->setRelationMap($relationMap, $this->useAliasInSQL ? $this->getModelAlias() : null, $relationAlias); + if ($previousJoin = $this->getPreviousJoin()) { + $join->setPreviousJoin($previousJoin); + } + + // add the ModelJoin to the current object + if ($relationAlias) { + $this->addAlias($relationAlias, $relationMap->getRightTable()->getName()); + $this->addJoinObject($join, $relationAlias); + } else { + $this->addJoinObject($join, 'Area'); + } + + return $this; + } + + /** + * Use the Area relation Area object + * + * @see useQuery() + * + * @param string $relationAlias optional alias for the relation, + * to be used as main alias in the secondary query + * @param string $joinType Accepted values are null, 'left join', 'right join', 'inner join' + * + * @return \Thelia\Model\AreaQuery A secondary query class using the current class as primary query + */ + public function useAreaQuery($relationAlias = null, $joinType = Criteria::INNER_JOIN) + { + return $this + ->joinArea($relationAlias, $joinType) + ->useQuery($relationAlias ? $relationAlias : 'Area', '\Thelia\Model\AreaQuery'); + } + + /** + * Exclude object from result + * + * @param ChildCustomDeliverySlice $customDeliverySlice Object to remove from the list of results + * + * @return ChildCustomDeliverySliceQuery The current query, for fluid interface + */ + public function prune($customDeliverySlice = null) + { + if ($customDeliverySlice) { + $this->addUsingAlias(CustomDeliverySliceTableMap::ID, $customDeliverySlice->getId(), Criteria::NOT_EQUAL); + } + + return $this; + } + + /** + * Deletes all rows from the custom_delivery_slice table. + * + * @param ConnectionInterface $con the connection to use + * @return int The number of affected rows (if supported by underlying database driver). + */ + public function doDeleteAll(ConnectionInterface $con = null) + { + if (null === $con) { + $con = Propel::getServiceContainer()->getWriteConnection(CustomDeliverySliceTableMap::DATABASE_NAME); + } + $affectedRows = 0; // initialize var to track total num of affected rows + try { + // use transaction because $criteria could contain info + // for more than one table or we could emulating ON DELETE CASCADE, etc. + $con->beginTransaction(); + $affectedRows += parent::doDeleteAll($con); + // Because this db requires some delete cascade/set null emulation, we have to + // clear the cached instance *after* the emulation has happened (since + // instances get re-added by the select statement contained therein). + CustomDeliverySliceTableMap::clearInstancePool(); + CustomDeliverySliceTableMap::clearRelatedInstancePool(); + + $con->commit(); + } catch (PropelException $e) { + $con->rollBack(); + throw $e; + } + + return $affectedRows; + } + + /** + * Performs a DELETE on the database, given a ChildCustomDeliverySlice or Criteria object OR a primary key value. + * + * @param mixed $values Criteria or ChildCustomDeliverySlice object or primary key or array of primary keys + * which is used to create the DELETE statement + * @param ConnectionInterface $con the connection to use + * @return int The number of affected rows (if supported by underlying database driver). This includes CASCADE-related rows + * if supported by native driver or if emulated using Propel. + * @throws PropelException Any exceptions caught during processing will be + * rethrown wrapped into a PropelException. + */ + public function delete(ConnectionInterface $con = null) + { + if (null === $con) { + $con = Propel::getServiceContainer()->getWriteConnection(CustomDeliverySliceTableMap::DATABASE_NAME); + } + + $criteria = $this; + + // Set the correct dbName + $criteria->setDbName(CustomDeliverySliceTableMap::DATABASE_NAME); + + $affectedRows = 0; // initialize var to track total num of affected rows + + try { + // use transaction because $criteria could contain info + // for more than one table or we could emulating ON DELETE CASCADE, etc. + $con->beginTransaction(); + + + CustomDeliverySliceTableMap::removeInstanceFromPool($criteria); + + $affectedRows += ModelCriteria::delete($con); + CustomDeliverySliceTableMap::clearRelatedInstancePool(); + $con->commit(); + + return $affectedRows; + } catch (PropelException $e) { + $con->rollBack(); + throw $e; + } + } + +} // CustomDeliverySliceQuery diff --git a/local/modules/CustomDelivery/Model/CustomDeliverySlice.php b/local/modules/CustomDelivery/Model/CustomDeliverySlice.php new file mode 100644 index 00000000..aa4d36f2 --- /dev/null +++ b/local/modules/CustomDelivery/Model/CustomDeliverySlice.php @@ -0,0 +1,10 @@ + array('Id', 'AreaId', 'PriceMax', 'WeightMax', 'Price', ), + self::TYPE_STUDLYPHPNAME => array('id', 'areaId', 'priceMax', 'weightMax', 'price', ), + self::TYPE_COLNAME => array(CustomDeliverySliceTableMap::ID, CustomDeliverySliceTableMap::AREA_ID, CustomDeliverySliceTableMap::PRICE_MAX, CustomDeliverySliceTableMap::WEIGHT_MAX, CustomDeliverySliceTableMap::PRICE, ), + self::TYPE_RAW_COLNAME => array('ID', 'AREA_ID', 'PRICE_MAX', 'WEIGHT_MAX', 'PRICE', ), + self::TYPE_FIELDNAME => array('id', 'area_id', 'price_max', 'weight_max', 'price', ), + self::TYPE_NUM => array(0, 1, 2, 3, 4, ) + ); + + /** + * holds an array of keys for quick access to the fieldnames array + * + * first dimension keys are the type constants + * e.g. self::$fieldKeys[self::TYPE_PHPNAME]['Id'] = 0 + */ + protected static $fieldKeys = array ( + self::TYPE_PHPNAME => array('Id' => 0, 'AreaId' => 1, 'PriceMax' => 2, 'WeightMax' => 3, 'Price' => 4, ), + self::TYPE_STUDLYPHPNAME => array('id' => 0, 'areaId' => 1, 'priceMax' => 2, 'weightMax' => 3, 'price' => 4, ), + self::TYPE_COLNAME => array(CustomDeliverySliceTableMap::ID => 0, CustomDeliverySliceTableMap::AREA_ID => 1, CustomDeliverySliceTableMap::PRICE_MAX => 2, CustomDeliverySliceTableMap::WEIGHT_MAX => 3, CustomDeliverySliceTableMap::PRICE => 4, ), + self::TYPE_RAW_COLNAME => array('ID' => 0, 'AREA_ID' => 1, 'PRICE_MAX' => 2, 'WEIGHT_MAX' => 3, 'PRICE' => 4, ), + self::TYPE_FIELDNAME => array('id' => 0, 'area_id' => 1, 'price_max' => 2, 'weight_max' => 3, 'price' => 4, ), + self::TYPE_NUM => array(0, 1, 2, 3, 4, ) + ); + + /** + * Initialize the table attributes and columns + * Relations are not initialized by this method since they are lazy loaded + * + * @return void + * @throws PropelException + */ + public function initialize() + { + // attributes + $this->setName('custom_delivery_slice'); + $this->setPhpName('CustomDeliverySlice'); + $this->setClassName('\\CustomDelivery\\Model\\CustomDeliverySlice'); + $this->setPackage('CustomDelivery.Model'); + $this->setUseIdGenerator(true); + // columns + $this->addPrimaryKey('ID', 'Id', 'INTEGER', true, null, null); + $this->addForeignKey('AREA_ID', 'AreaId', 'INTEGER', 'area', 'ID', true, null, null); + $this->addColumn('PRICE_MAX', 'PriceMax', 'FLOAT', false, null, 0); + $this->addColumn('WEIGHT_MAX', 'WeightMax', 'FLOAT', false, null, 0); + $this->addColumn('PRICE', 'Price', 'FLOAT', false, null, 0); + } // initialize() + + /** + * Build the RelationMap objects for this table relationships + */ + public function buildRelations() + { + $this->addRelation('Area', '\\Thelia\\Model\\Area', RelationMap::MANY_TO_ONE, array('area_id' => 'id', ), 'CASCADE', 'RESTRICT'); + } // buildRelations() + + /** + * Retrieves a string version of the primary key from the DB resultset row that can be used to uniquely identify a row in this table. + * + * For tables with a single-column primary key, that simple pkey value will be returned. For tables with + * a multi-column primary key, a serialize()d version of the primary key will be returned. + * + * @param array $row resultset row. + * @param int $offset The 0-based offset for reading from the resultset row. + * @param string $indexType One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM + */ + public static function getPrimaryKeyHashFromRow($row, $offset = 0, $indexType = TableMap::TYPE_NUM) + { + // If the PK cannot be derived from the row, return NULL. + if ($row[TableMap::TYPE_NUM == $indexType ? 0 + $offset : static::translateFieldName('Id', TableMap::TYPE_PHPNAME, $indexType)] === null) { + return null; + } + + return (string) $row[TableMap::TYPE_NUM == $indexType ? 0 + $offset : static::translateFieldName('Id', TableMap::TYPE_PHPNAME, $indexType)]; + } + + /** + * Retrieves the primary key from the DB resultset row + * For tables with a single-column primary key, that simple pkey value will be returned. For tables with + * a multi-column primary key, an array of the primary key columns will be returned. + * + * @param array $row resultset row. + * @param int $offset The 0-based offset for reading from the resultset row. + * @param string $indexType One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM + * + * @return mixed The primary key of the row + */ + public static function getPrimaryKeyFromRow($row, $offset = 0, $indexType = TableMap::TYPE_NUM) + { + + return (int) $row[ + $indexType == TableMap::TYPE_NUM + ? 0 + $offset + : self::translateFieldName('Id', TableMap::TYPE_PHPNAME, $indexType) + ]; + } + + /** + * The class that the tableMap will make instances of. + * + * If $withPrefix is true, the returned path + * uses a dot-path notation which is translated into a path + * relative to a location on the PHP include_path. + * (e.g. path.to.MyClass -> 'path/to/MyClass.php') + * + * @param boolean $withPrefix Whether or not to return the path with the class name + * @return string path.to.ClassName + */ + public static function getOMClass($withPrefix = true) + { + return $withPrefix ? CustomDeliverySliceTableMap::CLASS_DEFAULT : CustomDeliverySliceTableMap::OM_CLASS; + } + + /** + * Populates an object of the default type or an object that inherit from the default. + * + * @param array $row row returned by DataFetcher->fetch(). + * @param int $offset The 0-based offset for reading from the resultset row. + * @param string $indexType The index type of $row. Mostly DataFetcher->getIndexType(). + One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME + * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. + * + * @throws PropelException Any exceptions caught during processing will be + * rethrown wrapped into a PropelException. + * @return array (CustomDeliverySlice object, last column rank) + */ + public static function populateObject($row, $offset = 0, $indexType = TableMap::TYPE_NUM) + { + $key = CustomDeliverySliceTableMap::getPrimaryKeyHashFromRow($row, $offset, $indexType); + if (null !== ($obj = CustomDeliverySliceTableMap::getInstanceFromPool($key))) { + // We no longer rehydrate the object, since this can cause data loss. + // See http://www.propelorm.org/ticket/509 + // $obj->hydrate($row, $offset, true); // rehydrate + $col = $offset + CustomDeliverySliceTableMap::NUM_HYDRATE_COLUMNS; + } else { + $cls = CustomDeliverySliceTableMap::OM_CLASS; + $obj = new $cls(); + $col = $obj->hydrate($row, $offset, false, $indexType); + CustomDeliverySliceTableMap::addInstanceToPool($obj, $key); + } + + return array($obj, $col); + } + + /** + * The returned array will contain objects of the default type or + * objects that inherit from the default. + * + * @param DataFetcherInterface $dataFetcher + * @return array + * @throws PropelException Any exceptions caught during processing will be + * rethrown wrapped into a PropelException. + */ + public static function populateObjects(DataFetcherInterface $dataFetcher) + { + $results = array(); + + // set the class once to avoid overhead in the loop + $cls = static::getOMClass(false); + // populate the object(s) + while ($row = $dataFetcher->fetch()) { + $key = CustomDeliverySliceTableMap::getPrimaryKeyHashFromRow($row, 0, $dataFetcher->getIndexType()); + if (null !== ($obj = CustomDeliverySliceTableMap::getInstanceFromPool($key))) { + // We no longer rehydrate the object, since this can cause data loss. + // See http://www.propelorm.org/ticket/509 + // $obj->hydrate($row, 0, true); // rehydrate + $results[] = $obj; + } else { + $obj = new $cls(); + $obj->hydrate($row); + $results[] = $obj; + CustomDeliverySliceTableMap::addInstanceToPool($obj, $key); + } // if key exists + } + + return $results; + } + /** + * Add all the columns needed to create a new object. + * + * Note: any columns that were marked with lazyLoad="true" in the + * XML schema will not be added to the select list and only loaded + * on demand. + * + * @param Criteria $criteria object containing the columns to add. + * @param string $alias optional table alias + * @throws PropelException Any exceptions caught during processing will be + * rethrown wrapped into a PropelException. + */ + public static function addSelectColumns(Criteria $criteria, $alias = null) + { + if (null === $alias) { + $criteria->addSelectColumn(CustomDeliverySliceTableMap::ID); + $criteria->addSelectColumn(CustomDeliverySliceTableMap::AREA_ID); + $criteria->addSelectColumn(CustomDeliverySliceTableMap::PRICE_MAX); + $criteria->addSelectColumn(CustomDeliverySliceTableMap::WEIGHT_MAX); + $criteria->addSelectColumn(CustomDeliverySliceTableMap::PRICE); + } else { + $criteria->addSelectColumn($alias . '.ID'); + $criteria->addSelectColumn($alias . '.AREA_ID'); + $criteria->addSelectColumn($alias . '.PRICE_MAX'); + $criteria->addSelectColumn($alias . '.WEIGHT_MAX'); + $criteria->addSelectColumn($alias . '.PRICE'); + } + } + + /** + * Returns the TableMap related to this object. + * This method is not needed for general use but a specific application could have a need. + * @return TableMap + * @throws PropelException Any exceptions caught during processing will be + * rethrown wrapped into a PropelException. + */ + public static function getTableMap() + { + return Propel::getServiceContainer()->getDatabaseMap(CustomDeliverySliceTableMap::DATABASE_NAME)->getTable(CustomDeliverySliceTableMap::TABLE_NAME); + } + + /** + * Add a TableMap instance to the database for this tableMap class. + */ + public static function buildTableMap() + { + $dbMap = Propel::getServiceContainer()->getDatabaseMap(CustomDeliverySliceTableMap::DATABASE_NAME); + if (!$dbMap->hasTable(CustomDeliverySliceTableMap::TABLE_NAME)) { + $dbMap->addTableObject(new CustomDeliverySliceTableMap()); + } + } + + /** + * Performs a DELETE on the database, given a CustomDeliverySlice or Criteria object OR a primary key value. + * + * @param mixed $values Criteria or CustomDeliverySlice object or primary key or array of primary keys + * which is used to create the DELETE statement + * @param ConnectionInterface $con the connection to use + * @return int The number of affected rows (if supported by underlying database driver). This includes CASCADE-related rows + * if supported by native driver or if emulated using Propel. + * @throws PropelException Any exceptions caught during processing will be + * rethrown wrapped into a PropelException. + */ + public static function doDelete($values, ConnectionInterface $con = null) + { + if (null === $con) { + $con = Propel::getServiceContainer()->getWriteConnection(CustomDeliverySliceTableMap::DATABASE_NAME); + } + + if ($values instanceof Criteria) { + // rename for clarity + $criteria = $values; + } elseif ($values instanceof \CustomDelivery\Model\CustomDeliverySlice) { // it's a model object + // create criteria based on pk values + $criteria = $values->buildPkeyCriteria(); + } else { // it's a primary key, or an array of pks + $criteria = new Criteria(CustomDeliverySliceTableMap::DATABASE_NAME); + $criteria->add(CustomDeliverySliceTableMap::ID, (array) $values, Criteria::IN); + } + + $query = CustomDeliverySliceQuery::create()->mergeWith($criteria); + + if ($values instanceof Criteria) { CustomDeliverySliceTableMap::clearInstancePool(); + } elseif (!is_object($values)) { // it's a primary key, or an array of pks + foreach ((array) $values as $singleval) { CustomDeliverySliceTableMap::removeInstanceFromPool($singleval); + } + } + + return $query->delete($con); + } + + /** + * Deletes all rows from the custom_delivery_slice table. + * + * @param ConnectionInterface $con the connection to use + * @return int The number of affected rows (if supported by underlying database driver). + */ + public static function doDeleteAll(ConnectionInterface $con = null) + { + return CustomDeliverySliceQuery::create()->doDeleteAll($con); + } + + /** + * Performs an INSERT on the database, given a CustomDeliverySlice or Criteria object. + * + * @param mixed $criteria Criteria or CustomDeliverySlice object containing data that is used to create the INSERT statement. + * @param ConnectionInterface $con the ConnectionInterface connection to use + * @return mixed The new primary key. + * @throws PropelException Any exceptions caught during processing will be + * rethrown wrapped into a PropelException. + */ + public static function doInsert($criteria, ConnectionInterface $con = null) + { + if (null === $con) { + $con = Propel::getServiceContainer()->getWriteConnection(CustomDeliverySliceTableMap::DATABASE_NAME); + } + + if ($criteria instanceof Criteria) { + $criteria = clone $criteria; // rename for clarity + } else { + $criteria = $criteria->buildCriteria(); // build Criteria from CustomDeliverySlice object + } + + if ($criteria->containsKey(CustomDeliverySliceTableMap::ID) && $criteria->keyContainsValue(CustomDeliverySliceTableMap::ID) ) { + throw new PropelException('Cannot insert a value for auto-increment primary key ('.CustomDeliverySliceTableMap::ID.')'); + } + + + // Set the correct dbName + $query = CustomDeliverySliceQuery::create()->mergeWith($criteria); + + try { + // use transaction because $criteria could contain info + // for more than one table (I guess, conceivably) + $con->beginTransaction(); + $pk = $query->doInsert($con); + $con->commit(); + } catch (PropelException $e) { + $con->rollBack(); + throw $e; + } + + return $pk; + } + +} // CustomDeliverySliceTableMap +// This is the static code needed to register the TableMap for this table with the main Propel class. +// +CustomDeliverySliceTableMap::buildTableMap(); diff --git a/local/modules/CustomDelivery/Readme.md b/local/modules/CustomDelivery/Readme.md new file mode 100644 index 00000000..dd824740 --- /dev/null +++ b/local/modules/CustomDelivery/Readme.md @@ -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 ```/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`. diff --git a/local/modules/CustomDelivery/composer.json b/local/modules/CustomDelivery/composer.json new file mode 100644 index 00000000..277e4154 --- /dev/null +++ b/local/modules/CustomDelivery/composer.json @@ -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" + } +} \ No newline at end of file diff --git a/local/modules/CustomDelivery/templates/backOffice/default/configuration.html b/local/modules/CustomDelivery/templates/backOffice/default/configuration.html new file mode 100644 index 00000000..9d6e3ef4 --- /dev/null +++ b/local/modules/CustomDelivery/templates/backOffice/default/configuration.html @@ -0,0 +1,195 @@ + +
+
+ +
+ {intl d='customdelivery.bo.default' l='Configuration.'} +
+ +
+
+ + {form name="customdelivery.configuration.form"} + + + {if $form_error_message}
{$form_error_message}
{/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"} +
+ + + +
+ {/form_field} + + + + + {/form} + +
+ +
+ +
+
+ + +{* default currency *} +{loop type="currency" name="default_currency" default_only="1"} + {$currencySymbol=$SYMBOL} +{/loop} + + +
+
+ +
+ {intl d='customdelivery.bo.default' l='Slices.'} +
+ +
+ + {loop type="area" name="area" module_id=$module_id backend_context=true} + {$area_id=$ID} +
+
+ + + + + {if $method != 2}{/if} + {if $method != 1}{/if} + + + + + + {loop type="custom-delivery-slice" name="custom-delivery-slice" area_id=$area_id order="weight_max,price_max" } + + {if $method != 2} + + {/if} + {if $method != 1} + + {/if} + + + + {/loop} + + {* New slice *} + {loop type="auth" name="can_change" role="ADMIN" module="customdelivery" access="CREATE"} + + {if $method != 2} + + {/if} + {if $method != 1} + + {/if} + + + + {/loop} + +
+ {intl d='customdelivery.bo.default' l="Area : "} {$NAME} +
{intl d='customdelivery.bo.default' l="Untaxed Price up to ... %symbol" symbol=$currencySymbol}{intl d='customdelivery.bo.default' l="Weight up to ... kg"}{intl d='customdelivery.bo.default' l="Price (%symbol)" symbol=$currencySymbol}{intl d='customdelivery.bo.default' l="Actions"}
+ + + + + + +
+ {loop type="auth" name="can_change" role="ADMIN" module="customdelivery" access="UPDATE"} + + + + {/loop} + {loop type="auth" name="can_change" role="ADMIN" module="customdelivery" access="DELETE"} + + + + {/loop} +
+
+ + + + + + + + + +
+
+
+ + {/loop} + {elseloop rel="area"} +
+
+ {intl d='customdelivery.bo.default' l="You should first attribute shipping zones to the modules: "} + + {intl d='customdelivery.bo.default' l="manage shipping zones"} + +
+
+ {/elseloop} +
+ +
+
+ +{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 *} + diff --git a/local/modules/CustomDelivery/templates/backOffice/default/module-config-js.html b/local/modules/CustomDelivery/templates/backOffice/default/module-config-js.html new file mode 100644 index 00000000..f0649827 --- /dev/null +++ b/local/modules/CustomDelivery/templates/backOffice/default/module-config-js.html @@ -0,0 +1,127 @@ + +{javascripts file='assets/js/libs/underscore-min.js'} + +{/javascripts} + + \ No newline at end of file diff --git a/local/modules/CustomDelivery/templates/email/default/custom-delivery-shipping.html b/local/modules/CustomDelivery/templates/email/default/custom-delivery-shipping.html new file mode 100644 index 00000000..0b1137e6 --- /dev/null +++ b/local/modules/CustomDelivery/templates/email/default/custom-delivery-shipping.html @@ -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"} +

{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."}

\ No newline at end of file diff --git a/local/modules/CustomDelivery/templates/email/default/custom-delivery-shipping.txt b/local/modules/CustomDelivery/templates/email/default/custom-delivery-shipping.txt new file mode 100644 index 00000000..04f50269 --- /dev/null +++ b/local/modules/CustomDelivery/templates/email/default/custom-delivery-shipping.txt @@ -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."} \ No newline at end of file