first commit

modules/roy_specials/Readme.md

@@ -0,0 +1,37 @@
+# Specials block
+
+## About
+
+Displays your products that are currently on sale in a dedicated block.
+
+## Contributing
+
+PrestaShop modules are open-source extensions to the PrestaShop e-commerce solution. Everyone is welcome and even encouraged to contribute with their own improvements.
+
+### Requirements
+
+Contributors **must** follow the following rules:
+
+* **Make your Pull Request on the "dev" branch**, NOT the "master" branch.
+* Do not update the module's version number.
+* Follow [the coding standards][1].
+
+### Process in details
+
+Contributors wishing to edit a module's files should follow the following process:
+
+1. Create your GitHub account, if you do not have one already.
+2. Fork the ps_specials project to your GitHub account.
+3. Clone your fork to your local machine in the ```/modules``` directory of your PrestaShop installation.
+4. Create a branch in your local clone of the module for your changes.
+5. Change the files in your branch. Be sure to follow [the coding standards][1]!
+6. Push your changed branch to your fork in your GitHub account.
+7. Create a pull request for your changes **on the _'dev'_ branch** of the module's project. Be sure to follow [the commit message norm][2] in your pull request. If you need help to make a pull request, read the [Github help page about creating pull requests][3].
+8. Wait for one of the core developers either to include your change in the codebase, or to comment on possible improvements you should make to your code.
+
+That's it: you have contributed to this open-source project! Congratulations!
+
+[1]: http://doc.prestashop.com/display/PS16/Coding+Standards
+[2]: http://doc.prestashop.com/display/PS16/How+to+write+a+commit+message
+[3]: https://help.github.com/articles/using-pull-requests
+

modules/roy_specials/composer.json

@@ -0,0 +1,19 @@
+{
+  "name": "prestashop/ps_specials",
+  "description": "PrestaShop - Specials",
+  "homepage": "https://github.com/PrestaShop/ps_specials",
+  "license": "AFL - Academic Free License (AFL 3.0)",
+  "authors": [
+    {
+      "name": "PrestaShop SA",
+      "email": "contact@prestashop.com"
+    }
+  ],
+  "require": {
+    "php": ">=5.4.0"
+  },
+  "config": {
+    "preferred-install": "dist"
+  },
+  "type": "prestashop-module"
+}

modules/roy_specials/config.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<module>
+    <name>roy_specials</name>
+    <displayName><![CDATA[Roy Specials block]]></displayName>
+    <version><![CDATA[1.0.0]]></version>
+    <description><![CDATA[Displays your products that are currently on sale in a dedicated block.]]></description>
+    <author><![CDATA[RoyThemes]]></author>
+    <tab><![CDATA[]]></tab>
+    <is_configurable>1</is_configurable>
+    <need_instance>0</need_instance>
+	<limited_countries></limited_countries>
+</module>

modules/roy_specials/config_pl.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<module>
+    <name>roy_specials</name>
+    <displayName><![CDATA[Roy Specials block]]></displayName>
+    <version><![CDATA[1.0.0]]></version>
+    <description><![CDATA[Displays your products that are currently on sale in a dedicated block.]]></description>
+    <author><![CDATA[RoyThemes]]></author>
+    <tab><![CDATA[]]></tab>
+    <is_configurable>1</is_configurable>
+    <need_instance>0</need_instance>
+	<limited_countries></limited_countries>
+</module>

modules/roy_specials/index.php

@@ -0,0 +1,35 @@
+<?php
+/*
+* 2007-2016 PrestaShop
+*
+* NOTICE OF LICENSE
+*
+* This source file is subject to the Academic Free License (AFL 3.0)
+* that is bundled with this package in the file LICENSE.txt.
+* It is also available through the world-wide-web at this URL:
+* http://opensource.org/licenses/afl-3.0.php
+* If you did not receive a copy of the license and are unable to
+* obtain it through the world-wide-web, please send an email
+* to license@prestashop.com so we can send you a copy immediately.
+*
+* DISCLAIMER
+*
+* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+* versions in the future. If you wish to customize PrestaShop for your
+* needs please refer to http://www.prestashop.com for more information.
+*
+*  @author PrestaShop SA <contact@prestashop.com>
+*  @copyright  2007-2016 PrestaShop SA
+*  @license    http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
+*  International Registered Trademark & Property of PrestaShop SA
+*/
+                        
+header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
+header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
+                        
+header("Cache-Control: no-store, no-cache, must-revalidate");
+header("Cache-Control: post-check=0, pre-check=0", false);
+header("Pragma: no-cache");
+                        
+header("Location: ../");
+exit;

modules/roy_specials/roy_specials.php

@@ -0,0 +1,268 @@
+<?php
+
+use PrestaShop\PrestaShop\Core\Module\WidgetInterface;
+use PrestaShop\PrestaShop\Adapter\Image\ImageRetriever;
+use PrestaShop\PrestaShop\Adapter\Product\PriceFormatter;
+use PrestaShop\PrestaShop\Core\Product\ProductListingPresenter;
+use PrestaShop\PrestaShop\Adapter\Product\ProductColorsRetriever;
+
+if (!defined('_PS_VERSION_')) {
+    exit;
+}
+
+class Roy_Specials extends Module implements WidgetInterface
+{
+    private $templateFile;
+
+    public function __construct()
+    {
+        $this->name = 'roy_specials';
+        $this->author = 'RoyThemes';
+        $this->version = '1.0.0';
+        $this->need_instance = 0;
+
+        $this->ps_versions_compliancy = array(
+            'min' => '1.7.0.0',
+            'max' => _PS_VERSION_
+        );
+
+        $this->bootstrap = true;
+        parent::__construct();
+
+        $this->displayName = $this->trans('Roy Specials block');
+        $this->description = $this->trans('Displays your products that are currently on sale in a dedicated block.');
+
+        $this->templateFile = 'module:roy_specials/views/templates/hook/roy_specials.tpl';
+        $this->templateFileCol = 'module:roy_specials/views/templates/hook/roy_specials_col.tpl';
+    }
+
+    public function install()
+    {
+        $this->_clearCache('*');
+
+        Configuration::updateValue('ROYSPECIALS_SPECIALS_NBR', 8);
+
+        return parent::install()
+            && $this->registerHook('actionProductAdd')
+            && $this->registerHook('actionProductUpdate')
+            && $this->registerHook('actionProductDelete')
+            && $this->registerHook('actionObjectSpecificPriceCoreDeleteAfter')
+            && $this->registerHook('actionObjectSpecificPriceCoreAddAfter')
+            && $this->registerHook('actionObjectSpecificPriceCoreUpdateAfter')
+            && $this->registerHook('displayHome')
+            && $this->registerHook('displayLeftColumn')
+            && $this->registerHook('displayRightColumn');
+    }
+
+    public function uninstall()
+    {
+        $this->_clearCache('*');
+
+        return parent::uninstall();
+    }
+
+    public function hookActionProductAdd($params)
+    {
+        $this->_clearCache('*');
+    }
+
+    public function hookActionProductUpdate($params)
+    {
+        $this->_clearCache('*');
+    }
+
+    public function hookActionProductDelete($params)
+    {
+        $this->_clearCache('*');
+    }
+
+    public function hookActionObjectSpecificPriceCoreDeleteAfter($params)
+    {
+        $this->_clearCache('*');
+    }
+
+    public function hookActionObjectSpecificPriceCoreAddAfter($params)
+    {
+        $this->_clearCache('*');
+    }
+
+    public function hookActionObjectSpecificPriceCoreUpdateAfter($params)
+    {
+        $this->_clearCache('*');
+    }
+
+    public function _clearCache($template, $cache_id = null, $compile_id = null)
+    {
+        parent::_clearCache($this->templateFile);
+        parent::_clearCache($this->templateFileCol);
+    }
+
+    public function getContent()
+    {
+        $output = '';
+
+        if (Tools::isSubmit('submitSpecials')) {
+            Configuration::updateValue('ROYSPECIALS_SPECIALS_NBR', (int)Tools::getValue('ROYSPECIALS_SPECIALS_NBR'));
+
+            $this->_clearCache('*');
+
+            $output .= $this->displayConfirmation($this->trans('The settings have been updated.', array(), 'Admin.Notifications.Success'));
+        }
+        return $output.$this->renderForm();
+    }
+
+    public function renderForm()
+    {
+        $fields_form = array(
+            'form' => array(
+                'legend' => array(
+                    'title' => $this->trans('Settings', array(), 'Admin.Global'),
+                    'icon' => 'icon-cogs'
+                ),
+                'input' => array(
+                    array(
+                        'type' => 'text',
+                        'label' => $this->trans('Products to display', array(), 'Modules.Specials.Admin'),
+                        'name' => 'ROYSPECIALS_SPECIALS_NBR',
+                        'class' => 'fixed-width-xs',
+                        'desc' => $this->trans('Define the number of products to be displayed in this block on home page.', array(), 'Modules.Specials.Admin'),
+                    ),
+                ),
+                'submit' => array(
+                    'title' => $this->trans('Save', array(), 'Admin.Actions'),
+                ),
+            ),
+        );
+
+        $lang = new Language((int)Configuration::get('PS_LANG_DEFAULT'));
+
+        $helper = new HelperForm();
+        $helper->show_toolbar = false;
+        $helper->table = $this->table;
+        $helper->default_form_language = $lang->id;
+        $helper->allow_employee_form_lang = Configuration::get('PS_BO_ALLOW_EMPLOYEE_FORM_LANG') ? Configuration::get('PS_BO_ALLOW_EMPLOYEE_FORM_LANG') : 0;
+        $helper->identifier = $this->identifier;
+        $helper->submit_action = 'submitSpecials';
+        $helper->currentIndex = $this->context->link->getAdminLink('AdminModules', false) .
+            '&configure=' . $this->name .
+            '&tab_module=' . $this->tab .
+            '&module_name=' . $this->name;
+        $helper->token = Tools::getAdminTokenLite('AdminModules');
+        $helper->tpl_vars = array(
+            'fields_value' => $this->getConfigFieldsValues(),
+            'languages' => $this->context->controller->getLanguages(),
+            'id_language' => $this->context->language->id
+        );
+
+        return $helper->generateForm(array($fields_form));
+    }
+
+    public function getConfigFieldsValues()
+    {
+        return array(
+            'ROYSPECIALS_SPECIALS_NBR' => Tools::getValue('ROYSPECIALS_SPECIALS_NBR', Configuration::get('ROYSPECIALS_SPECIALS_NBR')),
+        );
+    }
+
+    public function renderWidget($hookName = null, array $configuration = [])
+    {
+        if (!$this->isCached($this->templateFile, $this->getCacheId('roy_specials'))) {
+            $variables = $this->getWidgetVariables($hookName, $configuration);
+
+            if (empty($variables)) {
+                return false;
+            }
+
+            $this->smarty->assign($variables);
+        }
+
+        return $this->fetch($this->templateFile, $this->getCacheId('roy_specials'));
+
+    }
+
+    public function hookDisplayLeftColumn($params)
+    {
+    		global $smarty;
+
+        if (!$this->active) {
+            return;
+        }
+
+        $products = $this->getSpecialProducts();
+
+  			$smarty->assign(array(
+            'products' => $products,
+            'allSpecialProductsLink' => Context::getContext()->link->getPageLink('prices-drop')
+  			));
+
+        return $this->fetch('module:roy_specials/views/templates/hook/roy_specials_col.tpl');
+    }
+
+    public function hookDisplayRightColumn($params)
+    {
+    		global $smarty;
+
+        if (!$this->active) {
+            return;
+        }
+
+        $products = $this->getSpecialProducts();
+
+  			$smarty->assign(array(
+            'products' => $products,
+            'allSpecialProductsLink' => Context::getContext()->link->getPageLink('prices-drop')
+  			));
+
+        return $this->fetch('module:roy_specials/views/templates/hook/roy_specials_col.tpl');
+    }
+
+    public function getWidgetVariables($hookName = null, array $configuration = [])
+    {
+        $products = $this->getSpecialProducts();
+
+        if (!empty($products)) {
+            return array(
+                'products' => $products,
+                'allSpecialProductsLink' => Context::getContext()->link->getPageLink('prices-drop'),
+            );
+        }
+        return false;
+    }
+
+    private function getSpecialProducts()
+    {
+        $products = Product::getPricesDrop(
+            (int)Context::getContext()->language->id,
+            0,
+            (int)Configuration::get('ROYSPECIALS_SPECIALS_NBR')
+        );
+
+        $assembler = new ProductAssembler($this->context);
+
+        $presenterFactory = new ProductPresenterFactory($this->context);
+        $presentationSettings = $presenterFactory->getPresentationSettings();
+        $presenter = new ProductListingPresenter(
+            new ImageRetriever(
+                $this->context->link
+            ),
+            $this->context->link,
+            new PriceFormatter(),
+            new ProductColorsRetriever(),
+            $this->context->getTranslator()
+        );
+
+        $products_for_template = array();
+
+        if (is_array($products)) {
+            foreach ($products as $rawProduct) {
+                $products_for_template[] = $presenter->present(
+                    $presentationSettings,
+                    $assembler->assembleProduct($rawProduct),
+                    $this->context->language
+                );
+            }
+        }
+
+        return $products_for_template;
+    }
+}

modules/roy_specials/translations/index.php

@@ -0,0 +1,35 @@
+<?php
+/*
+* 2007-2016 PrestaShop
+*
+* NOTICE OF LICENSE
+*
+* This source file is subject to the Academic Free License (AFL 3.0)
+* that is bundled with this package in the file LICENSE.txt.
+* It is also available through the world-wide-web at this URL:
+* http://opensource.org/licenses/afl-3.0.php
+* If you did not receive a copy of the license and are unable to
+* obtain it through the world-wide-web, please send an email
+* to license@prestashop.com so we can send you a copy immediately.
+*
+* DISCLAIMER
+*
+* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+* versions in the future. If you wish to customize PrestaShop for your
+* needs please refer to http://www.prestashop.com for more information.
+*
+*  @author PrestaShop SA <contact@prestashop.com>
+*  @copyright  2007-2016 PrestaShop SA
+*  @license    http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
+*  International Registered Trademark & Property of PrestaShop SA
+*/
+                        
+header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
+header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
+                        
+header("Cache-Control: no-store, no-cache, must-revalidate");
+header("Cache-Control: post-check=0, pre-check=0", false);
+header("Pragma: no-cache");
+                        
+header("Location: ../");
+exit;

modules/roy_specials/views/index.php

@@ -0,0 +1,35 @@
+<?php
+/*
+* 2007-2016 PrestaShop
+*
+* NOTICE OF LICENSE
+*
+* This source file is subject to the Academic Free License (AFL 3.0)
+* that is bundled with this package in the file LICENSE.txt.
+* It is also available through the world-wide-web at this URL:
+* http://opensource.org/licenses/afl-3.0.php
+* If you did not receive a copy of the license and are unable to
+* obtain it through the world-wide-web, please send an email
+* to license@prestashop.com so we can send you a copy immediately.
+*
+* DISCLAIMER
+*
+* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+* versions in the future. If you wish to customize PrestaShop for your
+* needs please refer to http://www.prestashop.com for more information.
+*
+*  @author PrestaShop SA <contact@prestashop.com>
+*  @copyright  2007-2016 PrestaShop SA
+*  @license    http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
+*  International Registered Trademark & Property of PrestaShop SA
+*/
+
+header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
+header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
+
+header('Cache-Control: no-store, no-cache, must-revalidate');
+header('Cache-Control: post-check=0, pre-check=0', false);
+header('Pragma: no-cache');
+
+header('Location: ../');
+exit;

modules/roy_specials/views/templates/hook/index.php

@@ -0,0 +1,35 @@
+<?php
+/*
+* 2007-2016 PrestaShop
+*
+* NOTICE OF LICENSE
+*
+* This source file is subject to the Academic Free License (AFL 3.0)
+* that is bundled with this package in the file LICENSE.txt.
+* It is also available through the world-wide-web at this URL:
+* http://opensource.org/licenses/afl-3.0.php
+* If you did not receive a copy of the license and are unable to
+* obtain it through the world-wide-web, please send an email
+* to license@prestashop.com so we can send you a copy immediately.
+*
+* DISCLAIMER
+*
+* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+* versions in the future. If you wish to customize PrestaShop for your
+* needs please refer to http://www.prestashop.com for more information.
+*
+*  @author PrestaShop SA <contact@prestashop.com>
+*  @copyright  2007-2016 PrestaShop SA
+*  @license    http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
+*  International Registered Trademark & Property of PrestaShop SA
+*/
+
+header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
+header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
+
+header('Cache-Control: no-store, no-cache, must-revalidate');
+header('Cache-Control: post-check=0, pre-check=0', false);
+header('Pragma: no-cache');
+
+header('Location: ../');
+exit;

modules/roy_specials/views/templates/hook/roy_specials.tpl

@@ -0,0 +1,38 @@
+{**
+ * 2007-2017 PrestaShop
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License 3.0 (AFL-3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to http://www.prestashop.com for more information.
+ *
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2007-2017 PrestaShop SA
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
+ * International Registered Trademark & Property of PrestaShop SA
+ *}
+
+<section class="featured-products clearfix mt-3">
+  <h1 class="h1 products-section-title text-uppercase">
+    <a href="{$allSpecialProductsLink}">
+      {l s='On sale' d='Shop.Theme.Catalog'}
+      <i></i>
+    </a>
+  </h1>
+  <div class="products">
+    {foreach from=$products item="product"}
+      {include file="catalog/_partials/miniatures/product.tpl" product=$product}
+    {/foreach}
+  </div>
+</section>

modules/roy_specials/views/templates/hook/roy_specials_col.tpl

@@ -0,0 +1,12 @@
+<section class="specials-col featured-products clearfix mt-3">
+  <h1 class="h1 products-section-title text-uppercase">
+    <a href="{$allSpecialProductsLink}">
+      <i></i>
+    </a>
+  </h1>
+  <div class="products">
+    {foreach from=$products item="product"}
+      {include file="catalog/_partials/miniatures/product.tpl" product=$product}
+    {/foreach}
+  </div>
+</section>

modules/roy_specials/views/templates/index.php

@@ -0,0 +1,35 @@
+<?php
+/*
+* 2007-2016 PrestaShop
+*
+* NOTICE OF LICENSE
+*
+* This source file is subject to the Academic Free License (AFL 3.0)
+* that is bundled with this package in the file LICENSE.txt.
+* It is also available through the world-wide-web at this URL:
+* http://opensource.org/licenses/afl-3.0.php
+* If you did not receive a copy of the license and are unable to
+* obtain it through the world-wide-web, please send an email
+* to license@prestashop.com so we can send you a copy immediately.
+*
+* DISCLAIMER
+*
+* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+* versions in the future. If you wish to customize PrestaShop for your
+* needs please refer to http://www.prestashop.com for more information.
+*
+*  @author PrestaShop SA <contact@prestashop.com>
+*  @copyright  2007-2016 PrestaShop SA
+*  @license    http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
+*  International Registered Trademark & Property of PrestaShop SA
+*/
+
+header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
+header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
+
+header('Cache-Control: no-store, no-cache, must-revalidate');
+header('Cache-Control: post-check=0, pre-check=0', false);
+header('Pragma: no-cache');
+
+header('Location: ../');
+exit;