vendor/isotope/isotope-core/system/modules/isotope/library/Isotope/Module/Module.php line 115

Open in your IDE?
  1. <?php
  3. /*
  4.  * Isotope eCommerce for Contao Open Source CMS
  5.  *
  6.  * Copyright (C) 2009 - 2019 terminal42 gmbh & Isotope eCommerce Workgroup
  7.  *
  8.  * @link       https://isotopeecommerce.org
  9.  * @license    https://opensource.org/licenses/lgpl-3.0.html
  10.  */
  12. namespace Isotope\Module;
  14. use Contao\Controller;
  15. use Contao\Database;
  16. use Contao\Date;
  17. use Contao\Environment;
  18. use Contao\FrontendUser;
  19. use Contao\System;
  20. use Haste\Frontend\AbstractFrontendModule;
  21. use Haste\Input\Input;
  22. use Haste\Util\Debug;
  23. use Isotope\Frontend;
  24. use Isotope\Interfaces\IsotopeProduct;
  25. use Isotope\Isotope;
  26. use Isotope\Message;
  27. use Isotope\Model\Product;
  28. use Isotope\Model\Product\AbstractProduct;
  29. use Isotope\RequestCache\CategoryFilter;
  30. use PageModel;
  33. /**
  34.  * Module implements a parent class for Isotope modules
  35.  *
  36.  * @property string $iso_category_scope
  37.  * @property string $iso_list_where
  38.  * @property string $iso_includeMessages
  39.  * @property bool   $iso_hide_list
  40.  * @property bool   $iso_disable_options
  41.  * @property bool   $iso_emptyMessage
  42.  * @property string $iso_noProducts
  43.  * @property bool   $iso_emptyFilter
  44.  * @property string $iso_newFilter
  45.  * @property string $iso_noFilter
  46.  * @property array  $iso_buttons
  47.  * @property bool   $iso_link_primary
  48.  */
  49. abstract class Module extends AbstractFrontendModule
  50. {
  52.     /**
  53.      * Disable caching of the frontend page if this module is in use.
  54.      * Usefule to enable in a child classes.
  55.      * @var bool
  56.      */
  57.     protected $blnDisableCache = false;
  59.     /**
  60.      * Cache category lookup
  61.      * @var array
  62.      */
  63.     private $arrCategories;
  66.     /**
  67.      * Load libraries and scripts
  68.      *
  69.      * @param \ModuleModel $objModule
  70.      * @param string $strColumn
  71.      */
  72.     public function __construct($objModule, $strColumn = 'main')
  73.     {
  74.         parent::__construct($objModule, $strColumn);
  76.         if ($this->iso_list_where != '') {
  77.             $this->iso_list_where = Controller::replaceInsertTags($this->iso_list_where);
  78.         }
  80.         Isotope::initialize();
  82.         // Load Isotope JavaScript and style sheet
  83.         if ('FE' === TL_MODE) {
  84.             $GLOBALS['TL_JAVASCRIPT'][] = Debug::uncompressedFile(
  85.                 'system/modules/isotope/assets/js/isotope.min.js|static'
  86.             );
  88.             $GLOBALS['TL_CSS'][] = Debug::uncompressedFile(
  89.                 'system/modules/isotope/assets/css/isotope.min.css|screen|static'
  90.             );
  92.             // Disable caching for pages with certain modules (eg. Cart)
  93.             if ($this->blnDisableCache) {
  94.                 global $objPage;
  95.                 $objPage->cache = 0;
  96.             }
  97.         }
  98.     }
  100.     /**
  101.      * @inheritDoc
  102.      */
  103.     protected function getSerializedProperties()
  104.     {
  105.         return ['iso_buttons'];
  106.     }
  108.     /**
  109.      * Include messages if enabled
  110.      *
  111.      * @return string
  112.      */
  113.     public function generate()
  114.     {
  115.         $strBuffer = parent::generate();
  117.         // Prepend any messages to the module output
  118.         if ('BE' !== TL_MODE && $this->iso_includeMessages) {
  119.             $strBuffer = Message::generate() . $strBuffer;
  120.         }
  122.         return $strBuffer;
  123.     }
  125.     /**
  126.      * The ids of all pages we take care of. This is what should later be used eg. for filter data.
  127.      *
  128.      * @return array|null
  129.      */
  130.     protected function findCategories(array &$arrFilters = null)
  131.     {
  132.         if (null !== $arrFilters) {
  133.             $arrCategories = null;
  135.             foreach ($arrFilters as $k => $filter) {
  136.                 if ($filter instanceof CategoryFilter) {
  137.                     unset($arrFilters[$k]);
  139.                     if (!\is_array($arrCategories)) {
  140.                         $arrCategories = $filter['value'];
  141.                     } else {
  142.                         $arrCategories = array_intersect($arrCategories, $filter['value']);
  143.                     }
  144.                 }
  145.             }
  147.             if (\is_array($arrCategories)) {
  148.                 return empty($arrCategories) ? array(0) : array_map('intval', $arrCategories);
  149.             }
  150.         }
  152.         if (null !== $this->arrCategories) {
  153.             return $this->arrCategories;
  154.         }
  156.         if ($this->defineRoot && $this->rootPage > 0) {
  157.             $objPage = PageModel::findWithDetails($this->rootPage);
  158.         } else {
  159.             global $objPage;
  160.         }
  162.         $t = PageModel::getTable();
  163.         $arrCategories = null;
  164.         $strWhere = "$t.type!='error_403' AND $t.type!='error_404'";
  166.         if (!BE_USER_LOGGED_IN) {
  167.             $time = Date::floorToMinute();
  168.             $strWhere .= " AND ($t.start='' OR $t.start<'$time') AND ($t.stop='' OR $t.stop>'" . ($time + 60) . "') AND $t.published='1'";
  169.         }
  171.         switch ($this->iso_category_scope) {
  172.             case 'global':
  173.                 $arrCategories = [$objPage->rootId];
  174.                 $arrCategories = Database::getInstance()->getChildRecords($objPage->rootId, 'tl_page', false, $arrCategories, $strWhere);
  175.                 break;
  177.             case 'current_and_first_child':
  178.                 $arrCategories   = Database::getInstance()->execute("SELECT id FROM tl_page WHERE pid={$objPage->id} AND $strWhere")->fetchEach('id');
  179.                 $arrCategories[] = $objPage->id;
  180.                 break;
  182.             case 'current_and_all_children':
  183.                 $arrCategories = [$objPage->id];
  184.                 $arrCategories = Database::getInstance()->getChildRecords($objPage->id, 'tl_page', false, $arrCategories, $strWhere);
  185.                 break;
  187.             case 'parent':
  188.                 $arrCategories = [$objPage->pid];
  189.                 break;
  191.             case 'product':
  192.                 /** @var \Isotope\Model\Product\Standard $objProduct */
  193.                 $objProduct = Product::findAvailableByIdOrAlias(Input::getAutoItem('product'));
  194.                 $arrCategories = [0];
  196.                 if ($objProduct !== null) {
  197.                     $arrCategories = $objProduct->getCategories(true);
  198.                 }
  199.                 break;
  201.             case 'article':
  202.                 $arrCategories = array($GLOBALS['ISO_CONFIG']['current_article']['pid'] ? : $objPage->id);
  203.                 break;
  205.             case '':
  206.             case 'current_category':
  207.                 $arrCategories = [$objPage->id];
  208.                 break;
  210.             default:
  211.                 if (isset($GLOBALS['ISO_HOOKS']['findCategories']) && \is_array($GLOBALS['ISO_HOOKS']['findCategories'])) {
  212.                     foreach ($GLOBALS['ISO_HOOKS']['findCategories'] as $callback) {
  213.                         $arrCategories = System::importStatic($callback[0])->{$callback[1]}($this);
  215.                         if ($arrCategories !== false) {
  216.                             break;
  217.                         }
  218.                     }
  219.                 }
  220.                 break;
  221.         }
  223.         $this->arrCategories = empty($arrCategories) ? array(0) : array_map('intval', $arrCategories);
  225.         return $this->arrCategories;
  226.     }
  228.     /**
  229.      * Find jumpTo page for current category scope
  230.      *
  231.      * @param IsotopeProduct $objProduct
  232.      *
  233.      * @return PageModel
  234.      */
  235.     protected function findJumpToPage(IsotopeProduct $objProduct)
  236.     {
  237.         global $objPage;
  238.         global $objIsotopeListPage;
  240.         $productCategories = $objProduct instanceof AbstractProduct ? $objProduct->getCategories(true) : [];
  241.         $arrCategories = array();
  243.         if (!$this->iso_link_primary) {
  244.             $arrCategories = array_intersect(
  245.                 $productCategories,
  246.                 $this->findCategories()
  247.             );
  248.         }
  250.         // If our current category scope does not match with any product category,
  251.         // use the first allowed product category in the current root page
  252.         if (empty($arrCategories)) {
  253.             $arrCategories = $productCategories;
  254.         }
  256.         $arrCategories = Frontend::getPagesInCurrentRoot(
  257.             $arrCategories,
  258.             FrontendUser::getInstance()
  259.         );
  261.         if (!empty($arrCategories)
  262.          && ($objCategories = PageModel::findMultipleByIds($arrCategories)) !== null
  263.         ) {
  264.             $blnMoreThanOne = $objCategories->count() > 1;
  265.             foreach ($objCategories as $objCategory) {
  267.                 if ('index' === $objCategory->alias && $blnMoreThanOne) {
  268.                     continue;
  269.                 }
  271.                 return $objCategory;
  272.             }
  273.         }
  275.         return $objIsotopeListPage ? : $objPage;
  276.     }
  278.     /**
  279.      * Generate the URL from existing $_GET parameters.
  280.      * Use Input::setGet('var', null) to remove a parameter from the final URL.
  281.      *
  282.      * @return string
  283.      * @deprecated use \Haste\Util\Url::addQueryString instead
  284.      */
  285.     protected function generateRequestUrl()
  286.     {
  287.         if (Environment::get('request') == '') {
  288.             return '';
  289.         }
  291.         $strRequest   = preg_replace('/\?.*$/i', '', Environment::get('request'));
  292.         $strRequest   = preg_replace('/' . preg_quote($GLOBALS['TL_CONFIG']['urlSuffix'], '/') . '$/i', '', $strRequest);
  293.         $arrFragments = explode('/', $strRequest);
  295.         // Skip index.php
  296.         if ('index.php' === strtolower($arrFragments[0])) {
  297.             array_shift($arrFragments);
  298.         }
  300.         // HOOK: add custom logic
  301.         if (isset($GLOBALS['TL_HOOKS']['getPageIdFromUrl']) && \is_array($GLOBALS['TL_HOOKS']['getPageIdFromUrl'])) {
  302.             foreach ($GLOBALS['TL_HOOKS']['getPageIdFromUrl'] as $callback) {
  303.                 $arrFragments = System::importStatic($callback[0])->{$callback[1]}($arrFragments);
  304.             }
  305.         }
  307.         $strParams = '';
  308.         $arrGet    = array();
  310.         // Add fragments to URL params
  311.         for ($i = 1, $count = \count($arrFragments); $i < $count; $i += 2) {
  312.             if (isset($_GET[$arrFragments[$i]])) {
  313.                 $key = urldecode($arrFragments[$i]);
  314.                 Input::setGet($key, null);
  315.                 $strParams .= '/' . $key . '/' . urldecode($arrFragments[$i + 1]);
  316.             }
  317.         }
  319.         // Add get parameters to URL
  320.         if (\is_array($_GET) && !empty($_GET)) {
  321.             foreach ($_GET as $key => $value) {
  322.                 // Ignore the language parameter
  323.                 if ('language' === $key && $GLOBALS['TL_CONFIG']['addLanguageToUrl']) {
  324.                     continue;
  325.                 }
  327.                 $arrGet[] = $key . '=' . $value;
  328.             }
  329.         }
  331.         /** @var PageModel $objPage */
  332.         global $objPage;
  334.         return $objPage->getFrontendUrl($strParams) . (!empty($arrGet) ? ('?' . implode('&', $arrGet)) : '');
  335.     }
  336. }