From 04a53140c295f03c9a9409e90f1412919ef7d4ba Mon Sep 17 00:00:00 2001 From: Laurent LE CORRE Date: Mon, 2 Mar 2020 12:19:02 +0100 Subject: [PATCH] =?UTF-8?q?Int=C3=A9gration=20du=20module=20OrderStatusNot?= =?UTF-8?q?ify?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../OrderStatusNotify/Config/config.xml | 20 + .../OrderStatusNotify/Config/module.xml | 26 + .../OrderStatusNotify/Config/routing.xml | 15 + .../OrderStatusNotify/Config/schema.xml | 13 + .../OrderStatusNotify/Config/sqldb.map | 2 + .../OrderStatusNotify/Config/thelia.sql | 40 + .../Controller/Back/OrderStatusController.php | 49 + .../EventListeners/OrderStatusListener.php | 59 + .../OrderStatusNotify/Hook/BackHook.php | 30 + .../modules/OrderStatusNotify/I18n/en_US.php | 12 + .../modules/OrderStatusNotify/I18n/fr_FR.php | 12 + .../Model/Base/OrderStatusNotification.php | 1280 +++++++++++++++++ .../Base/OrderStatusNotificationQuery.php | 505 +++++++ .../Map/OrderStatusNotificationTableMap.php | 419 ++++++ .../Model/OrderStatusNotification.php | 10 + .../Model/OrderStatusNotificationQuery.php | 21 + .../OrderStatusNotify/OrderStatusNotify.php | 25 + local/modules/OrderStatusNotify/Readme.md | 31 + local/modules/OrderStatusNotify/composer.json | 11 + .../default/display-order-status.html | 55 + .../default/include/order-status-list.html | 44 + .../email/default/order_status_changed.html | 114 ++ 22 files changed, 2793 insertions(+) create mode 100644 local/modules/OrderStatusNotify/Config/config.xml create mode 100644 local/modules/OrderStatusNotify/Config/module.xml create mode 100644 local/modules/OrderStatusNotify/Config/routing.xml create mode 100644 local/modules/OrderStatusNotify/Config/schema.xml create mode 100644 local/modules/OrderStatusNotify/Config/sqldb.map create mode 100644 local/modules/OrderStatusNotify/Config/thelia.sql create mode 100644 local/modules/OrderStatusNotify/Controller/Back/OrderStatusController.php create mode 100644 local/modules/OrderStatusNotify/EventListeners/OrderStatusListener.php create mode 100644 local/modules/OrderStatusNotify/Hook/BackHook.php create mode 100644 local/modules/OrderStatusNotify/I18n/en_US.php create mode 100644 local/modules/OrderStatusNotify/I18n/fr_FR.php create mode 100644 local/modules/OrderStatusNotify/Model/Base/OrderStatusNotification.php create mode 100644 local/modules/OrderStatusNotify/Model/Base/OrderStatusNotificationQuery.php create mode 100644 local/modules/OrderStatusNotify/Model/Map/OrderStatusNotificationTableMap.php create mode 100644 local/modules/OrderStatusNotify/Model/OrderStatusNotification.php create mode 100644 local/modules/OrderStatusNotify/Model/OrderStatusNotificationQuery.php create mode 100644 local/modules/OrderStatusNotify/OrderStatusNotify.php create mode 100644 local/modules/OrderStatusNotify/Readme.md create mode 100644 local/modules/OrderStatusNotify/composer.json create mode 100644 local/modules/OrderStatusNotify/templates/backOffice/default/display-order-status.html create mode 100644 local/modules/OrderStatusNotify/templates/backOffice/default/include/order-status-list.html create mode 100644 templates/email/default/order_status_changed.html diff --git a/local/modules/OrderStatusNotify/Config/config.xml b/local/modules/OrderStatusNotify/Config/config.xml new file mode 100644 index 00000000..9bd08a13 --- /dev/null +++ b/local/modules/OrderStatusNotify/Config/config.xml @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + diff --git a/local/modules/OrderStatusNotify/Config/module.xml b/local/modules/OrderStatusNotify/Config/module.xml new file mode 100644 index 00000000..6b170978 --- /dev/null +++ b/local/modules/OrderStatusNotify/Config/module.xml @@ -0,0 +1,26 @@ + + + OrderStatusNotify\OrderStatusNotify + + Send email on order status' change + + + Envoi d'email lors du changement de statut d'une commande + + + en_US + fr_FR + + 1.0 + + + Laurent LE CORRE + laurent@thecoredev.fr + + + classic + 2.3.0 + beta + diff --git a/local/modules/OrderStatusNotify/Config/routing.xml b/local/modules/OrderStatusNotify/Config/routing.xml new file mode 100644 index 00000000..a5f63d53 --- /dev/null +++ b/local/modules/OrderStatusNotify/Config/routing.xml @@ -0,0 +1,15 @@ + + + + + + OrderStatusNotify\Controller\Back\OrderStatusController::showStatus + + + + OrderStatusNotify\Controller\Back\OrderStatusController::setToggleVisibilityAction + + + diff --git a/local/modules/OrderStatusNotify/Config/schema.xml b/local/modules/OrderStatusNotify/Config/schema.xml new file mode 100644 index 00000000..97b72849 --- /dev/null +++ b/local/modules/OrderStatusNotify/Config/schema.xml @@ -0,0 +1,13 @@ + + + + + + + + + + +
+ + diff --git a/local/modules/OrderStatusNotify/Config/sqldb.map b/local/modules/OrderStatusNotify/Config/sqldb.map new file mode 100644 index 00000000..63a93baa --- /dev/null +++ b/local/modules/OrderStatusNotify/Config/sqldb.map @@ -0,0 +1,2 @@ +# Sqlfile -> Database map +thelia.sql=thelia diff --git a/local/modules/OrderStatusNotify/Config/thelia.sql b/local/modules/OrderStatusNotify/Config/thelia.sql new file mode 100644 index 00000000..c80ecd32 --- /dev/null +++ b/local/modules/OrderStatusNotify/Config/thelia.sql @@ -0,0 +1,40 @@ + +# 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; + +-- --------------------------------------------------------------------- +-- order_status_notification +-- --------------------------------------------------------------------- + +DROP TABLE IF EXISTS `order_status_notification`; + +CREATE TABLE `order_status_notification` +( + `id` INTEGER NOT NULL AUTO_INCREMENT, + `order_status_id` INTEGER NOT NULL, + `to_notify` TINYINT(1) DEFAULT 0 NOT NULL, + PRIMARY KEY (`id`), + INDEX `FI_order_status_notify_id` (`order_status_id`), + CONSTRAINT `fk_order_status_notify_id` + FOREIGN KEY (`order_status_id`) + REFERENCES `order_status` (`id`) + ON UPDATE RESTRICT + ON DELETE CASCADE +) ENGINE=InnoDB; + +# This restores the fkey checks, after having unset them earlier +SET FOREIGN_KEY_CHECKS = 1; + +-- --------------------------------------------------------------------- +-- Affectation du modèle d'email +-- --------------------------------------------------------------------- +INSERT INTO `message` (name,secured,text_layout_file_name,text_template_file_name,html_layout_file_name,html_template_file_name,created_at,updated_at,version,version_created_at,version_created_by) VALUES +('order_status_changed',NULL,NULL,NULL,NULL,'order_status_changed.html','2020-02-12 19:18:35.0','2020-03-01 09:56:48.0',3,'2020-03-01 09:56:48.0',NULL); + +INSERT INTO `message_i18n` (id,locale,title,subject,text_message,html_message) +(SELECT max(id), 'fr_FR','Informer le client du changement de statut de sa commande','Votre commande {$order_ref} chez {config key="store_name"}',NULL,'Bonjour, + + +Votre commande référence {$order_ref} vient de passer à l''état {$new_status}.' +from `message`); diff --git a/local/modules/OrderStatusNotify/Controller/Back/OrderStatusController.php b/local/modules/OrderStatusNotify/Controller/Back/OrderStatusController.php new file mode 100644 index 00000000..a6c29821 --- /dev/null +++ b/local/modules/OrderStatusNotify/Controller/Back/OrderStatusController.php @@ -0,0 +1,49 @@ + + */ +class OrderStatusController extends BaseAdminController +{ + public function showStatus() + { + $vars = ''; + if (null !== $result = OrderStatusNotificationQuery::create()->findByToNotify(true)) { + foreach ($result->getData() as $order_status) { + // Il faut serialiser le tableau afin de pouvoir l'exploiter dans la page HTML. + $vars .= $order_status->getOrderStatusId() . ','; + } + } + return $this->render('display-order-status', ['status' => $vars]); + } + + public function setToggleVisibilityAction() + { + try { + $order_status_to_modify = $_GET['order_status_id']; + $current_order_status = OrderStatusNotificationQuery::create()->findOneByOrderStatusId($order_status_to_modify); + if (null === $current_order_status) { + $new_order_status = new OrderStatusNotification(); + $new_order_status->setOrderStatusId($order_status_to_modify); + $new_order_status->setToNotify(true); + $new_order_status->save(); + } + else { + $current_order_status->delete(); + } + } catch (\Exception $ex) { + // Any error + return $this->errorPage($ex); + } + + return $this->nullResponse(); + } +} \ No newline at end of file diff --git a/local/modules/OrderStatusNotify/EventListeners/OrderStatusListener.php b/local/modules/OrderStatusNotify/EventListeners/OrderStatusListener.php new file mode 100644 index 00000000..b3a836aa --- /dev/null +++ b/local/modules/OrderStatusNotify/EventListeners/OrderStatusListener.php @@ -0,0 +1,59 @@ +mailer = $mailer; + } + + public static function getSubscribedEvents() + { + return [TheliaEvents::ORDER_UPDATE_STATUS => array("updateStatus", 200)]; + } + + public function updateStatus(OrderEvent $event) + { + $order = $event->getOrder(); + $new_status_id = $event->getStatus(); + + $is_order_status_to_notify = OrderStatusNotificationQuery::create()->findOneByOrderStatusId($new_status_id); + if (null !== $is_order_status_to_notify) { + $new_statut_label = OrderStatusI18nQuery::create() + ->filterByLocale($order->getLang()->getLocale()) + ->findOneById($new_status_id) + ->getTitle(); + + $this->mailer->sendEmailToCustomer( + OrderStatusNotify::MESSAGE_NAME, + $order->getCustomer(), + [ + 'order_id' => $order->getId(), + 'order_ref' => $order->getRef(), + 'new_status' => $new_statut_label, + ] + ); + Tlog::getInstance()->debug("Order status change sent to customer " . $order->getCustomer()->getEmail()); + } + } +} diff --git a/local/modules/OrderStatusNotify/Hook/BackHook.php b/local/modules/OrderStatusNotify/Hook/BackHook.php new file mode 100644 index 00000000..91bdcf7c --- /dev/null +++ b/local/modules/OrderStatusNotify/Hook/BackHook.php @@ -0,0 +1,30 @@ +add( + [ + 'id' => 'tools_menu_orderstatusnotify', + 'class' => '', + 'url' => URL::getInstance()->absoluteUrl('/admin/module/orderstatusnotify'), + 'title' => $this->trans('Order status notification', [], OrderStatusNotify::DOMAIN_NAME) + ] + ); + } +} + + diff --git a/local/modules/OrderStatusNotify/I18n/en_US.php b/local/modules/OrderStatusNotify/I18n/en_US.php new file mode 100644 index 00000000..beb6c42a --- /dev/null +++ b/local/modules/OrderStatusNotify/I18n/en_US.php @@ -0,0 +1,12 @@ + 'Order\'s status change notification', + 'Home' => 'Home', + 'Tools' => 'Tools', + 'To notify' => 'Notify to customer', + 'Status' => 'Order status', + 'Status list' => 'Order status list', + 'Purpose of feature' => 'Please select order status you want to notify the customer : an email will be sent when the order will get to this status.', + 'Change on your order %ref on %store_name' => 'Change on your order %ref on %store_name', + 'Hello, your order has just changed to' => 'Hello, your order has just changed to status : ', +); diff --git a/local/modules/OrderStatusNotify/I18n/fr_FR.php b/local/modules/OrderStatusNotify/I18n/fr_FR.php new file mode 100644 index 00000000..074726e0 --- /dev/null +++ b/local/modules/OrderStatusNotify/I18n/fr_FR.php @@ -0,0 +1,12 @@ + 'Notifier des changements de statut', + 'Home' => 'Accueil', + 'Tools' => 'Outils', + 'To notify' => 'A notifier au client', + 'Status' => 'Statut de la commande', + 'Status list' => 'Liste des statuts de commande', + 'Purpose of feature' => 'Veuillez sélectionner les statuts de commande pour lesquels vous souhaitez notifier le client : dès que la commande passera dans ce statut, un email sera envoyé au client.', + 'Change on your order %ref on %store_name' => 'Evolution sur votre commande %ref sur le site %store_name', + 'Hello, your order has just changed to' => 'Bonjour, votre commande vient de passer à l\'état : ', +]; diff --git a/local/modules/OrderStatusNotify/Model/Base/OrderStatusNotification.php b/local/modules/OrderStatusNotify/Model/Base/OrderStatusNotification.php new file mode 100644 index 00000000..6d2a6234 --- /dev/null +++ b/local/modules/OrderStatusNotify/Model/Base/OrderStatusNotification.php @@ -0,0 +1,1280 @@ +to_notify = false; + } + + /** + * Initializes internal state of OrderStatusNotify\Model\Base\OrderStatusNotification 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 OrderStatusNotification instance. If + * obj is an instance of OrderStatusNotification, delegates to + * equals(OrderStatusNotification). 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 OrderStatusNotification 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 OrderStatusNotification 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 [order_status_id] column value. + * + * @return int + */ + public function getOrderStatusId() + { + + return $this->order_status_id; + } + + /** + * Get the [to_notify] column value. + * + * @return boolean + */ + public function getToNotify() + { + + return $this->to_notify; + } + + /** + * Set the value of [id] column. + * + * @param int $v new value + * @return \OrderStatusNotify\Model\OrderStatusNotification 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[OrderStatusNotificationTableMap::ID] = true; + } + + + return $this; + } // setId() + + /** + * Set the value of [order_status_id] column. + * + * @param int $v new value + * @return \OrderStatusNotify\Model\OrderStatusNotification The current object (for fluent API support) + */ + public function setOrderStatusId($v) + { + if ($v !== null) { + $v = (int) $v; + } + + if ($this->order_status_id !== $v) { + $this->order_status_id = $v; + $this->modifiedColumns[OrderStatusNotificationTableMap::ORDER_STATUS_ID] = true; + } + + if ($this->aOrderStatus !== null && $this->aOrderStatus->getId() !== $v) { + $this->aOrderStatus = null; + } + + + return $this; + } // setOrderStatusId() + + /** + * Sets the value of the [to_notify] column. + * Non-boolean arguments are converted using the following rules: + * * 1, '1', 'true', 'on', and 'yes' are converted to boolean true + * * 0, '0', 'false', 'off', and 'no' are converted to boolean false + * Check on string values is case insensitive (so 'FaLsE' is seen as 'false'). + * + * @param boolean|integer|string $v The new value + * @return \OrderStatusNotify\Model\OrderStatusNotification The current object (for fluent API support) + */ + public function setToNotify($v) + { + if ($v !== null) { + if (is_string($v)) { + $v = in_array(strtolower($v), array('false', 'off', '-', 'no', 'n', '0', '')) ? false : true; + } else { + $v = (boolean) $v; + } + } + + if ($this->to_notify !== $v) { + $this->to_notify = $v; + $this->modifiedColumns[OrderStatusNotificationTableMap::TO_NOTIFY] = true; + } + + + return $this; + } // setToNotify() + + /** + * 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->to_notify !== false) { + 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 : OrderStatusNotificationTableMap::translateFieldName('Id', TableMap::TYPE_PHPNAME, $indexType)]; + $this->id = (null !== $col) ? (int) $col : null; + + $col = $row[TableMap::TYPE_NUM == $indexType ? 1 + $startcol : OrderStatusNotificationTableMap::translateFieldName('OrderStatusId', TableMap::TYPE_PHPNAME, $indexType)]; + $this->order_status_id = (null !== $col) ? (int) $col : null; + + $col = $row[TableMap::TYPE_NUM == $indexType ? 2 + $startcol : OrderStatusNotificationTableMap::translateFieldName('ToNotify', TableMap::TYPE_PHPNAME, $indexType)]; + $this->to_notify = (null !== $col) ? (boolean) $col : null; + $this->resetModified(); + + $this->setNew(false); + + if ($rehydrate) { + $this->ensureConsistency(); + } + + return $startcol + 3; // 3 = OrderStatusNotificationTableMap::NUM_HYDRATE_COLUMNS. + + } catch (Exception $e) { + throw new PropelException("Error populating \OrderStatusNotify\Model\OrderStatusNotification 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->aOrderStatus !== null && $this->order_status_id !== $this->aOrderStatus->getId()) { + $this->aOrderStatus = 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(OrderStatusNotificationTableMap::DATABASE_NAME); + } + + // We don't need to alter the object instance pool; we're just modifying this instance + // already in the pool. + + $dataFetcher = ChildOrderStatusNotificationQuery::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->aOrderStatus = null; + } // if (deep) + } + + /** + * Removes this object from datastore and sets delete attribute. + * + * @param ConnectionInterface $con + * @return void + * @throws PropelException + * @see OrderStatusNotification::setDeleted() + * @see OrderStatusNotification::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(OrderStatusNotificationTableMap::DATABASE_NAME); + } + + $con->beginTransaction(); + try { + $deleteQuery = ChildOrderStatusNotificationQuery::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(OrderStatusNotificationTableMap::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); + OrderStatusNotificationTableMap::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->aOrderStatus !== null) { + if ($this->aOrderStatus->isModified() || $this->aOrderStatus->isNew()) { + $affectedRows += $this->aOrderStatus->save($con); + } + $this->setOrderStatus($this->aOrderStatus); + } + + 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[OrderStatusNotificationTableMap::ID] = true; + if (null !== $this->id) { + throw new PropelException('Cannot insert a value for auto-increment primary key (' . OrderStatusNotificationTableMap::ID . ')'); + } + + // check the columns in natural order for more readable SQL queries + if ($this->isColumnModified(OrderStatusNotificationTableMap::ID)) { + $modifiedColumns[':p' . $index++] = 'ID'; + } + if ($this->isColumnModified(OrderStatusNotificationTableMap::ORDER_STATUS_ID)) { + $modifiedColumns[':p' . $index++] = 'ORDER_STATUS_ID'; + } + if ($this->isColumnModified(OrderStatusNotificationTableMap::TO_NOTIFY)) { + $modifiedColumns[':p' . $index++] = 'TO_NOTIFY'; + } + + $sql = sprintf( + 'INSERT INTO order_status_notification (%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 'ORDER_STATUS_ID': + $stmt->bindValue($identifier, $this->order_status_id, PDO::PARAM_INT); + break; + case 'TO_NOTIFY': + $stmt->bindValue($identifier, (int) $this->to_notify, PDO::PARAM_INT); + 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 = OrderStatusNotificationTableMap::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->getOrderStatusId(); + break; + case 2: + return $this->getToNotify(); + 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['OrderStatusNotification'][$this->getPrimaryKey()])) { + return '*RECURSION*'; + } + $alreadyDumpedObjects['OrderStatusNotification'][$this->getPrimaryKey()] = true; + $keys = OrderStatusNotificationTableMap::getFieldNames($keyType); + $result = array( + $keys[0] => $this->getId(), + $keys[1] => $this->getOrderStatusId(), + $keys[2] => $this->getToNotify(), + ); + $virtualColumns = $this->virtualColumns; + foreach ($virtualColumns as $key => $virtualColumn) { + $result[$key] = $virtualColumn; + } + + if ($includeForeignObjects) { + if (null !== $this->aOrderStatus) { + $result['OrderStatus'] = $this->aOrderStatus->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 = OrderStatusNotificationTableMap::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->setOrderStatusId($value); + break; + case 2: + $this->setToNotify($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 = OrderStatusNotificationTableMap::getFieldNames($keyType); + + if (array_key_exists($keys[0], $arr)) $this->setId($arr[$keys[0]]); + if (array_key_exists($keys[1], $arr)) $this->setOrderStatusId($arr[$keys[1]]); + if (array_key_exists($keys[2], $arr)) $this->setToNotify($arr[$keys[2]]); + } + + /** + * 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(OrderStatusNotificationTableMap::DATABASE_NAME); + + if ($this->isColumnModified(OrderStatusNotificationTableMap::ID)) $criteria->add(OrderStatusNotificationTableMap::ID, $this->id); + if ($this->isColumnModified(OrderStatusNotificationTableMap::ORDER_STATUS_ID)) $criteria->add(OrderStatusNotificationTableMap::ORDER_STATUS_ID, $this->order_status_id); + if ($this->isColumnModified(OrderStatusNotificationTableMap::TO_NOTIFY)) $criteria->add(OrderStatusNotificationTableMap::TO_NOTIFY, $this->to_notify); + + 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(OrderStatusNotificationTableMap::DATABASE_NAME); + $criteria->add(OrderStatusNotificationTableMap::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 \OrderStatusNotify\Model\OrderStatusNotification (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->setOrderStatusId($this->getOrderStatusId()); + $copyObj->setToNotify($this->getToNotify()); + 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 \OrderStatusNotify\Model\OrderStatusNotification 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 ChildOrderStatus object. + * + * @param ChildOrderStatus $v + * @return \OrderStatusNotify\Model\OrderStatusNotification The current object (for fluent API support) + * @throws PropelException + */ + public function setOrderStatus(ChildOrderStatus $v = null) + { + if ($v === null) { + $this->setOrderStatusId(NULL); + } else { + $this->setOrderStatusId($v->getId()); + } + + $this->aOrderStatus = $v; + + // Add binding for other direction of this n:n relationship. + // If this object has already been added to the ChildOrderStatus object, it will not be re-added. + if ($v !== null) { + $v->addOrderStatusNotification($this); + } + + + return $this; + } + + + /** + * Get the associated ChildOrderStatus object + * + * @param ConnectionInterface $con Optional Connection object. + * @return ChildOrderStatus The associated ChildOrderStatus object. + * @throws PropelException + */ + public function getOrderStatus(ConnectionInterface $con = null) + { + if ($this->aOrderStatus === null && ($this->order_status_id !== null)) { + $this->aOrderStatus = OrderStatusQuery::create()->findPk($this->order_status_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->aOrderStatus->addOrderStatusNotifications($this); + */ + } + + return $this->aOrderStatus; + } + + /** + * Clears the current object and sets all attributes to their default values + */ + public function clear() + { + $this->id = null; + $this->order_status_id = null; + $this->to_notify = 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->aOrderStatus = null; + } + + /** + * Return the string representation of this object + * + * @return string + */ + public function __toString() + { + return (string) $this->exportTo(OrderStatusNotificationTableMap::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/OrderStatusNotify/Model/Base/OrderStatusNotificationQuery.php b/local/modules/OrderStatusNotify/Model/Base/OrderStatusNotificationQuery.php new file mode 100644 index 00000000..3ceee9fd --- /dev/null +++ b/local/modules/OrderStatusNotify/Model/Base/OrderStatusNotificationQuery.php @@ -0,0 +1,505 @@ +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 ChildOrderStatusNotification|array|mixed the result, formatted by the current formatter + */ + public function findPk($key, $con = null) + { + if ($key === null) { + return null; + } + if ((null !== ($obj = OrderStatusNotificationTableMap::getInstanceFromPool((string) $key))) && !$this->formatter) { + // the object is already in the instance pool + return $obj; + } + if ($con === null) { + $con = Propel::getServiceContainer()->getReadConnection(OrderStatusNotificationTableMap::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 ChildOrderStatusNotification A model object, or null if the key is not found + */ + protected function findPkSimple($key, $con) + { + $sql = 'SELECT ID, ORDER_STATUS_ID, TO_NOTIFY FROM order_status_notification 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 ChildOrderStatusNotification(); + $obj->hydrate($row); + OrderStatusNotificationTableMap::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 ChildOrderStatusNotification|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 ChildOrderStatusNotificationQuery The current query, for fluid interface + */ + public function filterByPrimaryKey($key) + { + + return $this->addUsingAlias(OrderStatusNotificationTableMap::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 ChildOrderStatusNotificationQuery The current query, for fluid interface + */ + public function filterByPrimaryKeys($keys) + { + + return $this->addUsingAlias(OrderStatusNotificationTableMap::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 ChildOrderStatusNotificationQuery 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(OrderStatusNotificationTableMap::ID, $id['min'], Criteria::GREATER_EQUAL); + $useMinMax = true; + } + if (isset($id['max'])) { + $this->addUsingAlias(OrderStatusNotificationTableMap::ID, $id['max'], Criteria::LESS_EQUAL); + $useMinMax = true; + } + if ($useMinMax) { + return $this; + } + if (null === $comparison) { + $comparison = Criteria::IN; + } + } + + return $this->addUsingAlias(OrderStatusNotificationTableMap::ID, $id, $comparison); + } + + /** + * Filter the query on the order_status_id column + * + * Example usage: + * + * $query->filterByOrderStatusId(1234); // WHERE order_status_id = 1234 + * $query->filterByOrderStatusId(array(12, 34)); // WHERE order_status_id IN (12, 34) + * $query->filterByOrderStatusId(array('min' => 12)); // WHERE order_status_id > 12 + * + * + * @see filterByOrderStatus() + * + * @param mixed $orderStatusId 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 ChildOrderStatusNotificationQuery The current query, for fluid interface + */ + public function filterByOrderStatusId($orderStatusId = null, $comparison = null) + { + if (is_array($orderStatusId)) { + $useMinMax = false; + if (isset($orderStatusId['min'])) { + $this->addUsingAlias(OrderStatusNotificationTableMap::ORDER_STATUS_ID, $orderStatusId['min'], Criteria::GREATER_EQUAL); + $useMinMax = true; + } + if (isset($orderStatusId['max'])) { + $this->addUsingAlias(OrderStatusNotificationTableMap::ORDER_STATUS_ID, $orderStatusId['max'], Criteria::LESS_EQUAL); + $useMinMax = true; + } + if ($useMinMax) { + return $this; + } + if (null === $comparison) { + $comparison = Criteria::IN; + } + } + + return $this->addUsingAlias(OrderStatusNotificationTableMap::ORDER_STATUS_ID, $orderStatusId, $comparison); + } + + /** + * Filter the query on the to_notify column + * + * Example usage: + * + * $query->filterByToNotify(true); // WHERE to_notify = true + * $query->filterByToNotify('yes'); // WHERE to_notify = true + * + * + * @param boolean|string $toNotify The value to use as filter. + * Non-boolean arguments are converted using the following rules: + * * 1, '1', 'true', 'on', and 'yes' are converted to boolean true + * * 0, '0', 'false', 'off', and 'no' are converted to boolean false + * Check on string values is case insensitive (so 'FaLsE' is seen as 'false'). + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return ChildOrderStatusNotificationQuery The current query, for fluid interface + */ + public function filterByToNotify($toNotify = null, $comparison = null) + { + if (is_string($toNotify)) { + $to_notify = in_array(strtolower($toNotify), array('false', 'off', '-', 'no', 'n', '0', '')) ? false : true; + } + + return $this->addUsingAlias(OrderStatusNotificationTableMap::TO_NOTIFY, $toNotify, $comparison); + } + + /** + * Filter the query by a related \OrderStatusNotify\Model\Thelia\Model\OrderStatus object + * + * @param \OrderStatusNotify\Model\Thelia\Model\OrderStatus|ObjectCollection $orderStatus The related object(s) to use as filter + * @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL + * + * @return ChildOrderStatusNotificationQuery The current query, for fluid interface + */ + public function filterByOrderStatus($orderStatus, $comparison = null) + { + if ($orderStatus instanceof \OrderStatusNotify\Model\Thelia\Model\OrderStatus) { + return $this + ->addUsingAlias(OrderStatusNotificationTableMap::ORDER_STATUS_ID, $orderStatus->getId(), $comparison); + } elseif ($orderStatus instanceof ObjectCollection) { + if (null === $comparison) { + $comparison = Criteria::IN; + } + + return $this + ->addUsingAlias(OrderStatusNotificationTableMap::ORDER_STATUS_ID, $orderStatus->toKeyValue('PrimaryKey', 'Id'), $comparison); + } else { + throw new PropelException('filterByOrderStatus() only accepts arguments of type \OrderStatusNotify\Model\Thelia\Model\OrderStatus or Collection'); + } + } + + /** + * Adds a JOIN clause to the query using the OrderStatus relation + * + * @param string $relationAlias optional alias for the relation + * @param string $joinType Accepted values are null, 'left join', 'right join', 'inner join' + * + * @return ChildOrderStatusNotificationQuery The current query, for fluid interface + */ + public function joinOrderStatus($relationAlias = null, $joinType = Criteria::INNER_JOIN) + { + $tableMap = $this->getTableMap(); + $relationMap = $tableMap->getRelation('OrderStatus'); + + // 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, 'OrderStatus'); + } + + return $this; + } + + /** + * Use the OrderStatus relation OrderStatus 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 \OrderStatusNotify\Model\Thelia\Model\OrderStatusQuery A secondary query class using the current class as primary query + */ + public function useOrderStatusQuery($relationAlias = null, $joinType = Criteria::INNER_JOIN) + { + return $this + ->joinOrderStatus($relationAlias, $joinType) + ->useQuery($relationAlias ? $relationAlias : 'OrderStatus', '\OrderStatusNotify\Model\Thelia\Model\OrderStatusQuery'); + } + + /** + * Exclude object from result + * + * @param ChildOrderStatusNotification $orderStatusNotification Object to remove from the list of results + * + * @return ChildOrderStatusNotificationQuery The current query, for fluid interface + */ + public function prune($orderStatusNotification = null) + { + if ($orderStatusNotification) { + $this->addUsingAlias(OrderStatusNotificationTableMap::ID, $orderStatusNotification->getId(), Criteria::NOT_EQUAL); + } + + return $this; + } + + /** + * Deletes all rows from the order_status_notification 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(OrderStatusNotificationTableMap::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). + OrderStatusNotificationTableMap::clearInstancePool(); + OrderStatusNotificationTableMap::clearRelatedInstancePool(); + + $con->commit(); + } catch (PropelException $e) { + $con->rollBack(); + throw $e; + } + + return $affectedRows; + } + + /** + * Performs a DELETE on the database, given a ChildOrderStatusNotification or Criteria object OR a primary key value. + * + * @param mixed $values Criteria or ChildOrderStatusNotification 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(OrderStatusNotificationTableMap::DATABASE_NAME); + } + + $criteria = $this; + + // Set the correct dbName + $criteria->setDbName(OrderStatusNotificationTableMap::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(); + + + OrderStatusNotificationTableMap::removeInstanceFromPool($criteria); + + $affectedRows += ModelCriteria::delete($con); + OrderStatusNotificationTableMap::clearRelatedInstancePool(); + $con->commit(); + + return $affectedRows; + } catch (PropelException $e) { + $con->rollBack(); + throw $e; + } + } + +} // OrderStatusNotificationQuery diff --git a/local/modules/OrderStatusNotify/Model/Map/OrderStatusNotificationTableMap.php b/local/modules/OrderStatusNotify/Model/Map/OrderStatusNotificationTableMap.php new file mode 100644 index 00000000..3c70e665 --- /dev/null +++ b/local/modules/OrderStatusNotify/Model/Map/OrderStatusNotificationTableMap.php @@ -0,0 +1,419 @@ + array('Id', 'OrderStatusId', 'ToNotify', ), + self::TYPE_STUDLYPHPNAME => array('id', 'orderStatusId', 'toNotify', ), + self::TYPE_COLNAME => array(OrderStatusNotificationTableMap::ID, OrderStatusNotificationTableMap::ORDER_STATUS_ID, OrderStatusNotificationTableMap::TO_NOTIFY, ), + self::TYPE_RAW_COLNAME => array('ID', 'ORDER_STATUS_ID', 'TO_NOTIFY', ), + self::TYPE_FIELDNAME => array('id', 'order_status_id', 'to_notify', ), + self::TYPE_NUM => array(0, 1, 2, ) + ); + + /** + * 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, 'OrderStatusId' => 1, 'ToNotify' => 2, ), + self::TYPE_STUDLYPHPNAME => array('id' => 0, 'orderStatusId' => 1, 'toNotify' => 2, ), + self::TYPE_COLNAME => array(OrderStatusNotificationTableMap::ID => 0, OrderStatusNotificationTableMap::ORDER_STATUS_ID => 1, OrderStatusNotificationTableMap::TO_NOTIFY => 2, ), + self::TYPE_RAW_COLNAME => array('ID' => 0, 'ORDER_STATUS_ID' => 1, 'TO_NOTIFY' => 2, ), + self::TYPE_FIELDNAME => array('id' => 0, 'order_status_id' => 1, 'to_notify' => 2, ), + self::TYPE_NUM => array(0, 1, 2, ) + ); + + /** + * 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('order_status_notification'); + $this->setPhpName('OrderStatusNotification'); + $this->setClassName('\\OrderStatusNotify\\Model\\OrderStatusNotification'); + $this->setPackage('OrderStatusNotify.Model'); + $this->setUseIdGenerator(true); + // columns + $this->addPrimaryKey('ID', 'Id', 'INTEGER', true, null, null); + $this->addForeignKey('ORDER_STATUS_ID', 'OrderStatusId', 'INTEGER', 'order_status', 'ID', true, null, null); + $this->addColumn('TO_NOTIFY', 'ToNotify', 'BOOLEAN', true, 1, false); + } // initialize() + + /** + * Build the RelationMap objects for this table relationships + */ + public function buildRelations() + { + $this->addRelation('OrderStatus', '\\OrderStatusNotify\\Model\\Thelia\\Model\\OrderStatus', RelationMap::MANY_TO_ONE, array('order_status_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 ? OrderStatusNotificationTableMap::CLASS_DEFAULT : OrderStatusNotificationTableMap::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 (OrderStatusNotification object, last column rank) + */ + public static function populateObject($row, $offset = 0, $indexType = TableMap::TYPE_NUM) + { + $key = OrderStatusNotificationTableMap::getPrimaryKeyHashFromRow($row, $offset, $indexType); + if (null !== ($obj = OrderStatusNotificationTableMap::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 + OrderStatusNotificationTableMap::NUM_HYDRATE_COLUMNS; + } else { + $cls = OrderStatusNotificationTableMap::OM_CLASS; + $obj = new $cls(); + $col = $obj->hydrate($row, $offset, false, $indexType); + OrderStatusNotificationTableMap::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 = OrderStatusNotificationTableMap::getPrimaryKeyHashFromRow($row, 0, $dataFetcher->getIndexType()); + if (null !== ($obj = OrderStatusNotificationTableMap::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; + OrderStatusNotificationTableMap::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(OrderStatusNotificationTableMap::ID); + $criteria->addSelectColumn(OrderStatusNotificationTableMap::ORDER_STATUS_ID); + $criteria->addSelectColumn(OrderStatusNotificationTableMap::TO_NOTIFY); + } else { + $criteria->addSelectColumn($alias . '.ID'); + $criteria->addSelectColumn($alias . '.ORDER_STATUS_ID'); + $criteria->addSelectColumn($alias . '.TO_NOTIFY'); + } + } + + /** + * 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(OrderStatusNotificationTableMap::DATABASE_NAME)->getTable(OrderStatusNotificationTableMap::TABLE_NAME); + } + + /** + * Add a TableMap instance to the database for this tableMap class. + */ + public static function buildTableMap() + { + $dbMap = Propel::getServiceContainer()->getDatabaseMap(OrderStatusNotificationTableMap::DATABASE_NAME); + if (!$dbMap->hasTable(OrderStatusNotificationTableMap::TABLE_NAME)) { + $dbMap->addTableObject(new OrderStatusNotificationTableMap()); + } + } + + /** + * Performs a DELETE on the database, given a OrderStatusNotification or Criteria object OR a primary key value. + * + * @param mixed $values Criteria or OrderStatusNotification 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(OrderStatusNotificationTableMap::DATABASE_NAME); + } + + if ($values instanceof Criteria) { + // rename for clarity + $criteria = $values; + } elseif ($values instanceof \OrderStatusNotify\Model\OrderStatusNotification) { // 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(OrderStatusNotificationTableMap::DATABASE_NAME); + $criteria->add(OrderStatusNotificationTableMap::ID, (array) $values, Criteria::IN); + } + + $query = OrderStatusNotificationQuery::create()->mergeWith($criteria); + + if ($values instanceof Criteria) { OrderStatusNotificationTableMap::clearInstancePool(); + } elseif (!is_object($values)) { // it's a primary key, or an array of pks + foreach ((array) $values as $singleval) { OrderStatusNotificationTableMap::removeInstanceFromPool($singleval); + } + } + + return $query->delete($con); + } + + /** + * Deletes all rows from the order_status_notification 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 OrderStatusNotificationQuery::create()->doDeleteAll($con); + } + + /** + * Performs an INSERT on the database, given a OrderStatusNotification or Criteria object. + * + * @param mixed $criteria Criteria or OrderStatusNotification 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(OrderStatusNotificationTableMap::DATABASE_NAME); + } + + if ($criteria instanceof Criteria) { + $criteria = clone $criteria; // rename for clarity + } else { + $criteria = $criteria->buildCriteria(); // build Criteria from OrderStatusNotification object + } + + if ($criteria->containsKey(OrderStatusNotificationTableMap::ID) && $criteria->keyContainsValue(OrderStatusNotificationTableMap::ID) ) { + throw new PropelException('Cannot insert a value for auto-increment primary key ('.OrderStatusNotificationTableMap::ID.')'); + } + + + // Set the correct dbName + $query = OrderStatusNotificationQuery::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; + } + +} // OrderStatusNotificationTableMap +// This is the static code needed to register the TableMap for this table with the main Propel class. +// +OrderStatusNotificationTableMap::buildTableMap(); diff --git a/local/modules/OrderStatusNotify/Model/OrderStatusNotification.php b/local/modules/OrderStatusNotify/Model/OrderStatusNotification.php new file mode 100644 index 00000000..0824d522 --- /dev/null +++ b/local/modules/OrderStatusNotify/Model/OrderStatusNotification.php @@ -0,0 +1,10 @@ +findOne(); + } catch (\Exception $e) { + $database = new Database($con->getWrappedConnection()); + $database->insertSql(null, array(THELIA_ROOT . '/local/modules/OrderStatusNotify/Config/thelia.sql')); + } + } +} diff --git a/local/modules/OrderStatusNotify/Readme.md b/local/modules/OrderStatusNotify/Readme.md new file mode 100644 index 00000000..a522a39b --- /dev/null +++ b/local/modules/OrderStatusNotify/Readme.md @@ -0,0 +1,31 @@ +# Order Status Notify + +Envoi d'email lors du changement de statut d'une commande. + +## Installation + +### Manually + +* Copier le module dans le dossier ```/local/modules/``` et vérifiez que le nom du module est bien OrderStatusNotify. +* Déplacer le template ```order_status_changed.html``` (présent à la racine du dossier du module) vers le répertoire ```templates\email\default``` +* Activer le module depuis l'écran d'administration Modules. + +### Composer + +Ajoutez ceci dans votre fichier composer.json principal. + +``` +composer require thelia/order-status-notify-module:~1.0 +``` + +## Usage + +En back-office, l'administrateur sélectionne, parmi les statuts de commande définis sur votre site, lesquels doivent faire l'objet d'une notification au client. + +Dès qu'une commande passe à un état présent dans cette liste, alors un email est immédiatement envoyé au client. +Le template de cet email s'intitule "order_status_changed". + +## Hook + +Pour la partie back-office, un nouvel écran apparaitra dans le menu "Outils" des écrans d'administration. +Il vous sera ainsi possible de choisir les statuts de commande à surveiller. diff --git a/local/modules/OrderStatusNotify/composer.json b/local/modules/OrderStatusNotify/composer.json new file mode 100644 index 00000000..d902e232 --- /dev/null +++ b/local/modules/OrderStatusNotify/composer.json @@ -0,0 +1,11 @@ +{ + "name": "thelia/order-status-notify-module", + "license": "LGPL-3.0+", + "type": "thelia-module", + "require": { + "thelia/installer": "~1.1" + }, + "extra": { + "installer-name": "OrderStatusNotify" + } +} \ No newline at end of file diff --git a/local/modules/OrderStatusNotify/templates/backOffice/default/display-order-status.html b/local/modules/OrderStatusNotify/templates/backOffice/default/display-order-status.html new file mode 100644 index 00000000..a4c24700 --- /dev/null +++ b/local/modules/OrderStatusNotify/templates/backOffice/default/display-order-status.html @@ -0,0 +1,55 @@ +{extends file="admin-layout.tpl"} + +{block name="page-title"}{intl d='orderstatusnotify' l='Order status notification'}{/block} + +{block name="main-content"} + +
+
+
+ {intl d='orderstatusnotify' l='Purpose of feature'} +
+
+
+ +
+ +
+{/block} + + +{block name="javascript-initialization"} +{javascripts file='assets/js/bootstrap-switch/bootstrap-switch.js'} + +{/javascripts} + + + +{/block} \ No newline at end of file diff --git a/local/modules/OrderStatusNotify/templates/backOffice/default/include/order-status-list.html b/local/modules/OrderStatusNotify/templates/backOffice/default/include/order-status-list.html new file mode 100644 index 00000000..092eb192 --- /dev/null +++ b/local/modules/OrderStatusNotify/templates/backOffice/default/include/order-status-list.html @@ -0,0 +1,44 @@ + +{assign var="array" value=","|explode:$status} + +{$error_message = ''} +{if $error_message} +
+
+
+ {$error_message} +
+
+
+{/if} + +
+ + + + + + + + + + + + {loop type="order-status" name="order-status-loop" visible="yes" order="alpha"} + + + + + + {/loop} + + + +
+ {intl d='orderstatusnotify' l="Status list"} +
{intl d='orderstatusnotify' l="ID"}{intl d='orderstatusnotify' l="Status"}{intl d='orderstatusnotify' l="To notify"}
{$ID}{$TITLE} +
+ +
+
+
diff --git a/templates/email/default/order_status_changed.html b/templates/email/default/order_status_changed.html new file mode 100644 index 00000000..4a304c6a --- /dev/null +++ b/templates/email/default/order_status_changed.html @@ -0,0 +1,114 @@ +{extends file="email-layout.tpl"} + +{* Do not provide a "Open in browser" link *} +{block name="browser"}{/block} +{* No big image header *} +{block name="image-header"}{/block} +{* No logo header *} +{block name="logo-header"}{/block} +{* No pre-header *} +{block name="pre-header"}{/block} + +{* Subject *} +{block name="email-subject"}{intl d="orderstatusnotify" l="Change on your order %ref on %store_name" ref={$order_ref} store_name={config key="store_name"}}{/block} + +{* Title *} +{block name="email-title"}{intl d="orderstatusnotify" l="Hello, your order has just changed to"}{$new_status}

{/block} + +{* Content *} +{block name="email-content"} + {loop name="order.invoice" type="order" id=$order_id customer="*"} + {loop name="currency.order" type="currency" id=$CURRENCY} + {assign var="orderCurrencyIsoCode" value=$ISOCODE} + {/loop} + + {loop type="customer" name="customer.invoice" id=$CUSTOMER current="0"} + {assign var="customerRef" value=$REF} + {/loop} + + {hook name="email-html.order-notification.before-address" order=$order_id} + + + + + + +
+ {intl l="Customer delivery address:"}
+ {ifhook rel="email-html.order-notification.delivery-address"} + {* delivery module can customize the delivery address *} + {hook name="email-html.order-notification.delivery-address" module={$DELIVERY_MODULE} order=$order_id} + {/ifhook} + {elsehook rel="email-html.order-notification.delivery-address"} + {format_address order_address=$DELIVERY_ADDRESS locale=$locale} + {/elsehook} + 		+ {intl l="Customer billing address:"}
+ {format_address order_address=$INVOICE_ADDRESS locale=$locale} +
+ + {hook name="email-html.order-notification.after-address" order=$order_id} + +

+ {intl l="Order Total:"} {format_money number=$TOTAL_TAXED_AMOUNT currency_id=$CURRENCY}
+ {intl l="Order Number:"} {$REF}
+ {intl l="Paid With:"} {loop name="payment-module" type="module" id=$PAYMENT_MODULE}{$TITLE}{/loop}
+ {intl l="Purchase Date:"} {format_date date=$CREATE_DATE output="datetime"}
+ {intl l="Delivery method:"} {loop name="delivery-module" type="module" id=$DELIVERY_MODULE}{$TITLE}{/loop}
+

+ + {hook name="email-html.order-notification.before-products" order=$order_id} + + + + + + + {loop type="order_product" name="order-products" order=$ID} + {if $WAS_IN_PROMO == 1} + {assign "realPrice" $PROMO_PRICE} + {assign "realTax" $PROMO_PRICE_TAX} + {assign "realTaxedPrice" $TAXED_PROMO_PRICE} + {else} + {assign "realPrice" $PRICE} + {assign "realTax" $PRICE_TAX} + {assign "realTaxedPrice" $TAXED_PRICE} + {/if} + + + + + + {hook name="email-html.order-notification.order-product" order="{$order_id}" order_product="{$ID}"} + + {/loop} + + + + + + + + + + + + +
{intl l="What You Purchased"}{intl l="Price in"} {$orderCurrencyIsoCode}
+ {$TITLE} ({$REF}) + {ifloop rel="combinations"}
+ {loop type="order_product_attribute_combination" name="combinations" order_product=$ID} + * {$ATTRIBUTE_TITLE}: {$ATTRIBUTE_AVAILABILITY_TITLE} + {/loop} + {/ifloop} + 		+ {$QUANTITY} x {format_money number=$realTaxedPrice currency_id=$CURRENCY} +
{intl l="Total"}{format_money number={$TOTAL_TAXED_AMOUNT - $POSTAGE} currency_id=$CURRENCY}
{intl l="Shipping:"}{format_money number=$POSTAGE currency_id=$CURRENCY}
{intl l="Order Total"}{format_money number=$TOTAL_TAXED_AMOUNT currency_id=$CURRENCY}
+ {/loop} + + {hook name="email-html.order-notification.after-products" order=$order_id} + +
+ + {intl l="Have a nice day."}
+{/block}