├── Api
    ├── SubscriptionInterface.php
    └── SubscriptionRepositoryInterface.php
├── Block
    └── Product
    │   └── View.php
├── Cron
    └── Email.php
├── Helper
    └── Data.php
├── Model
    ├── ResourceModel
    │   ├── Subscription.php
    │   └── Subscription
    │   │   └── Collection.php
    ├── Subscription.php
    ├── SubscriptionInterface.php
    ├── SubscriptionManagement.php
    └── SubscriptionRepository.php
├── Observer
    └── ProductSaveAfter.php
├── README.md
├── Setup
    ├── InstallData.php
    └── InstallSchema.php
├── composer.json
├── etc
    ├── adminhtml
    │   └── system.xml
    ├── config.xml
    ├── crontab.xml
    ├── di.xml
    ├── email_templates.xml
    ├── events.xml
    ├── module.xml
    └── webapi.xml
├── i18n
    └── en_US.csv
├── registration.php
└── view
    └── frontend
        ├── email
            └── back_in_stock.html
        ├── layout
            └── catalog_product_view_type_configurable.xml
        ├── templates
            └── product
            │   └── configurable
            │       ├── subscribe_form.phtml
            │       └── subscribe_link.phtml
        └── web
            └── css
                └── subscribe-form.css


/Api/SubscriptionInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JustCoded\BackInStockConfigurable\Api;
 4 | 
 5 | /**
 6 |  * @api
 7 |  */
 8 | interface SubscriptionInterface
 9 | {
10 |     /**
11 |      * @param string $email
12 |      * @param string $simple
13 |      * @param string $configurable
14 |      *
15 |      * @return array
16 |      */
17 |     public function subscribe(
18 |         $email,
19 |         $simple,
20 |         $configurable
21 |     );
22 | }


--------------------------------------------------------------------------------
/Api/SubscriptionRepositoryInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JustCoded\BackInStockConfigurable\Api;
 4 | 
 5 | use JustCoded\BackInStockConfigurable\Model\SubscriptionInterface as Subscription;
 6 | use Magento\Framework\Api\SearchCriteriaInterface as SearchCriteria;
 7 | use Magento\Framework\Exception\CouldNotSaveException;
 8 | use Magento\Framework\Exception\NoSuchEntityException;
 9 | use Magento\Framework\Exception\CouldNotDeleteException;
10 | use Magento\Framework\Api\SearchResultsInterface as SearchResults;
11 | 
12 | interface SubscriptionRepositoryInterface 
13 | {
14 |     /**
15 |      * @param Subscription $object
16 |      * @return SubscriptionInterface
17 |      * @throws CouldNotSaveException
18 |      */
19 |     public function save(Subscription $object);
20 | 
21 |     /**
22 |      * @param $id
23 |      * @return mixed
24 |      * @throws NoSuchEntityException
25 |      */
26 |     public function getById($id);
27 | 
28 |     /**
29 |      * @param SearchCriteria $criteria
30 |      * @return SearchResults
31 |      */
32 |     public function getList(SearchCriteria $criteria);
33 | 
34 |     /**
35 |      * @param Subscription $object
36 |      * @return bool
37 |      * @throws CouldNotDeleteException
38 |      */
39 |     public function delete(Subscription $object);
40 | 
41 |     /**
42 |      * @param $id
43 |      * @return bool
44 |      * @throws CouldNotDeleteException
45 |      */
46 |     public function deleteById($id);
47 | 
48 |     /**
49 |      * @param $email
50 |      * @param $productId
51 |      * @return Subscription|null
52 |      */
53 |     public function getByEmailAndProductId($email, $productId);
54 | }
55 | 


--------------------------------------------------------------------------------
/Block/Product/View.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace JustCoded\BackInStockConfigurable\Block\Product;
  4 | 
  5 | use JustCoded\BackInStockConfigurable\Helper\Data as ModuleHelper;
  6 | use Magento\Catalog\Api\ProductRepositoryInterface;
  7 | use Magento\Catalog\Block\Product\View as ProductView;
  8 | use Magento\Catalog\Helper\Product as ProductHelper;
  9 | use Magento\Catalog\Model\ProductTypes\ConfigInterface;
 10 | use Magento\CatalogInventory\Api\StockStateInterface as StockState;
 11 | use Magento\ConfigurableProduct\Model\Product\Type\Configurable;
 12 | use Magento\Customer\Model\Session;
 13 | use Magento\Framework\Json\EncoderInterface as JsonEncoderInterface;
 14 | use Magento\Framework\Locale\FormatInterface;
 15 | use Magento\Framework\Pricing\PriceCurrencyInterface;
 16 | use Magento\Framework\Stdlib\StringUtils;
 17 | use Magento\Framework\Url\EncoderInterface as UrlEncoderInterface;
 18 | use Magento\Catalog\Block\Product\Context;
 19 | use Magento\Catalog\Api\Data\ProductInterface as Product;
 20 | 
 21 | class View extends ProductView
 22 | {
 23 |     /**
 24 |      * @var StockState
 25 |      */
 26 |     protected $stockItem;
 27 | 
 28 |     /**
 29 |      * @var ModuleHelper
 30 |      */
 31 |     protected $moduleHelper;
 32 | 
 33 |     public function __construct(
 34 |         Context $context,
 35 |         UrlEncoderInterface $urlEncoder,
 36 |         JsonEncoderInterface $jsonEncoder,
 37 |         StringUtils $string,
 38 |         ProductHelper $productHelper,
 39 |         ConfigInterface $productTypeConfig,
 40 |         FormatInterface $localeFormat,
 41 |         Session $customerSession,
 42 |         ProductRepositoryInterface $productRepository,
 43 |         PriceCurrencyInterface $priceCurrency,
 44 |         StockState $stockItem,
 45 |         ModuleHelper $moduleHelper,
 46 |         array $data = []
 47 |     ) {
 48 |         $this->stockItem    = $stockItem;
 49 |         $this->moduleHelper = $moduleHelper;
 50 | 
 51 |         parent::__construct($context, $urlEncoder, $jsonEncoder, $string, $productHelper, $productTypeConfig, $localeFormat, $customerSession, $productRepository, $priceCurrency, $data);
 52 |     }
 53 | 
 54 |     /**
 55 |      * @return string
 56 |      */
 57 |     public function getServiceUrl()
 58 |     {
 59 |         $storeCode = $this->_storeManager->getStore()->getCode();
 60 | 
 61 |         return '/rest/' . $storeCode . '/V1/in-stock-notify/:email/subscribe';
 62 |     }
 63 | 
 64 |     /**
 65 |      * @return string
 66 |      */
 67 |     public function getHeaderContent()
 68 |     {
 69 |         $blockId = $this->moduleHelper->getPopupHeaderCmsBlockId();
 70 | 
 71 |         if (!$blockId) {
 72 |             return '';
 73 |         }
 74 | 
 75 |         return $this->getLayout()
 76 |             ->createBlock(\Magento\Cms\Block\Block::class)
 77 |             ->setBlockId($blockId)
 78 |             ->toHtml();
 79 |     }
 80 | 
 81 |     /**
 82 |      * @return array
 83 |      */
 84 |     public function getConfigurableAttributes()
 85 |     {
 86 |         $sortingOrder = $this->moduleHelper->getAttributesSortingOrder();
 87 | 
 88 |         $attributes = $this->getProduct()->getTypeInstance()->getUsedProductAttributes($this->getProduct());
 89 | 
 90 |         usort($attributes, function ($a, $b) use ($sortingOrder) {
 91 |             return array_search($a->getAttributeCode(), $sortingOrder) - array_search($b->getAttributeCode(), $sortingOrder);
 92 |         });
 93 | 
 94 |         return $attributes;
 95 |     }
 96 | 
 97 |     public function getConfigurableAttributeOptions($attribute)
 98 |     {
 99 |         $options = [];
100 | 
101 |         foreach ($this->getOutOfStockSimpleProducts() as $product) {
102 |             if (!isset($options[$product->getData($attribute->getAttributeCode())])) {
103 |                 $options[$product->getData($attribute->getAttributeCode())] = [
104 |                     'label' => $product->getResource()->getAttribute($attribute->getAttributeCode())
105 |                         ->getFrontend()->getValue($product),
106 |                     'product_ids' => []
107 |                 ];
108 |             }
109 | 
110 |             $options[$product->getData($attribute->getAttributeCode())]['product_ids'][] = $product->getId();
111 |         }
112 | 
113 |         return $options;
114 |     }
115 | 
116 |     /**
117 |      * @return Product[]
118 |      */
119 |     public function getSimpleProducts()
120 |     {
121 |         return $this->getProduct()->getTypeInstance()->getUsedProducts($this->getProduct());
122 |     }
123 | 
124 |     /**
125 |      * @return array
126 |      */
127 |     public function getOutOfStockSimpleProducts()
128 |     {
129 |         return array_filter($this->getSimpleProducts(), function ($product) {
130 |             $websiteId = $this->getProduct()->getStore()->getWebsiteId();
131 | 
132 |             return !$this->stockItem->verifyStock($product->getId(), $websiteId) ||
133 |                 !$this->stockItem->getStockQty($product->getId(), $websiteId);
134 |         });
135 |     }
136 | 
137 |     /**
138 |      * @inheritDoc
139 |      */
140 |     protected function _toHtml()
141 |     {
142 |         $isConfigurable  = $this->getProduct()->getTypeId() == Configurable::TYPE_CODE;
143 |         $isModuleEnabled = $this->moduleHelper->isEnabled();
144 | 
145 |         if (!$isConfigurable || !$isModuleEnabled) {
146 |             return '';
147 |         }
148 | 
149 |         if (!count($this->getOutOfStockSimpleProducts())) {
150 |             return '';
151 |         }
152 | 
153 |         return parent::_toHtml();
154 |     }
155 | }


--------------------------------------------------------------------------------
/Cron/Email.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace JustCoded\BackInStockConfigurable\Cron;
  4 | 
  5 | use JustCoded\BackInStockConfigurable\Helper\Data;
  6 | use JustCoded\BackInStockConfigurable\Model\ResourceModel\Subscription\CollectionFactory;
  7 | use JustCoded\BackInStockConfigurable\Model\Subscription;
  8 | use JustCoded\BackInStockConfigurable\Model\SubscriptionRepository;
  9 | use Psr\Log\LoggerInterface;
 10 | 
 11 | class Email
 12 | {
 13 |     const LOG_PREFIX = 'IN_STOCK_NOTIFY: ';
 14 | 
 15 |     /**
 16 |      * @var Data
 17 |      */
 18 |     private $moduleHelper;
 19 | 
 20 |     /**
 21 |      * @var CollectionFactory
 22 |      */
 23 |     private $subscriptionsFactory;
 24 | 
 25 |     /**
 26 |      * @var SubscriptionRepository
 27 |      */
 28 |     private $subscriptionRepository;
 29 | 
 30 |     /**
 31 |      * @var LoggerInterface
 32 |      */
 33 |     private $logger;
 34 | 
 35 |     public function __construct(
 36 |         Data $moduleHelper,
 37 |         CollectionFactory $subscriptionsFactory,
 38 |         SubscriptionRepository $subscriptionRepository,
 39 |         LoggerInterface $logger
 40 |     ) {
 41 |         $this->moduleHelper           = $moduleHelper;
 42 |         $this->subscriptionsFactory   = $subscriptionsFactory;
 43 |         $this->subscriptionRepository = $subscriptionRepository;
 44 |         $this->logger                 = $logger;
 45 |     }
 46 | 
 47 |     /**
 48 |      * @param Subscription $subscription
 49 |      * @return string
 50 |      */
 51 |     private function getSubscriptionInfo(Subscription $subscription)
 52 |     {
 53 |         return 'subscription for email: ' . $subscription->getEmail() .
 54 |             ', product_id: ' . $subscription->getProductId();
 55 |     }
 56 | 
 57 |     /**
 58 |      * @param $msg
 59 |      * @return string
 60 |      */
 61 |     private function formatMessage($msg)
 62 |     {
 63 |         return self::LOG_PREFIX . $msg;
 64 |     }
 65 | 
 66 |     /**
 67 |      * @param $msg
 68 |      */
 69 |     private function info($msg)
 70 |     {
 71 |         $this->logger->info($this->formatMessage($msg));
 72 |     }
 73 | 
 74 |     /**
 75 |      * @param $msg
 76 |      */
 77 |     private function error($msg)
 78 |     {
 79 |         $this->logger->error($this->formatMessage($msg));
 80 |     }
 81 | 
 82 |     /**
 83 |      * Send emails with subscriptions
 84 |      */
 85 |     public function execute()
 86 |     {
 87 |         $this->info('Check cron mailer');
 88 | 
 89 |         if (!$this->moduleHelper->isScheduledNotifications()) {
 90 |             return;
 91 |         }
 92 | 
 93 |         $this->info('Start mailing');
 94 | 
 95 |         $subscriptions = $this->subscriptionsFactory->create();
 96 | 
 97 |         foreach ($subscriptions as $subscription) {
 98 |             $this->info('Check ' . $this->getSubscriptionInfo($subscription));
 99 |             if ($subscription->isReady()) {
100 |                 $this->info('Ready for process ' . $this->getSubscriptionInfo($subscription));
101 |                 try {
102 |                     $subscription->proceed();
103 | 
104 |                     $this->info('Was send ' . $this->getSubscriptionInfo($subscription));
105 | 
106 |                     $this->subscriptionRepository->delete($subscription);
107 |                 } catch (\Exception $e) {
108 |                     $this->error(
109 |                         'Error for ' . $this->getSubscriptionInfo($subscription) .
110 |                         'Exception: ' . $e->getMessage()
111 |                     );
112 |                 }
113 |             } else {
114 |                 $this->info('Not ready for process ' . $this->getSubscriptionInfo($subscription));
115 |             }
116 |         }
117 | 
118 |         $this->info('Stop mailing');
119 |     }
120 | }


--------------------------------------------------------------------------------
/Helper/Data.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace JustCoded\BackInStockConfigurable\Helper;
  4 | 
  5 | use JustCoded\BackInStockConfigurable\Model\Subscription;
  6 | use JustCoded\BackInStockConfigurable\Model\SubscriptionRepository;
  7 | use Magento\Email\Model\ResourceModel\Template\CollectionFactory;
  8 | use Magento\Framework\Api\SearchCriteriaBuilder;
  9 | use Magento\Framework\App\Helper\AbstractHelper;
 10 | use Magento\Framework\App\Helper\Context;
 11 | use Magento\Framework\Mail\Template\TransportBuilder;
 12 | use Magento\Framework\Translate\Inline\StateInterface as State;
 13 | use Magento\Store\Model\ScopeInterface;
 14 | 
 15 | class Data extends AbstractHelper
 16 | {
 17 |     const EMAIL_TEMPLATE = 'back_in_stock_configurable_notification_email_template';
 18 | 
 19 |     const XML_PATH_IS_ENABLED                  = 'justcoded_back_in_stock_configurable/settings/enabled';
 20 |     const XML_PATH_IS_SCHEDULED                = 'justcoded_back_in_stock_configurable/settings/cron_send_notifications_enable';
 21 |     const XML_PATH_EMAIL_FROM                  = 'trans_email/ident_support/email';
 22 |     const XML_PATH_NAME_FROM                   = 'trans_email/ident_support/name';
 23 |     const XML_PATH_ATTRIBUTES_SORTING_ORDER    = 'justcoded_back_in_stock_configurable/settings/attributes_sorting_order';
 24 |     const XML_PATH_POPUP_HEADER_CMS_BLOCK_ID   = 'justcoded_back_in_stock_configurable/settings/popup_header_cms_block_id';
 25 | 
 26 |     /**
 27 |      * @var SearchCriteriaBuilder
 28 |      */
 29 |     private $searchCriteriaBuilder;
 30 | 
 31 |     /**
 32 |      * @var SubscriptionRepository
 33 |      */
 34 |     private $subscriptionRepository;
 35 | 
 36 |     /**
 37 |      * @var TransportBuilder
 38 |      */
 39 |     private $transportBuilder;
 40 | 
 41 |     /**
 42 |      * @var State
 43 |      */
 44 |     private $inlineTranslation;
 45 | 
 46 |     /**
 47 |      * @var CollectionFactory
 48 |      */
 49 |     private $templatesFactory;
 50 | 
 51 |     public function __construct(
 52 |         Context $context,
 53 |         SearchCriteriaBuilder $searchCriteriaBuilder,
 54 |         SubscriptionRepository $subscriptionRepository,
 55 |         TransportBuilder $transportBuilder,
 56 |         State $inlineTranslation,
 57 |         CollectionFactory $templatesFactory
 58 |     ) {
 59 |         $this->searchCriteriaBuilder  = $searchCriteriaBuilder;
 60 |         $this->subscriptionRepository = $subscriptionRepository;
 61 |         $this->transportBuilder       = $transportBuilder;
 62 |         $this->inlineTranslation      = $inlineTranslation;
 63 |         $this->templatesFactory       = $templatesFactory;
 64 | 
 65 |         parent::__construct($context);
 66 |     }
 67 | 
 68 |     /**
 69 |      * @return bool
 70 |      */
 71 |     public function isEnabled()
 72 |     {
 73 |         return $this->scopeConfig->isSetFlag(
 74 |             self::XML_PATH_IS_ENABLED,
 75 |             ScopeInterface::SCOPE_STORE
 76 |         );
 77 |     }
 78 | 
 79 |     /**
 80 |      * @return bool
 81 |      */
 82 |     public function isScheduledNotifications()
 83 |     {
 84 |         return $this->scopeConfig->isSetFlag(
 85 |             self::XML_PATH_IS_SCHEDULED,
 86 |             ScopeInterface::SCOPE_STORE
 87 |         );
 88 |     }
 89 | 
 90 |     /**
 91 |      * @param Subscription $subscription
 92 |      * @return array
 93 |      */
 94 |     protected function getEmailTemplateVariables(Subscription $subscription)
 95 |     {
 96 |         return [
 97 |             'product' => $subscription->getProduct()
 98 |         ];
 99 |     }
100 | 
101 |     /**
102 |      * @return string
103 |      */
104 |     public function getEmailFrom()
105 |     {
106 |         return $this->scopeConfig->getValue(
107 |             self::XML_PATH_EMAIL_FROM,
108 |             ScopeInterface::SCOPE_STORE
109 |         );
110 |     }
111 | 
112 |     /**
113 |      * @return string
114 |      */
115 |     public function getNameFrom()
116 |     {
117 |         return $this->scopeConfig->getValue(
118 |             self::XML_PATH_NAME_FROM,
119 |             ScopeInterface::SCOPE_STORE
120 |         );
121 |     }
122 | 
123 |     /**
124 |      * @param Subscription $subscription
125 |      */
126 |     public function sendMail(Subscription $subscription)
127 |     {
128 |         $this->inlineTranslation->suspend();
129 | 
130 |         $template = $this->templatesFactory->create()->addFieldToFilter('template_code', self::EMAIL_TEMPLATE)->getFirstItem();
131 | 
132 |         $identifier = $template->getId() ? $template->getId() : self::EMAIL_TEMPLATE;
133 | 
134 |         $transport = $this->transportBuilder->setTemplateIdentifier($identifier)
135 |             ->setTemplateOptions([
136 |                 'area'  => \Magento\Framework\App\Area::AREA_FRONTEND,
137 |                 'store' => $subscription->getStoreId()
138 |             ])->setTemplateVars($this->getEmailTemplateVariables($subscription)
139 |             )->setFrom([
140 |                 'email' => $this->getEmailFrom(),
141 |                 'name'  => $this->getNameFrom(),
142 |             ])->addTo($subscription->getEmail())
143 |             ->getTransport();
144 | 
145 |         $transport->sendMessage();
146 | 
147 |         $this->inlineTranslation->resume();
148 |     }
149 | 
150 |     /**
151 |      * @return array
152 |      */
153 |     public function getAttributesSortingOrder()
154 |     {
155 |         $rawValue = $this->scopeConfig->getValue(
156 |             self::XML_PATH_ATTRIBUTES_SORTING_ORDER,
157 |             ScopeInterface::SCOPE_STORE
158 |         );
159 | 
160 |         return array_map('trim', explode(',', $rawValue));
161 |     }
162 | 
163 |     /**
164 |      * @return string
165 |      */
166 |     public function getPopupHeaderCmsBlockId()
167 |     {
168 |         return $this->scopeConfig->getValue(
169 |             self::XML_PATH_POPUP_HEADER_CMS_BLOCK_ID,
170 |             ScopeInterface::SCOPE_STORE
171 |         );
172 |     }
173 | }
174 | 
175 | 


--------------------------------------------------------------------------------
/Model/ResourceModel/Subscription.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JustCoded\BackInStockConfigurable\Model\ResourceModel;
 4 | 
 5 | use Magento\Framework\Model\ResourceModel\Db\AbstractDb;
 6 | 
 7 | class Subscription extends AbstractDb
 8 | {
 9 |     const TABLE_NAME    = 'justcoded_backinstock_subscription';
10 |     const ID_FIELD_NAME = 'subscription_id';
11 | 
12 |     protected function _construct()
13 |     {
14 |         $this->_init(self::TABLE_NAME, self::ID_FIELD_NAME);
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/Model/ResourceModel/Subscription/Collection.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JustCoded\BackInStockConfigurable\Model\ResourceModel\Subscription;
 4 | 
 5 | use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
 6 | 
 7 | class Collection extends AbstractCollection
 8 | {
 9 |     protected function _construct()
10 |     {
11 |         $this->_init(
12 |             \JustCoded\BackInStockConfigurable\Model\Subscription::class,
13 |             \JustCoded\BackInStockConfigurable\Model\ResourceModel\Subscription::class
14 |         );
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/Model/Subscription.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace JustCoded\BackInStockConfigurable\Model;
  4 | 
  5 | use JustCoded\BackInStockConfigurable\Helper\Data;
  6 | use JustCoded\BackInStockConfigurable\Model\ResourceModel\Subscription as SubscriptionResource;
  7 | use JustCoded\BackInStockConfigurable\Model\ResourceModel\Subscription\Collection;
  8 | use JustCoded\BackInStockConfigurable\Model\SubscriptionInterface;
  9 | use Magento\Catalog\Api\ProductRepositoryInterface;
 10 | use Magento\CatalogInventory\Api\StockRegistryInterface;
 11 | use Magento\Framework\Model\AbstractModel;
 12 | use Magento\Framework\Model\Context;
 13 | use Magento\Framework\Registry;
 14 | use Magento\Framework\DataObject;
 15 | 
 16 | class Subscription extends AbstractModel implements SubscriptionInterface
 17 | {
 18 |     const CACHE_TAG = 'justcoded_backinstock_subscription';
 19 | 
 20 |     /**
 21 |      * @var Data
 22 |      */
 23 |     private $moduleHelper;
 24 | 
 25 |     /**
 26 |      * @var ProductRepositoryInterface
 27 |      */
 28 |     private $productRepository;
 29 | 
 30 |     /**
 31 |      * @var StockRegistryInterface
 32 |      */
 33 |     private $stockRegistry;
 34 | 
 35 |     public function __construct(
 36 |         Context $context,
 37 |         Registry $registry,
 38 |         SubscriptionResource $resource,
 39 |         Collection $resourceCollection,
 40 |         Data $moduleHelper,
 41 |         ProductRepositoryInterface $productRepository,
 42 |         StockRegistryInterface $stockRegistry,
 43 |         array $data = []
 44 |     ) {
 45 |         $this->moduleHelper = $moduleHelper;
 46 |         $this->productRepository = $productRepository;
 47 |         $this->stockRegistry = $stockRegistry;
 48 | 
 49 |         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
 50 |     }
 51 | 
 52 |     /**
 53 |      * @inheritdoc
 54 |      */
 55 |     protected function _construct()
 56 |     {
 57 |         $this->_init('JustCoded\BackInStockConfigurable\Model\ResourceModel\Subscription');
 58 |     }
 59 | 
 60 |     /**
 61 |      * @inheritdoc
 62 |      */
 63 |     public function getIdentities()
 64 |     {
 65 |         return [self::CACHE_TAG . '_' . $this->getId()];
 66 |     }
 67 | 
 68 |     /**
 69 |      * @inheritdoc
 70 |      */
 71 |     public function proceed()
 72 |     {
 73 |         $this->moduleHelper->sendMail($this);
 74 |     }
 75 | 
 76 |     /**
 77 |      * @inheritdoc
 78 |      */
 79 |     public function getProduct()
 80 |     {
 81 |         return $this->productRepository->getById($this->getProductId());
 82 |     }
 83 | 
 84 |     /**
 85 |      * @inheritdoc
 86 |      */
 87 |     public function isReady($product = null)
 88 |     {
 89 |         if (!$product) {
 90 |             $product = $this->getProduct();
 91 |         }
 92 | 
 93 |         $stockData = $product->getStockData();
 94 | 
 95 |         if ($stockData) {
 96 |             $stockItem = new DataObject($stockData);
 97 |         } else {
 98 |             $stockItem = $this->stockRegistry->getStockItem($product->getId(), $product->getStore()->getWebsiteId());
 99 |         }
100 | 
101 |         return 0 < $stockItem->getQty() && $stockItem->getIsInStock();
102 |     }
103 | }
104 | 


--------------------------------------------------------------------------------
/Model/SubscriptionInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JustCoded\BackInStockConfigurable\Model;
 4 | 
 5 | use Magento\Catalog\Api\Data\ProductInterface as Product;
 6 | 
 7 | interface SubscriptionInterface 
 8 | {
 9 |     /**
10 |      * Proceed this subscription
11 |      */
12 |     public function proceed();
13 | 
14 |     /**
15 |      * Is ready to send notification for user
16 |      * @param Product $product
17 |      * @return bool
18 |      */
19 |     public function isReady($product = null);
20 | 
21 |     /**
22 |      * @return Product
23 |      */
24 |     public function getProduct();
25 | }


--------------------------------------------------------------------------------
/Model/SubscriptionManagement.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace JustCoded\BackInStockConfigurable\Model;
  4 | 
  5 | use JustCoded\BackInStockConfigurable\Api\SubscriptionInterface;
  6 | use JustCoded\BackInStockConfigurable\Api\SubscriptionRepositoryInterface as SubscriptionRepository;
  7 | use Magento\Catalog\Api\Data\ProductInterface as Product;
  8 | use Magento\Catalog\Api\ProductRepositoryInterface as ProductRepository;
  9 | use Magento\Framework\Api\SearchCriteriaBuilder;
 10 | use Magento\Framework\Exception\NoSuchEntityException;
 11 | use Magento\Framework\Json\Helper\Data as JsonHelper;
 12 | use Magento\Store\Model\StoreManagerInterface as StoreManager;
 13 | 
 14 | class SubscriptionManagement implements SubscriptionInterface
 15 | {
 16 |     /**
 17 |      * @var SubscriptionRepository
 18 |      */
 19 |     protected $subscriptionRepository;
 20 | 
 21 |     /**
 22 |      * @var SubscriptionFactory
 23 |      */
 24 |     protected $subscriptionFactory;
 25 | 
 26 |     /**
 27 |      * @var ProductRepository
 28 |      */
 29 |     private $productRepository;
 30 | 
 31 |     /**
 32 |      * @var SearchCriteriaBuilder
 33 |      */
 34 |     private $searchCriteriaBuilder;
 35 | 
 36 |     /**
 37 |      * @var JsonHelper
 38 |      */
 39 |     private $jsonHelper;
 40 | 
 41 |     /**
 42 |      * @var StoreManager
 43 |      */
 44 |     protected $storeManager;
 45 | 
 46 |     public function __construct(
 47 |         SubscriptionRepository $subscriptionRepository,
 48 |         SubscriptionFactory $subscriptionFactory,
 49 |         ProductRepository $productRepository,
 50 |         SearchCriteriaBuilder $searchCriteriaBuilder,
 51 |         JsonHelper $jsonHelper,
 52 |         StoreManager $storeManager
 53 |     ) {
 54 |         $this->subscriptionRepository = $subscriptionRepository;
 55 |         $this->subscriptionFactory    = $subscriptionFactory;
 56 |         $this->productRepository      = $productRepository;
 57 |         $this->searchCriteriaBuilder  = $searchCriteriaBuilder;
 58 |         $this->jsonHelper             = $jsonHelper;
 59 |         $this->storeManager           = $storeManager;
 60 |     }
 61 | 
 62 |     /**
 63 |      * @param array $simple
 64 |      * @param array $configurable
 65 |      *
 66 |      * @return Product[]
 67 |      */
 68 |     protected function findProductsByOptions($simple, $configurable)
 69 |     {
 70 |         $configurableProduct = $this->productRepository->getById($configurable['id']);
 71 | 
 72 |         return array_filter(
 73 |             $configurableProduct->getTypeInstance()->getUsedProducts($configurableProduct),
 74 |             function ($product) use ($simple) {
 75 |                 return $product->getId() === $simple['id'];
 76 |             }
 77 |         );
 78 |     }
 79 | 
 80 |     /**
 81 |      * @inheritdoc
 82 |      */
 83 |     public function subscribe(
 84 |         $email,
 85 |         $simple,
 86 |         $configurable
 87 |     ) {
 88 |         $products = $this->findProductsByOptions(
 89 |             $this->jsonHelper->jsonDecode($simple),
 90 |             $this->jsonHelper->jsonDecode($configurable)
 91 |         );
 92 | 
 93 |         foreach ($products as $product) {
 94 |             if (!$product->getId()) {
 95 |                 throw new NoSuchEntityException(__('Can\'t find product with such criteria.'));
 96 |             }
 97 | 
 98 |             if (!$this->subscriptionRepository->getByEmailAndProductId($email, $product->getId())) {
 99 |                 $subscription = $this->subscriptionFactory->create()
100 |                     ->setEmail($email)
101 |                     ->setProductId($product->getId())
102 |                     ->setStoreId($this->storeManager->getStore()->getId());
103 | 
104 |                 $this->subscriptionRepository->save($subscription);
105 |             }
106 |         }
107 | 
108 |         return ['success' => true];
109 |     }
110 | }


--------------------------------------------------------------------------------
/Model/SubscriptionRepository.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace JustCoded\BackInStockConfigurable\Model;
  4 | 
  5 | use JustCoded\BackInStockConfigurable\Api\SubscriptionRepositoryInterface;
  6 | use JustCoded\BackInStockConfigurable\Model\SubscriptionFactory;
  7 | use JustCoded\BackInStockConfigurable\Model\ResourceModel\Subscription\CollectionFactory;
  8 | 
  9 | use Magento\Framework\Api\SearchCriteriaInterface as SearchCriteria;
 10 | use Magento\Framework\Exception\CouldNotSaveException;
 11 | use Magento\Framework\Exception\NoSuchEntityException;
 12 | use Magento\Framework\Exception\CouldNotDeleteException;
 13 | use Magento\Framework\Api\SearchResultsInterfaceFactory;
 14 | use Magento\Framework\Api\SearchCriteriaBuilder;
 15 | use Magento\Framework\Api\SortOrder;
 16 | 
 17 | class SubscriptionRepository implements SubscriptionRepositoryInterface
 18 | {
 19 |     /**
 20 |      * @var \JustCoded\BackInStockConfigurable\Model\SubscriptionFactory
 21 |      */
 22 |     protected $objectFactory;
 23 | 
 24 |     /**
 25 |      * @var CollectionFactory
 26 |      */
 27 |     protected $collectionFactory;
 28 | 
 29 |     /**
 30 |      * @var SearchResultsInterfaceFactory
 31 |      */
 32 |     protected $searchResultsFactory;
 33 | 
 34 |     /**
 35 |      * @var SearchCriteriaBuilder
 36 |      */
 37 |     protected $searchCriteriaBuilder;
 38 | 
 39 |     public function __construct(
 40 |         SubscriptionFactory $objectFactory,
 41 |         CollectionFactory $collectionFactory,
 42 |         SearchResultsInterfaceFactory $searchResultsFactory,
 43 |         SearchCriteriaBuilder $searchCriteriaBuilder
 44 |     ) {
 45 |         $this->objectFactory         = $objectFactory;
 46 |         $this->collectionFactory     = $collectionFactory;
 47 |         $this->searchResultsFactory  = $searchResultsFactory;
 48 |         $this->searchCriteriaBuilder = $searchCriteriaBuilder;
 49 |     }
 50 | 
 51 |     /**
 52 |      * @inheritdoc
 53 |      */
 54 |     public function save(SubscriptionInterface $object)
 55 |     {
 56 |         try {
 57 |             $object->save();
 58 |         } catch (\Exception $e) {
 59 |             throw new CouldNotSaveException(__($e->getMessage()));
 60 |         }
 61 | 
 62 |         return $object;
 63 |     }
 64 | 
 65 |     /**
 66 |      * @inheritdoc
 67 |      */
 68 |     public function getById($id)
 69 |     {
 70 |         $object = $this->objectFactory->create();
 71 |         $object->load($id);
 72 |         if (!$object->getId()) {
 73 |             throw new NoSuchEntityException(__('Object with id "%1" does not exist.', $id));
 74 |         }
 75 | 
 76 |         return $object;
 77 |     }
 78 | 
 79 |     /**
 80 |      * @inheritdoc
 81 |      */
 82 |     public function getByEmailAndProductId($email, $productId)
 83 |     {
 84 |         $searchCriteria = $this->searchCriteriaBuilder
 85 |             ->addFilter('email', $email)
 86 |             ->addFilter('product_id', $productId)
 87 |             ->create();
 88 | 
 89 |         $searchResult = $this->getList($searchCriteria)->getItems();
 90 | 
 91 |         if ($searchResult && isset($searchResult[0])) {
 92 |             return $searchResult[0]->getId();
 93 |         }
 94 | 
 95 |         return null;
 96 |     }
 97 | 
 98 |     /**
 99 |      * @inheritdoc
100 |      */
101 |     public function delete(SubscriptionInterface $object)
102 |     {
103 |         try {
104 |             $object->delete();
105 |         } catch (\Exception $exception) {
106 |             throw new CouldNotDeleteException(__($exception->getMessage()));
107 |         }
108 | 
109 |         return true;
110 |     }
111 | 
112 |     /**
113 |      * @inheritdoc
114 |      */
115 |     public function deleteById($id)
116 |     {
117 |         return $this->delete($this->getById($id));
118 |     }
119 | 
120 |     /**
121 |      * @inheritdoc
122 |      */
123 |     public function getList(SearchCriteria $criteria)
124 |     {
125 |         $searchResults = $this->searchResultsFactory->create();
126 |         $searchResults->setSearchCriteria($criteria);
127 |         $collection = $this->collectionFactory->create();
128 |         foreach ($criteria->getFilterGroups() as $filterGroup) {
129 |             $fields     = [];
130 |             $conditions = [];
131 |             foreach ($filterGroup->getFilters() as $filter) {
132 |                 $condition    = $filter->getConditionType() ? $filter->getConditionType() : 'eq';
133 |                 $fields[]     = $filter->getField();
134 |                 $conditions[] = [$condition => $filter->getValue()];
135 |             }
136 |             if ($fields) {
137 |                 $collection->addFieldToFilter($fields, $conditions);
138 |             }
139 |         }
140 |         $searchResults->setTotalCount($collection->getSize());
141 |         $sortOrders = $criteria->getSortOrders();
142 |         if ($sortOrders) {
143 |             /** @var SortOrder $sortOrder */
144 |             foreach ($sortOrders as $sortOrder) {
145 |                 $collection->addOrder(
146 |                     $sortOrder->getField(),
147 |                     ($sortOrder->getDirection() == SortOrder::SORT_ASC) ? 'ASC' : 'DESC'
148 |                 );
149 |             }
150 |         }
151 |         $collection->setCurPage($criteria->getCurrentPage());
152 |         $collection->setPageSize($criteria->getPageSize());
153 |         $objects = [];
154 |         foreach ($collection as $objectModel) {
155 |             $objects[] = $objectModel;
156 |         }
157 |         $searchResults->setItems($objects);
158 | 
159 |         return $searchResults;
160 |     }
161 | }
162 | 


--------------------------------------------------------------------------------
/Observer/ProductSaveAfter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JustCoded\BackInStockConfigurable\Observer;
 4 | 
 5 | use JustCoded\BackInStockConfigurable\Model\Subscription;
 6 | use JustCoded\BackInStockConfigurable\Model\SubscriptionRepository;
 7 | use Magento\Framework\Api\SearchCriteriaBuilder;
 8 | use Magento\Framework\Event\Observer;
 9 | use Magento\Framework\Event\ObserverInterface;
10 | use JustCoded\BackInStockConfigurable\Helper\Data as ModuleHelper;
11 | 
12 | class ProductSaveAfter implements ObserverInterface
13 | {
14 |     /**
15 |      * @var SearchCriteriaBuilder
16 |      */
17 |     protected $searchCriteriaBuilder;
18 | 
19 |     /**
20 |      * @var SubscriptionRepository
21 |      */
22 |     protected $subscriptionRepository;
23 | 
24 |     /**
25 |      * @var ModuleHelper
26 |      */
27 |     protected $moduleHelper;
28 | 
29 |     public function __construct(
30 |         SearchCriteriaBuilder $searchCriteriaBuilder,
31 |         SubscriptionRepository $subscriptionRepository,
32 |         ModuleHelper $moduleHelper
33 |     ) {
34 |         $this->searchCriteriaBuilder  = $searchCriteriaBuilder;
35 |         $this->subscriptionRepository = $subscriptionRepository;
36 |         $this->moduleHelper           = $moduleHelper;
37 |     }
38 | 
39 |     /**
40 |      * Process product notifications
41 |      *
42 |      * @inheritdoc
43 |      */
44 |     public function execute(Observer $observer)
45 |     {
46 |         if ($this->moduleHelper->isScheduledNotifications()) {
47 |             return;
48 |         }
49 | 
50 |         $product = $observer->getProduct();
51 | 
52 |         $searchCriteria = $this->searchCriteriaBuilder
53 |             ->addFilter('product_id', $product->getId())
54 |             ->create();
55 | 
56 |         $subscriptions = $this->subscriptionRepository->getList($searchCriteria)->getItems();
57 | 
58 |         /** @var Subscription $subscription */
59 |         foreach ($subscriptions as $subscription) {
60 |             if ($subscription->isReady($product)) {
61 |                 $subscription->proceed();
62 | 
63 |                 $this->subscriptionRepository->delete($subscription);
64 |             }
65 |         }
66 |     }
67 | }


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | ## Purpose
 2 | 
 3 | Default product alerts in Magento 2 work only for the whole configurable products. This module allows customers to select specific configurations to get notified about.
 4 | 
 5 | ## Description
 6 | 
 7 | A configurable product has a “Can’t find your configuration?” link that opens a product alert popup and will be included at the end of `product.info.extrahint` container by default.
 8 | 
 9 | ![alt tag](https://i.imgur.com/HI2GCjA.png)
10 | 
11 | Parameters in the product alert popup have dependency on the first attribute. Attribute order can be changed in the module settings.
12 | 
13 | ![alt tag](https://i.imgur.com/hBDKHk4.png)
14 | 
15 | ## Installation
16 | 
17 | This module is composer ready so you can install it via command (do not forget to add this repo to the `composer.json` before):
18 | 
19 | ```sh
20 | composer require justcoded/backinstock-configurable:*
21 | ```
22 | 
23 | ## Usage
24 | 
25 | ### General settings
26 | 
27 | Enable the module: 
28 | 
29 | `Stores -> Configuration -> JUSTCODED -> Back in Stock Configurable -> Enable`
30 | 
31 | Set the attribute order in the subscription popup:
32 | 
33 | `Stores -> Configuration -> JUSTCODED -> Back in Stock Configurable -> Attributes Sorting Order Inside of Subscribe Popup`
34 | 
35 | Set CMS block id of popup header:
36 | 
37 | `Stores -> Configuration -> JUSTCODED -> Back in Stock Configurable -> Header CMS Block Identifier of Subscribe Popup`
38 | 
39 | Enable product alert sending by cron (otherwise they are sent on product save process which may take longer):
40 | 
41 | `Stores -> Configuration -> JUSTCODED -> Back in Stock Configurable -> Send Notifications by Schedule`
42 | 
43 | If product alerts are sent by cron, cron expression to trigger the cron is set under :
44 | 
45 | `Stores -> Configuration -> JUSTCODED -> Back in Stock Configurable -> Send Notification Schedule`
46 | 
47 | ## Email templates
48 | 
49 | If you want to customize email templates for product alerts, just create a new email template `back_in_stock_configurable_notification_email_template` or load a default template Back In Stock Configurable Notification and use it as an example.
50 | 
51 | ## Compatibility
52 | 
53 | Fully tested with Magento 2.1.6
54 | 
55 | ## Contact
56 | 
57 | Follow our blog at [http://justcoded.com/blog](http://justcoded.com/blog)
58 | 
59 | ## Maintainers
60 | 
61 | - [Oleg Biriukov](<obirukov@justcoded.co>)
62 | 
63 | ## License
64 | 
65 | The MIT License (MIT)
66 | 
67 | Copyright © 2017 JustCoded
68 | 
69 | Permission is hereby granted free of charge to any person obtaining a copy of this software and associated documentation files (the "Software") to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
70 | 
71 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
72 | 
73 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


--------------------------------------------------------------------------------
/Setup/InstallData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JustCoded\BackInStockConfigurable\Setup;
 4 | 
 5 | use Magento\Framework\Setup\InstallDataInterface;
 6 | use Magento\Framework\Setup\ModuleContextInterface as ModuleContext;
 7 | use Magento\Framework\Setup\ModuleDataSetupInterface as ModuleDataSetup;
 8 | use Magento\Cms\Model\BlockFactory;
 9 | use Magento\Cms\Model\BlockRepository;
10 | 
11 | class InstallData implements InstallDataInterface
12 | {
13 |     const DEFAULT_POPUP_HEADER_CMS_BLOCK_ID = 'back-in-stock-configurable-popup-header';
14 |     const DEFAULT_POPUP_HEADER_CMS_BLOCK_CONTENT = '<div class="back-in-stock-notify-popup-header" style="font-weight: 200;line-height: 1.2;font-size: 1.6rem;margin-bottom: 15px;">Please select the options and enter your email, and we will notify you once this product is back in stock.</div>';
15 |     const DEFAULT_POPUP_HEADER_CMS_BLOCK_TITLE = 'Back In Stock Configurable Popup Header';
16 | 
17 |     /**
18 |      * @var BlockFactory
19 |      */
20 |     private $blockFactory;
21 | 
22 |     /**
23 |      * @var BlockRepository
24 |      */
25 |     private $blockRepository;
26 | 
27 |     public function __construct(
28 |         BlockFactory $blockFactory,
29 |         BlockRepository $blockRepository
30 |     ) {
31 |         $this->blockFactory = $blockFactory;
32 |         $this->blockRepository = $blockRepository;
33 |     }
34 | 
35 |     /**
36 |      * @param ModuleDataSetup $installer
37 |      */
38 |     public function installPopupCmsBlocks(ModuleDataSetup $installer)
39 |     {
40 |         $block = $this->blockFactory->create()->setData([
41 |             'identifier' => self::DEFAULT_POPUP_HEADER_CMS_BLOCK_ID,
42 |             'content'    => self::DEFAULT_POPUP_HEADER_CMS_BLOCK_CONTENT,
43 |             'title'      => self::DEFAULT_POPUP_HEADER_CMS_BLOCK_TITLE,
44 |             'is_active'  => 1,
45 |             'stores'     => [0]
46 |         ]);
47 | 
48 |         $this->blockRepository->save($block);
49 |     }
50 | 
51 |     /**
52 |      * @inheritdoc
53 |      */
54 |     public function install(ModuleDataSetup $setup, ModuleContext $context)
55 |     {
56 |         $installer = $setup;
57 |         $installer->startSetup();
58 | 
59 |         $this->installPopupCmsBlocks($installer);
60 | 
61 |         $installer->endSetup();
62 |     }
63 | }
64 | 


--------------------------------------------------------------------------------
/Setup/InstallSchema.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JustCoded\BackInStockConfigurable\Setup;
 4 | 
 5 | use JustCoded\BackInStockConfigurable\Model\ResourceModel\Subscription;
 6 | use Magento\Framework\DB\Adapter\AdapterInterface;
 7 | use Magento\Framework\DB\Ddl\Table;
 8 | use Magento\Framework\Setup\InstallSchemaInterface;
 9 | use Magento\Framework\Setup\ModuleContextInterface as ModuleContext;
10 | use Magento\Framework\Setup\SchemaSetupInterface as SchemaSetup;
11 | 
12 | class InstallSchema implements InstallSchemaInterface
13 | {
14 |     /**
15 |      * @param SchemaSetup $installer
16 |      */
17 |     private function installSubscriptionsTable(SchemaSetup $installer)
18 |     {
19 |         $table = $installer->getConnection()->newTable(
20 |             $installer->getTable(Subscription::TABLE_NAME)
21 |         )->addColumn(
22 |             Subscription::ID_FIELD_NAME,
23 |             Table::TYPE_INTEGER,
24 |             null,
25 |             [ 'identity' => true, 'nullable' => false, 'primary' => true, 'unsigned' => true, ],
26 |             'Entity ID'
27 |         )->addColumn(
28 |             'email',
29 |             Table::TYPE_TEXT,
30 |             255,
31 |             [ 'nullable' => false, ],
32 |             'Email'
33 |         )->addColumn(
34 |             'product_id',
35 |             Table::TYPE_INTEGER,
36 |             255,
37 |             [ 'nullable' => false, ],
38 |             'Product Id'
39 |         )->addColumn(
40 |             'store_id',
41 |             Table::TYPE_SMALLINT,
42 |             null,
43 |             ['unsigned' => true, 'nullable' => true],
44 |             'Store ID'
45 |         )->addColumn(
46 |             'creation_time',
47 |             Table::TYPE_TIMESTAMP,
48 |             null,
49 |             [ 'nullable' => false, 'default' => Table::TIMESTAMP_INIT, ],
50 |             'Creation Time'
51 |         )->addColumn(
52 |             'update_time',
53 |             Table::TYPE_TIMESTAMP,
54 |             null,
55 |             [ 'nullable' => false, 'default' => Table::TIMESTAMP_INIT_UPDATE, ],
56 |             'Modification Time'
57 |         )->addColumn(
58 |             'is_active',
59 |             Table::TYPE_SMALLINT,
60 |             null,
61 |             [ 'nullable' => false, 'default' => '1', ],
62 |             'Is Active'
63 |         )->addIndex(
64 |             $installer->getIdxName(
65 |                 Subscription::TABLE_NAME,
66 |                 ['email', 'product_id'],
67 |                 AdapterInterface::INDEX_TYPE_UNIQUE
68 |             ),
69 |             ['email', 'product_id'],
70 |             ['type' => AdapterInterface::INDEX_TYPE_UNIQUE]
71 |         )->addIndex($installer->getIdxName(Subscription::TABLE_NAME, ['store_id']), ['store_id']
72 |         )->addForeignKey(
73 |             $installer->getFkName(Subscription::TABLE_NAME, 'store_id', 'store', 'store_id'),
74 |             'store_id',
75 |             $installer->getTable('store'),
76 |             'store_id',
77 |             Table::ACTION_CASCADE,
78 |             Table::ACTION_CASCADE
79 |         );
80 | 
81 |         $installer->getConnection()->createTable($table);
82 |     }
83 | 
84 |     /**
85 |      * @inheritdoc
86 |      */
87 |     public function install(SchemaSetup $setup, ModuleContext $context)
88 |     {
89 |         $installer = $setup;
90 |         $installer->startSetup();
91 |         
92 |         $this->installSubscriptionsTable($installer);
93 | 
94 |         $installer->endSetup();
95 |     }
96 | }
97 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "justcoded/backinstock-configurable",
 3 |   "description": "Magento back in stock notifications for configurable product",
 4 |   "require": {
 5 |     "php": "~5.5.22|~5.6.0|7.0.2|7.0.4|~7.0.6"
 6 |   },
 7 |   "type": "magento2-module",
 8 |   "autoload": {
 9 |     "files": [
10 |       "registration.php"
11 |     ],
12 |     "psr-4": {
13 |       "JustCoded\\BackInStockConfigurable\\": ""
14 |     }
15 |   }
16 | }


--------------------------------------------------------------------------------
/etc/adminhtml/system.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
 3 |     <system>
 4 |         <tab id="justcoded" translate="label" sortOrder="1000">
 5 |             <label>JustCoded</label>
 6 |         </tab>
 7 |         <section id="justcoded_back_in_stock_configurable" translate="label" sortOrder="1000" showInDefault="1" showInWebsite="1" showInStore="1">
 8 |             <label>Back in Stock Configurable</label>
 9 |             <tab>justcoded</tab>
10 |             <resource>JustCoded_BackInStockConfigurable::configuration</resource>
11 |             <group id="settings" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
12 |                 <label>Settings</label>
13 |                 <field id="enabled" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
14 |                     <label>Enabled</label>
15 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
16 |                 </field>
17 |                 <field id="attributes_sorting_order" translate="label comment" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
18 |                     <label>Attributes Sorting Order Inside of Subscribe Popup</label>
19 |                     <comment>comma separated attribute codes</comment>
20 |                     <depends>
21 |                         <field id="enabled">1</field>
22 |                     </depends>
23 |                 </field>
24 |                 <field id="popup_header_cms_block_id" translate="label comment" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
25 |                     <label>Header CMS Block Identifier of Subscribe Popup</label>
26 |                     <depends>
27 |                         <field id="enabled">1</field>
28 |                     </depends>
29 |                 </field>
30 |                 <field id="cron_send_notifications_enable" translate="label comment" type="select" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1">
31 |                     <label>Send Notifications by Schedule</label>
32 |                     <comment>if this option is no, then all notifications will be send on product save (which will be bad for performance)</comment>
33 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
34 |                     <depends>
35 |                         <field id="enabled">1</field>
36 |                     </depends>
37 |                 </field>
38 |                 <field id="cron_expr_send_notifications" translate="label comment" type="text" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
39 |                     <label>Send Notification Schedule</label>
40 |                     <comment>cron expression</comment>
41 |                     <depends>
42 |                         <field id="enabled">1</field>
43 |                         <field id="cron_send_notifications_enable">1</field>
44 |                     </depends>
45 |                 </field>
46 |             </group>
47 |         </section>
48 |     </system>
49 | </config>


--------------------------------------------------------------------------------
/etc/config.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | 
 3 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
 4 |     <default>
 5 |         <justcoded_back_in_stock_configurable>
 6 |             <settings>
 7 |                 <attributes_sorting_order><![CDATA[size,color]]></attributes_sorting_order>
 8 |                 <cron_send_notifications_enable>1</cron_send_notifications_enable>
 9 |                 <cron_expr_send_notifications>*/30 * * * *</cron_expr_send_notifications>
10 |                 <popup_header_cms_block_id>back-in-stock-configurable-popup-header</popup_header_cms_block_id>
11 |             </settings>
12 |         </justcoded_back_in_stock_configurable>
13 |     </default>
14 | </config>


--------------------------------------------------------------------------------
/etc/crontab.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0"?>
2 | 
3 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/crontab.xsd">
4 |     <group id="default">
5 |         <job name="backinstock_configurable_notify_send_mail" instance="JustCoded\BackInStockConfigurable\Cron\Email" method="execute">
6 |             <config_path>justcoded_back_in_stock_configurable/settings/cron_expr_send_notifications</config_path>
7 |         </job>
8 |     </group>
9 | </config>


--------------------------------------------------------------------------------
/etc/di.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0"?>
2 | 
3 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
4 |     <preference for="JustCoded\BackInStockConfigurable\Api\SubscriptionInterface" type="JustCoded\BackInStockConfigurable\Model\SubscriptionManagement" />
5 |     <preference for="JustCoded\BackInStockConfigurable\Api\SubscriptionRepositoryInterface" type="JustCoded\BackInStockConfigurable\Model\SubscriptionRepository" />
6 | </config>
7 | 


--------------------------------------------------------------------------------
/etc/email_templates.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0"?>
2 | 
3 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Email:etc/email_templates.xsd">
4 |     <template id="back_in_stock_configurable_notification_email_template" label="Back In Stock Configurable Notification" file="back_in_stock.html" type="text" module="JustCoded_BackInStockConfigurable" area="frontend"/>
5 | </config>


--------------------------------------------------------------------------------
/etc/events.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0"?>
2 | 
3 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
4 |     <event name="catalog_product_save_after">
5 |         <observer name="send_backinstock_configurable_notifications" instance="JustCoded\BackInStockConfigurable\Observer\ProductSaveAfter" />
6 |     </event>
7 | </config>


--------------------------------------------------------------------------------
/etc/module.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0"?>
2 | 
3 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
4 |     <module name="JustCoded_BackInStockConfigurable" setup_version="0.1.0"></module>
5 | </config>
6 | 


--------------------------------------------------------------------------------
/etc/webapi.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | 
 3 | <routes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4 |         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Webapi:etc/webapi.xsd">
 5 |     <route url="/V1/in-stock-notify/:email/subscribe" method="POST">
 6 |         <service class="JustCoded\BackInStockConfigurable\Api\SubscriptionInterface" method="subscribe"/>
 7 |         <resources>
 8 |             <resource ref="anonymous" />
 9 |         </resources>
10 |     </route>
11 | </routes>
12 | 


--------------------------------------------------------------------------------
/i18n/en_US.csv:
--------------------------------------------------------------------------------
 1 | JustCoded,JustCoded
 2 | "Back in Stock Configurable","Back in Stock Configurable"
 3 | Settings,Settings
 4 | Enabled,Enabled
 5 | "Send Notification Schedule","Send Notification Schedule"
 6 | "Send Notifications by Schedule","Send Notifications by Schedule"
 7 | "if this option is no, then all notifications will be send on product save (which will be bad for performance)","if this option is no, then all notifications will be send on product save (which will be bad for performance)"
 8 | "cron expression","cron expression"
 9 | "Can't find your configuration ?","Can't find your configuration ?"
10 | "Enter Your Name","Enter Your Name"
11 | "Enter Your Email","Enter Your Email"
12 | Submit,Submit
13 | "Please select an option","Please select an option"
14 | "You have no product for subscription.","You have no product for subscription."
15 | "You will be notified when product becomes available.","You will be notified when product becomes available."
16 | "Something went wrong during stock subscription, please try again later.","Something went wrong during stock subscription, please try again later.",
17 | "Attributes Sorting Order Inside of Subscribe Popup","Attributes Sorting Order Inside of Subscribe Popup"
18 | "comma separated attribute codes","comma separated attribute codes"
19 | "Subscribe to back in stock notification","Subscribe to back in stock notification"
20 | "Header CMS Block Identifier of Subscribe Popup","Header CMS Block Identifier of Subscribe Popup"
21 | 


--------------------------------------------------------------------------------
/registration.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | \Magento\Framework\Component\ComponentRegistrar::register(
4 |     \Magento\Framework\Component\ComponentRegistrar::MODULE,
5 |     'JustCoded_BackInStockConfigurable',
6 |     __DIR__
7 | );
8 | 


--------------------------------------------------------------------------------
/view/frontend/email/back_in_stock.html:
--------------------------------------------------------------------------------
1 | <!--@subject Back In Stock@-->
2 | Product {{var product.getName()}} is back in stock


--------------------------------------------------------------------------------
/view/frontend/layout/catalog_product_view_type_configurable.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | 
 3 | <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
 4 |     <head>
 5 |         <css src="JustCoded_BackInStockConfigurable::css/subscribe-form.css"/>
 6 |     </head>
 7 | 
 8 |     <body>
 9 |         <referenceContainer name="before.body.end">
10 |             <block class="JustCoded\BackInStockConfigurable\Block\Product\View" name="back-in-stock-configurable-subscribe-form"
11 |                    template="product/configurable/subscribe_form.phtml"/>
12 |         </referenceContainer>
13 | 
14 |         <referenceContainer name="product.info.extrahint">
15 |             <block class="JustCoded\BackInStockConfigurable\Block\Product\View" name="back-in-stock-configurable-subscribe-link"
16 |                    template="product/configurable/subscribe_link.phtml" after="-"/>
17 |         </referenceContainer>
18 |     </body>
19 | </page>


--------------------------------------------------------------------------------
/view/frontend/templates/product/configurable/subscribe_form.phtml:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /** @var JustCoded\BackInStockConfigurable\Block\Product\View $block */
  3 | ?>
  4 | 
  5 | <div style="display: none;">
  6 |     <div data-role="back-in-stock-notify-popup-content">
  7 |         <form data-role="back-in-stock-notify-form">
  8 |             <fieldset class="fieldset create stock-subscription">
  9 |                 <legend class="legend"><span><?php echo __('Subscribe to back in stock notification') ?></span></legend>
 10 | 
 11 |                 <?php echo $this->getHeaderContent() ?>
 12 | 
 13 |                 <?php $orderIndex = 1 ?>
 14 |                 <?php foreach ($this->getConfigurableAttributes() as $attribute): ?>
 15 |                     <div class="field option required">
 16 |                         <label for="stock-notification-subscription-<?php echo $attribute->getId() ?>" class="label">
 17 |                             <span><?php echo $attribute->getFrontendLabel() ?></span>
 18 |                         </label>
 19 |                         <div class="control">
 20 |                             <select name="stock-notification-subscription-<?php echo $attribute->getId() ?>"
 21 |                                    title="<?php echo $attribute->getFrontendLabel() ?>"
 22 |                                    id="stock-notification-subscription-<?php echo $attribute->getId() ?>"
 23 |                                    data-role="stock-notifications-option"
 24 |                                    data-stock-notification-order="<?php echo $orderIndex ?>"
 25 |                                    required="required"
 26 |                                    data-validate="{required:true}" autocomplete="off" aria-required="true">
 27 |                                 <option value><?php echo __('Please select an option') ?></option>
 28 |                                 <?php foreach ($this->getConfigurableAttributeOptions($attribute) as $optionId => $option): ?>
 29 |                                     <option value='<?php echo $optionId ?>'
 30 |                                             data-product-ids='<?php echo json_encode($option['product_ids']) ?>'>
 31 |                                         <?php echo $option['label'] ?>
 32 |                                     </option>
 33 |                                 <?php endforeach ?>
 34 |                             </select>
 35 |                         </div>
 36 |                     </div>
 37 | 
 38 |                     <?php $orderIndex++ ?>
 39 |                 <?php endforeach ?>
 40 | 
 41 |                 <div class="field option required">
 42 |                     <label for="stock-notification-subscription-email" class="label">
 43 |                         <span><?php /*escapeNotVerified*/ echo __('Enter Your Email') ?></span>
 44 |                     </label>
 45 |                     <div class="control">
 46 |                         <input name="email" id="email" type="email" required="required" class="input-text"
 47 |                                title="<?php /*escapeNotVerified*/ echo __('Enter Your Email')?>"/>
 48 |                     </div>
 49 |                 </div>
 50 | 
 51 |                 <button type="submit" style="display: none"><?php /*escapeNotVerified*/ echo __('Submit') ?></button>
 52 |             </fieldset>
 53 |         </form>
 54 |     </div>
 55 | </div>
 56 | 
 57 | <script>
 58 |     require([
 59 |         'jquery',
 60 |         'underscore',
 61 |         'mage/storage',
 62 |         'Magento_Ui/js/modal/modal',
 63 |         'Magento_Ui/js/modal/alert'
 64 |     ], function ($, _, storage, modal, alert) {
 65 |         var formPopup = $('[data-role="back-in-stock-notify-popup-content"]').modal(getPopupOptions()),
 66 |             form = $('[data-role="back-in-stock-notify-form"]'),
 67 |             optionSelects = $('[data-role="stock-notifications-option"]'),
 68 |             serviceUrl = '<?php echo $block->getServiceUrl() ?>',
 69 |             currentConfigurableProduct = $('#product_addtocart_form input[name="product"]').val(),
 70 |             MODAL_OPEN_DELAY = 600;
 71 | 
 72 |         function getPopupOptions() {
 73 |             return {
 74 |                 type: 'popup',
 75 |                 responsive: true,
 76 |                 innerScroll: false,
 77 |                 modalClass: 'back-in-stock-configurable-notification-modal',
 78 |                 title: '',
 79 |                 buttons: [{
 80 |                     text: '<?php echo __('Submit') ?>',
 81 |                     'class': 'action primary',
 82 |                     click: function () {
 83 |                         form.find('button[type="submit"]').click();
 84 |                     }
 85 |                 }]
 86 |             }
 87 |         }
 88 | 
 89 |         function getAlertOptions() {
 90 |             return {
 91 |                 modalClass: 'back-in-stock-configurable-notification-alert'
 92 |             }
 93 |         }
 94 | 
 95 |         function sendRequest(email, data, cb) {
 96 |             var url = serviceUrl.replace(':email', encodeURIComponent(email));
 97 | 
 98 |             $.ajax({
 99 |                 url: url,
100 |                 type: 'POST',
101 |                 data: JSON.stringify(data),
102 |                 global: true,
103 |                 contentType: 'application/json',
104 |                 showLoader: true
105 |             }).done(
106 |                 function (response) {
107 |                     cb(false, response);
108 |                 }
109 |             ).fail(
110 |                 function (response) {
111 |                     cb(true, response);
112 |                 }
113 |             );
114 |         }
115 | 
116 |         function normalizeOptionsSelect(targetSelects, dependedSelects) {
117 |             var selectedOptions = targetSelects.find('option:selected'),
118 |                 selectedProductIds = _.union.apply(_, selectedOptions.toArray().map(function (el) { return $(el).data('productIds') }));
119 | 
120 |             dependedSelects.each(function (i, el) {
121 |                 var dependedSelect = $(el);
122 | 
123 |                 dependedSelect.find('option').show().each(function (i, el) {
124 |                     var option = $(el),
125 |                         dependedOptionProductIds = option.data('productIds');
126 | 
127 |                     if (!option.val() || _.intersection(dependedOptionProductIds, selectedProductIds).length) {
128 |                         option.show().prop('disabled', false);
129 |                     } else {
130 |                         option.hide().prop('disabled', true);
131 | 
132 |                         if (option.is(':selected')) {
133 |                             dependedSelect.val('');
134 |                         }
135 |                     }
136 |                 });
137 |             });
138 |         }
139 | 
140 |         $(document).on('click', '[data-role="back-in-stock-popup-link"]', function () {
141 |             formPopup.modal('openModal');
142 |         });
143 | 
144 |         form.on('change', '[data-role="stock-notifications-option"]', function (ev) {
145 |             var targetOptionSelect = $(ev.target),
146 |                 targetOptionSelectOrder = targetOptionSelect.data('stock-notification-order');
147 | 
148 |             normalizeOptionsSelect(
149 |                 optionSelects.toArray()
150 |                     .filter(function (el) { return $(el).data('stock-notification-order') <= targetOptionSelectOrder })
151 |                     .reduce(function (collection, el) { return collection.add($(el)) }, $()),
152 |                 optionSelects.toArray()
153 |                     .filter(function (el) { return targetOptionSelectOrder < $(el).data('stock-notification-order') })
154 |                     .reduce(function (collection, el) { return collection.add($(el)) }, $()),
155 |             );
156 |         });
157 | 
158 |         form.on('submit', function (ev) {
159 |             ev.preventDefault();
160 | 
161 |             var selectedOptionsProducts = optionSelects.find('option:selected').toArray()
162 |                 .map(function (el) {
163 |                     return $(el).data('productIds');
164 |                 }),
165 |                 selectedProduct = _.intersection.apply(_, selectedOptionsProducts)[0],
166 |                 withError = false;
167 | 
168 |             if (!selectedProduct) {
169 |                 formPopup.modal('closeModal');
170 | 
171 |                 setTimeout(function () {
172 |                     alert(_.extend({}, getAlertOptions(), {
173 |                         content: "<?php echo __('You have no product for subscription.') ?>"
174 |                     }));
175 |                 }, MODAL_OPEN_DELAY);
176 |             } else {
177 |                 formPopup.modal('closeModal');
178 | 
179 |                 setTimeout(function () {
180 |                     if (withError) {
181 |                         return;
182 |                     }
183 | 
184 |                     form[0].reset();
185 | 
186 |                     alert(_.extend({}, getAlertOptions(), {
187 |                         content: "<?php echo __('You will be notified when product becomes available.') ?>"
188 |                     }));
189 |                 }, 600);
190 | 
191 |                 sendRequest(form.find('[name="email"]').val(), {
192 |                     simple: JSON.stringify({id: selectedProduct}),
193 |                     configurable: JSON.stringify({id: currentConfigurableProduct})
194 |                 }, function (err) {
195 |                     if (err) {
196 |                         withError = true;
197 | 
198 |                         alert(_.extend({}, getAlertOptions(), {
199 |                             content: "<?php echo __('Something went wrong during stock subscription, please try again later.') ?>"
200 |                         }));
201 |                     }
202 |                 });
203 |             }
204 |         });
205 |     });
206 | </script>


--------------------------------------------------------------------------------
/view/frontend/templates/product/configurable/subscribe_link.phtml:
--------------------------------------------------------------------------------
1 | <?php
2 | /** @var JustCoded\BackInStockConfigurable\Block\Product\View $block */
3 | ?>
4 | 
5 | <div class="back-in-stock-configurable-link align-center">
6 |     <a class="uppercase" href="#" data-role="back-in-stock-popup-link">
7 |         <?php /*escapeNotVerified*/ echo __("Can't find your configuration ?") ?>
8 |     </a>
9 | </div>


--------------------------------------------------------------------------------
/view/frontend/web/css/subscribe-form.css:
--------------------------------------------------------------------------------
1 | .back-in-stock-configurable-notification-modal .modal-inner-wrap {
2 |     max-width: 400px;
3 | }
4 | 
5 | .back-in-stock-configurable-notification-alert .modal-inner-wrap {
6 |     max-width: 400px;
7 | }


--------------------------------------------------------------------------------