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

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\CoreBundle\Exception\PageNotFoundException;
  16. use Contao\CoreBundle\Exception\ResponseException;
  17. use Contao\CoreBundle\Routing\ResponseContext\HtmlHeadBag\HtmlHeadBag;
  18. use Contao\Database;
  19. use Contao\Environment;
  20. use Contao\PageModel;
  21. use Contao\StringUtil;
  22. use Contao\System;
  23. use Haste\Input\Input;
  24. use Isotope\Interfaces\IsotopeProduct;
  25. use Isotope\Model\Product;
  26. use Isotope\Model\Product\AbstractProduct;
  27. use Symfony\Component\HttpFoundation\Response;
  29. /**
  30.  * Class ProductReader
  31.  *
  32.  * @property bool   $iso_use_quantity
  33.  * @property bool   $iso_display404Page
  34.  * @property bool   $iso_addProductJumpTo
  35.  * @property string $iso_reader_layout
  36.  * @property int    $iso_gallery
  37.  */
  38. class ProductReader extends Module
  39. {
  40.     /**
  41.      * Template
  42.      * @var string
  43.      */
  44.     protected $strTemplate = 'mod_iso_productreader';
  46.     /**
  47.      * Product
  48.      * @var IsotopeProduct
  49.      */
  50.     protected $objProduct;
  53.     /**
  54.      * Display a wildcard in the back end
  55.      * @return string
  56.      */
  57.     public function generate()
  58.     {
  59.         if ('BE' === TL_MODE) {
  60.             return $this->generateWildcard();
  61.         }
  63.         // Return if no product has been specified
  64.         if (Input::getAutoItem('product', false, true) == '') {
  65.             if ($this->iso_display404Page) {
  66.                 throw new PageNotFoundException();
  67.             }
  69.             return '';
  70.         }
  72.         return parent::generate();
  73.     }
  76.     /**
  77.      * Generate module
  78.      * @return void
  79.      */
  80.     protected function compile()
  81.     {
  82.         $jumpTo = $GLOBALS['objIsotopeListPage'] ?: $GLOBALS['objPage'];
  84.         if ($jumpTo->iso_readerMode === 'none') {
  85.             throw new PageNotFoundException();
  86.         }
  88.         /** @var AbstractProduct $objProduct */
  89.         $objProduct = Product::findAvailableByIdOrAlias(Input::getAutoItem('product'));
  91.         if (null === $objProduct) {
  92.             throw new PageNotFoundException();
  93.         }
  95.         $arrConfig = array(
  96.             'module'      => $this,
  97.             'template'    => $this->iso_reader_layout ? : $objProduct->getType()->reader_template,
  98.             'gallery'     => $this->iso_gallery ? : $objProduct->getType()->reader_gallery,
  99.             'buttons'     => $this->iso_buttons,
  100.             'useQuantity' => $this->iso_use_quantity,
  101.             'disableOptions' => $this->iso_disable_options,
  102.             'jumpTo'      => $jumpTo,
  103.         );
  105.         if (Environment::get('isAjaxRequest')
  106.             && Input::post('AJAX_MODULE') == $this->id
  107.             && Input::post('AJAX_PRODUCT') == $objProduct->getProductId()
  108.             && !$this->iso_disable_options
  109.         ) {
  110.             try {
  111.                 $content = $objProduct->generate($arrConfig);
  112.                 $content = Controller::replaceInsertTags($content, false);
  113.             } catch (\InvalidArgumentException $e) {
  114.                 return;
  115.             }
  117.             throw new ResponseException(new Response($content));
  118.         }
  120.         $this->addMetaTags($objProduct);
  121.         $this->addCanonicalProductUrls($objProduct);
  123.         $this->Template->product       = $objProduct->generate($arrConfig);
  124.         $this->Template->product_id    = $objProduct->getCssId();
  125.         $this->Template->product_class = $objProduct->getCssClass();
  126.         $this->Template->referer       = 'javascript:history.go(-1)';
  127.         $this->Template->back          = $GLOBALS['TL_LANG']['MSC']['goBack'];
  128.     }
  130.     /**
  131.      * Add meta header fields to the current page
  132.      *
  133.      * @param Product $objProduct
  134.      */
  135.     protected function addMetaTags(Product $objProduct)
  136.     {
  137.         $pageTitle = $objProduct->meta_title ?: $objProduct->getName();
  138.         /** @noinspection NestedTernaryOperatorInspection */
  139.         $description = $objProduct->meta_description ?: ($objProduct->teaser ?: $objProduct->description);
  141.         if ($objProduct->meta_keywords) {
  142.             $GLOBALS['TL_KEYWORDS'] .= ($GLOBALS['TL_KEYWORDS'] != '' ? ', ' : '') . $objProduct->meta_keywords;
  143.         }
  145.         // Support response context in Contao 4.13
  146.         if (System::getContainer()->has('contao.routing.response_context_accessor')) {
  147.             $responseContext = System::getContainer()->get('contao.routing.response_context_accessor')->getResponseContext();
  148.             $htmlDecoder = System::getContainer()->get('contao.string.html_decoder');
  150.             if ($responseContext && $htmlDecoder && $responseContext->has(HtmlHeadBag::class)) {
  151.                 /** @var HtmlHeadBag $htmlHeadBag */
  152.                 $htmlHeadBag = $responseContext->get(HtmlHeadBag::class);
  154.                 $htmlHeadBag->setTitle($htmlDecoder->inputEncodedToPlainText($pageTitle));
  156.                 if ($description) {
  157.                     $htmlHeadBag->setMetaDescription($htmlDecoder->inputEncodedToPlainText($description));
  158.                 }
  160.                 return;
  161.             }
  162.         }
  164.         global $objPage;
  166.         $objPage->pageTitle = $this->prepareMetaDescription($pageTitle);
  167.         $objPage->description = $this->prepareMetaDescription($description);
  168.     }
  170.     /**
  171.      * Adds canonical product URLs to the document
  172.      *
  173.      * @param Product $objProduct
  174.      */
  175.     protected function addCanonicalProductUrls(Product $objProduct)
  176.     {
  177.         global $objPage;
  178.         $arrPageIds   = Database::getInstance()->getChildRecords($objPage->rootId, PageModel::getTable());
  179.         $arrPageIds[] = $objPage->rootId;
  181.         // Find the categories in the current root
  182.         $arrCategories = array_intersect($objProduct->getCategories(), $arrPageIds);
  184.         foreach ($arrCategories as $intPage) {
  185.             if (($objJumpTo = PageModel::findPublishedById($intPage)) !== null) {
  187.                 // Do not use the index page as canonical link
  188.                 if ('index' === $objJumpTo->alias && \count($arrCategories) > 1) {
  189.                     continue;
  190.                 }
  192.                 $objJumpTo->loadDetails();
  194.                 $href = $objProduct->generateUrl($objJumpTo, true);
  196.                 // Canonical links in Contao 4.13
  197.                 if ($objJumpTo->enableCanonical && System::getContainer()->has('contao.routing.response_context_accessor')) {
  198.                     $responseContext = System::getContainer()->get('contao.routing.response_context_accessor')->getResponseContext();
  200.                     if ($responseContext && $responseContext->has(HtmlHeadBag::class)) {
  201.                         $responseContext
  202.                             ->get(HtmlHeadBag::class)
  203.                             ->setCanonicalUri($href)
  204.                         ;
  206.                         break;
  207.                     }
  208.                 }
  210.                 $GLOBALS['TL_HEAD'][] = '<link rel="canonical" href="' . $href . '">';
  212.                 break;
  213.             }
  214.         }
  215.     }
  217.     /**
  218.      * Gets the CSS ID for this product
  219.      *
  220.      * @param Product $objProduct
  221.      *
  222.      * @return string|null
  223.      *
  224.      * @deprecated Use AbstractProduct::getCssId()
  225.      */
  226.     protected function getCssId(Product $objProduct)
  227.     {
  228.         $css = StringUtil::deserialize($objProduct->cssID, true);
  230.         return $css[0] ? ' id="' . $css[0] . '"' : null;
  231.     }
  233.     /**
  234.      * Gets the CSS classes for this product
  235.      *
  236.      * @param Product $objProduct
  237.      *
  238.      * @return string
  239.      *
  240.      * @deprecated Use AbstractProduct::getCssClass()
  241.      */
  242.     protected function getCssClass(Product $objProduct)
  243.     {
  244.         if ($objProduct instanceof AbstractProduct) {
  245.             return $objProduct->getCssClass();
  246.         }
  248.         $classes = ['product'];
  250.         if ($objProduct->isNew()) {
  251.             $classes[] = 'new';
  252.         }
  254.         $arrCSS = StringUtil::deserialize($objProduct->cssID, true);
  255.         if ('' !== (string) $arrCSS[1]) {
  256.             $classes[] = (string) $arrCSS[1];
  257.         }
  259.         return implode(' ', $classes);
  260.     }
  261. }