vendor/isotope/isotope-core/system/modules/isotope/library/Isotope/Model/Product/Standard.php line 649

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\Model\Product;
  14. use Contao\ContentElement;
  15. use Contao\Database;
  16. use Contao\Date;
  17. use Contao\Environment;
  18. use Contao\FrontendUser;
  19. use Contao\Input;
  20. use Contao\PageModel;
  21. use Contao\StringUtil;
  22. use Contao\System;
  23. use Contao\Widget;
  24. use Haste\Generator\RowClass;
  25. use Haste\Units\Mass\Weight;
  26. use Haste\Units\Mass\WeightAggregate;
  27. use Haste\Util\Url;
  28. use Isotope\Collection\ProductPrice as ProductPriceCollection;
  29. use Isotope\Frontend\ProductAction\ProductActionInterface;
  30. use Isotope\Frontend\ProductAction\Registry;
  31. use Isotope\Interfaces\IsotopeAttribute;
  32. use Isotope\Interfaces\IsotopeAttributeForVariants;
  33. use Isotope\Interfaces\IsotopeAttributeWithOptions;
  34. use Isotope\Interfaces\IsotopePrice;
  35. use Isotope\Interfaces\IsotopeProduct;
  36. use Isotope\Interfaces\IsotopeProductCollection;
  37. use Isotope\Interfaces\IsotopeProductWithOptions;
  38. use Isotope\Isotope;
  39. use Isotope\Model\Attribute;
  40. use Isotope\Model\Gallery;
  41. use Isotope\Model\Gallery\Standard as StandardGallery;
  42. use Isotope\Model\ProductCollectionItem;
  43. use Isotope\Model\ProductPrice;
  44. use Isotope\Model\ProductType;
  45. use Isotope\Template;
  47. /**
  48.  * Standard implementation of an Isotope product.
  49.  */
  50. class Standard extends AbstractProduct implements WeightAggregate, IsotopeProductWithOptions
  51. {
  53.     /**
  54.      * Price model for the current product
  55.      * @var \Isotope\Model\ProductPrice
  56.      */
  57.     protected $objPrice = false;
  59.     /**
  60.      * Attributes assigned to this product type
  61.      * @var array
  62.      * @deprecated
  63.      */
  64.     protected $arrAttributes;
  66.     /**
  67.      * Variant attributes assigned to this product type
  68.      * @var array
  69.      * @deprecated
  70.      */
  71.     protected $arrVariantAttributes;
  73.     /**
  74.      * Available variant IDs
  75.      * @var int[]
  76.      */
  77.     protected $arrVariantIds;
  79.     /**
  80.      * Customer defined configuration
  81.      * @var array
  82.      */
  83.     protected $arrCustomerConfig = array();
  85.     /**
  86.      * Default configuration (to predefine variant or customer editable attributes)
  87.      * @var array
  88.      */
  89.     protected $arrDefaults;
  91.     /**
  92.      * Unique form ID
  93.      * @var string
  94.      */
  95.     protected $strFormId = 'iso_product';
  97.     /**
  98.      * For option widgets, helps determine the encoding type for a form
  99.      * @var bool
  100.      */
  101.     protected $hasUpload = false;
  103.     /**
  104.      * For option widgets, don't submit if certain validation(s) fail
  105.      * @var bool
  106.      */
  107.     protected $doNotSubmit = false;
  109.     /**
  110.      * @inheritdoc
  111.      */
  112.     public function isAvailableForCollection(IsotopeProductCollection $objCollection)
  113.     {
  114.         if (false === parent::isAvailableForCollection($objCollection)) {
  115.             return false;
  116.         }
  118.         // Check that the product is in any page of the current site
  119.         if (\count(\Isotope\Frontend::getPagesInCurrentRoot($this->getCategories(), $objCollection->getMember())) == 0) {
  120.             return false;
  121.         }
  123.         if ($this->hasVariants() && !count($this->getVariantIds())) {
  124.             return false;
  125.         }
  127.         // Check if "advanced price" is available
  128.         if ($this->getType()->hasAdvancedPrices()
  129.             && (\in_array('price', $this->getType()->getAttributes(), true) || $this->hasVariantPrices())
  130.             && null === $this->getPrice($objCollection)
  131.         ) {
  132.             return false;
  133.         }
  135.         return true;
  136.     }
  138.     /**
  139.      * Return true if the user should see lowest price tier as lowest price
  140.      *
  141.      * @return bool
  142.      */
  143.     public function canSeePriceTiers()
  144.     {
  145.         return $this->hasAdvancedPrices() && $this->getType()->show_price_tiers;
  146.     }
  148.     /**
  149.      * Return the unique form ID for the product
  150.      *
  151.      * @return string
  152.      */
  153.     public function getFormId()
  154.     {
  155.         return $this->strFormId;
  156.     }
  158.     /**
  159.      * Get product price model
  160.      *
  161.      * @param IsotopeProductCollection $objCollection
  162.      *
  163.      * @return \Isotope\Interfaces\IsotopePrice|ProductPrice
  164.      */
  165.     public function getPrice(IsotopeProductCollection $objCollection = null)
  166.     {
  167.         if (null !== $objCollection && $objCollection !== Isotope::getCart()) {
  168.             return ProductPrice::findByProductAndCollection($this, $objCollection);
  169.         }
  171.         if (false === $this->objPrice) {
  172.             if (null === $objCollection) {
  173.                 $objCollection = Isotope::getCart();
  174.             }
  176.             $this->objPrice = ProductPrice::findByProductAndCollection($this, $objCollection);
  177.         }
  179.         return $this->objPrice;
  180.     }
  182.     public function setPrice(IsotopePrice $price)
  183.     {
  184.         $this->objPrice = $price;
  186.         if ($price instanceof ProductPrice || $price instanceof ProductPriceCollection) {
  187.             $price->setProduct($this);
  188.         }
  189.     }
  191.     /**
  192.      * Return minimum quantity for the product (from advanced price tiers)
  193.      *
  194.      * @return int
  195.      */
  196.     public function getMinimumQuantity()
  197.     {
  198.         // Minimum quantity is only available for advanced pricing
  199.         if (!$this->hasAdvancedPrices() || null === $this->getPrice()) {
  200.             return 1;
  201.         }
  203.         $intLowest = (int) $this->getPrice()->getLowestTier();
  205.         if ($intLowest < 1) {
  206.             return 1;
  207.         }
  209.         return $intLowest;
  210.     }
  213.     /**
  214.      * Return the product attributes
  215.      *
  216.      * @return array
  217.      *
  218.      * @deprecated Deprecated since Isotope 2.4, to be removed in Isotope 3. Use ProductType::getAttributes()
  219.      */
  220.     public function getAttributes()
  221.     {
  222.         if (null === $this->arrAttributes) {
  223.             $this->arrAttributes = $this->getType()->getAttributes();
  224.         }
  226.         return $this->arrAttributes;
  227.     }
  230.     /**
  231.      * Return the product variant attributes
  232.      *
  233.      * @return array
  234.      *
  235.      * @deprecated Deprecated since Isotope 2.4, to be removed in Isotope 3. Use ProductType::getVariantAttributes()
  236.      */
  237.     public function getVariantAttributes()
  238.     {
  239.         if (null === $this->arrVariantAttributes) {
  240.             $this->arrVariantAttributes = $this->getType()->getVariantAttributes();
  241.         }
  243.         return $this->arrVariantAttributes;
  244.     }
  246.     /**
  247.      * Return all available variant IDs of this product
  248.      *
  249.      * @return int[]
  250.      */
  251.     public function getVariantIds()
  252.     {
  253.         if (null === $this->arrVariantIds) {
  254.             $this->arrVariantIds = [];
  256.             // Nothing to do if we have no variants
  257.             if (!$this->hasVariants()) {
  258.                 return $this->arrVariantIds;
  259.             }
  261.             $time            = Date::floorToMinute();
  262.             $blnHasProtected = false;
  263.             $blnHasGuests    = false;
  264.             $strQuery        = '
  265.                 SELECT tl_iso_product.id, tl_iso_product.protected, tl_iso_product.groups
  266.                 FROM tl_iso_product
  267.                 WHERE
  268.                     pid=' . $this->getProductId() . "
  269.                     AND language=''
  270.                     AND published='1'
  271.                     AND (start='' OR start<'$time')
  272.                     AND (stop='' OR stop>'" . ($time + 60) . "')
  273.             ";
  275.             if (BE_USER_LOGGED_IN !== true) {
  276.                 $arrAttributes   = $this->getType()->getVariantAttributes();
  277.                 $blnHasProtected = \in_array('protected', $arrAttributes, true);
  278.                 $blnHasGuests = \in_array('guests', $arrAttributes, true);
  280.                 // Hide guests-only products when logged in
  281.                 if (FE_USER_LOGGED_IN === true && $blnHasGuests) {
  282.                     $strQuery .= " AND (guests=''" . ($blnHasProtected ? " OR protected='1'" : '') . ')';
  283.                 } // Hide protected if no user is logged in
  284.                 elseif (FE_USER_LOGGED_IN !== true && $blnHasProtected) {
  285.                     $strQuery .= " AND (protected=''" . ($blnHasGuests ? " OR guests='1'" : '') . ")";
  286.                 }
  287.             }
  289.             /** @var object $objVariants */
  290.             $objVariants = Database::getInstance()->query($strQuery);
  292.             while ($objVariants->next()) {
  293.                 if (FE_USER_LOGGED_IN !== true
  294.                     && $blnHasProtected
  295.                     && $objVariants->protected
  296.                     && (!$blnHasGuests || !$objVariants->guests)
  297.                 ) {
  298.                     continue;
  299.                 }
  301.                 if (FE_USER_LOGGED_IN === true
  302.                     && $blnHasGuests
  303.                     && $objVariants->guests
  304.                     && (!$blnHasProtected || $objVariants->protected)
  305.                 ) {
  306.                     continue;
  307.                 }
  309.                 if ($blnHasProtected && $objVariants->protected) {
  310.                     $groups = StringUtil::deserialize($objVariants->groups);
  312.                     if (empty($groups) || !\is_array($groups) || !\count(array_intersect($groups, FrontendUser::getInstance()->groups))) {
  313.                         continue;
  314.                     }
  315.                 }
  317.                 $this->arrVariantIds[] = $objVariants->id;
  318.             }
  320.             // Only show variants where a price is available
  321.             if (0 !== \count($this->arrVariantIds) && $this->hasVariantPrices()) {
  322.                 if ($this->hasAdvancedPrices()) {
  323.                     $objPrices = ProductPrice::findAdvancedByProductIdsAndCollection($this->arrVariantIds, Isotope::getCart());
  324.                 } else {
  325.                     $objPrices = ProductPrice::findPrimaryByProductIds($this->arrVariantIds);
  326.                 }
  328.                 if (null === $objPrices) {
  329.                     $this->arrVariantIds = [];
  330.                 } else {
  331.                     $this->arrVariantIds = $objPrices->fetchEach('pid');
  332.                 }
  333.             }
  334.         }
  336.         return $this->arrVariantIds;
  337.     }
  339.     /**
  340.      * Get the weight of the product (as object)
  341.      *
  342.      * @return Weight
  343.      */
  344.     public function getWeight()
  345.     {
  346.         if (!isset($this->arrData['shipping_weight'])) {
  347.             return null;
  348.         }
  350.         return Weight::createFromTimePeriod($this->arrData['shipping_weight']);
  351.     }
  353.     /**
  354.      * @inheritdoc
  355.      */
  356.     public function getOptions()
  357.     {
  358.         return array_merge($this->getVariantConfig(), $this->getCustomerConfig());
  359.     }
  361.     /**
  362.      * @inheritdoc
  363.      */
  364.     public function setOptions(array $options)
  365.     {
  366.         if (!$this->blnPreventSaving) {
  367.             throw new \RuntimeException('Do not modify a product object that is in the model registry!');
  368.         }
  370.         if (!$this->isVariant()) {
  371.             $this->arrCustomerConfig = $options;
  372.             return;
  373.         }
  375.         $attributes = array_intersect($this->getType()->getVariantAttributes(), Attribute::getVariantOptionFields());
  376.         $this->arrCustomerConfig = [];
  378.         foreach ($options as $k => $v) {
  379.             if (\in_array($k, $attributes, true)) {
  380.                 if ($this->arrData[$k] != $v) {
  381.                     throw new \RuntimeException(
  382.                         sprintf('"%s" for attribute "%s" does not match current variant.', $v, $k)
  383.                     );
  384.                 }
  386.                 // Ignore variant data, that's already stored
  387.                 continue;
  388.             }
  390.             $this->arrCustomerConfig[$k] = $v;
  391.         }
  392.     }
  394.     /**
  395.      * Get the product configuration
  396.      * This includes customer defined fields and variant options
  397.      *
  398.      * @return array
  399.      *
  400.      * @deprecated Deprecated since Isotope 2.4, to be removed in Isotope 3.0. Use getOptions() instead.
  401.      */
  402.     public function getConfiguration()
  403.     {
  404.         return Isotope::formatProductConfiguration($this->getOptions(), $this);
  405.     }
  407.     /**
  408.      * Get customer defined field values
  409.      *
  410.      * @return array
  411.      */
  412.     public function getCustomerConfig()
  413.     {
  414.         return $this->arrCustomerConfig;
  415.     }
  417.     /**
  418.      * Get variant option field values
  419.      *
  420.      * @return array
  421.      */
  422.     public function getVariantConfig()
  423.     {
  424.         if (!$this->isVariant()) {
  425.             return array();
  426.         }
  428.         $arrVariantConfig = array();
  429.         $arrAttributes = array_intersect($this->getType()->getVariantAttributes(), Attribute::getVariantOptionFields());
  431.         foreach (array_unique($arrAttributes) as $attribute) {
  432.             $arrVariantConfig[$attribute] = $this->arrData[$attribute];
  433.         }
  435.         return $arrVariantConfig;
  436.     }
  438.     /**
  439.      * Generate a product template
  440.      *
  441.      * @param array $arrConfig
  442.      *
  443.      * @return string
  444.      *
  445.      * @throws \InvalidArgumentException
  446.      */
  447.     public function generate(array $arrConfig)
  448.     {
  449.         $objProduct = $this;
  450.         $loadFallback = isset($arrConfig['loadFallback']) ? (bool) $arrConfig['loadFallback'] : true;
  452.         $this->strFormId = (($arrConfig['module'] instanceof ContentElement) ? 'cte' : 'fmd') . $arrConfig['module']->id . '_product_' . $this->getProductId();
  454.         if (!$arrConfig['disableOptions']) {
  455.             $objProduct = $this->validateVariant($loadFallback);
  457.             // A variant has been loaded, generate the variant
  458.             if ($objProduct->getId() != $this->getId()) {
  459.                 return $objProduct->generate($arrConfig);
  460.             }
  461.         }
  463.         /** @var Template|\stdClass $objTemplate */
  464.         $objTemplate = new Template($arrConfig['template']);
  465.         $objTemplate->setData($this->arrData);
  466.         $objTemplate->product = $this;
  467.         $objTemplate->config  = $arrConfig;
  469.         $objTemplate->highlightKeywords = function($text) {
  470.             $keywords = Input::get('keywords');
  472.             if (empty($keywords)) {
  473.                 return $text;
  474.             }
  476.             $keywords = StringUtil::trimsplit(' |-', $keywords);
  477.             $keywords = array_filter(array_unique($keywords));
  479.             foreach ($keywords as $word) {
  480.                 $text = StringUtil::highlight($text, $word, '<em>', '</em>');
  481.             }
  483.             return $text;
  484.         };
  486.         $objTemplate->hasAttribute = function ($strAttribute) use ($objProduct) {
  487.             return \in_array($strAttribute, $objProduct->getType()->getAttributes(), true)
  488.                 || \in_array($strAttribute, $objProduct->getType()->getVariantAttributes(), true);
  489.         };
  491.         $objTemplate->generateAttribute = function ($strAttribute, array $arrOptions = array()) use ($objProduct) {
  493.             $objAttribute = $GLOBALS['TL_DCA']['tl_iso_product']['attributes'][$strAttribute];
  495.             if (!($objAttribute instanceof IsotopeAttribute)) {
  496.                 throw new \InvalidArgumentException($strAttribute . ' is not a valid attribute');
  497.             }
  499.             return $objAttribute->generate($objProduct, $arrOptions);
  500.         };
  502.         $objTemplate->generatePrice = function() use ($objProduct) {
  503.             $objPrice = $objProduct->getPrice();
  505.             /** @var ProductType $objType */
  506.             $objType = $objProduct->getType();
  508.             if (null === $objPrice) {
  509.                 return '';
  510.             }
  512.             return $objPrice->generate($objType->showPriceTiers(), 1, $objProduct->getOptions());
  513.         };
  515.         /** @var StandardGallery $currentGallery */
  516.         $currentGallery          = null;
  517.         $objTemplate->getGallery = function ($strAttribute) use ($objProduct, $arrConfig, &$currentGallery) {
  519.             if (null === $currentGallery
  520.                 || $currentGallery->getName() !== $objProduct->getFormId() . '_' . $strAttribute
  521.             ) {
  522.                 $currentGallery = Gallery::createForProductAttribute(
  523.                     $objProduct,
  524.                     $strAttribute,
  525.                     $arrConfig
  526.                 );
  527.             }
  529.             return $currentGallery;
  530.         };
  532.         $arrVariantOptions = array();
  533.         $arrProductOptions = array();
  534.         $arrAjaxOptions    = array();
  536.         if (!$arrConfig['disableOptions']) {
  537.             foreach (array_unique(array_merge($this->getType()->getAttributes(), $this->getType()->getVariantAttributes())) as $attribute) {
  538.                 $arrData = $GLOBALS['TL_DCA']['tl_iso_product']['fields'][$attribute];
  540.                 if (($arrData['attributes']['customer_defined'] ?? null) || ($arrData['attributes']['variant_option'] ?? null)) {
  542.                     $strWidget = $this->generateProductOptionWidget($attribute, $arrVariantOptions, $arrAjaxOptions, $objWidget);
  544.                     if ($strWidget != '') {
  545.                         $arrProductOptions[$attribute] = array_merge($arrData, array
  546.                         (
  547.                             'name'    => $attribute,
  548.                             'html'    => $strWidget,
  549.                             'widget'  => $objWidget,
  550.                         ));
  551.                     }
  553.                     unset($objWidget);
  554.                 }
  555.             }
  556.         }
  558.         /** @var ProductActionInterface[] $actions */
  559.         $handleButtons = false;
  560.         $actions = array_filter(
  561.             Registry::all(true, $this),
  562.             function (ProductActionInterface $action) use ($arrConfig) {
  563.                 return \in_array($action->getName(), $arrConfig['buttons'] ?? []) && $action->isAvailable($this, $arrConfig);
  564.             }
  565.         );
  567.         // Sort actions by order in module configuration
  568.         $buttonOrder = array_values($arrConfig['buttons'] ?? []);
  569.         usort($actions, function (ProductActionInterface $a, ProductActionInterface $b) use ($buttonOrder) {
  570.             return array_search($a->getName(), $buttonOrder) - array_search($b->getName(), $buttonOrder);
  571.         });
  573.         if (Input::post('FORM_SUBMIT') == $this->getFormId() && !$this->doNotSubmit) {
  574.             $handleButtons = true;
  576.             foreach ($actions as $action) {
  577.                 if ($action->handleSubmit($this, $arrConfig)) {
  578.                     $handleButtons = false;
  579.                     break;
  580.                 }
  581.             }
  582.         }
  584.         /**
  585.          * @deprecated Deprecated since Isotope 2.5
  586.          */
  587.         $objTemplate->buttons = function() use ($arrConfig, $handleButtons) {
  588.             $arrButtons = array();
  590.             // !HOOK: retrieve buttons
  591.             if (isset($arrConfig['buttons'], $GLOBALS['ISO_HOOKS']['buttons'])
  592.                 && \is_array($arrConfig['buttons'])
  593.                 && \is_array($GLOBALS['ISO_HOOKS']['buttons'])
  594.             ) {
  595.                 foreach ($GLOBALS['ISO_HOOKS']['buttons'] as $callback) {
  596.                     $arrButtons = System::importStatic($callback[0])->{$callback[1]}($arrButtons, $this);
  597.                 }
  598.             }
  600.             $arrButtons = array_intersect_key($arrButtons, array_flip($arrConfig['buttons'] ?? []));
  602.             if ($handleButtons) {
  603.                 foreach ($arrButtons as $button => $data) {
  604.                     if (isset($_POST[$button])) {
  605.                         if (isset($data['callback'])) {
  606.                             System::importStatic($data['callback'][0])->{$data['callback'][1]}($this, $arrConfig);
  607.                         }
  608.                         break;
  609.                     }
  610.                 }
  611.             }
  613.             return $arrButtons;
  614.         };
  616.         RowClass::withKey('rowClass')->addCustom('product_option')->addFirstLast()->addEvenOdd()->applyTo($arrProductOptions);
  618.         $objTemplate->actions = $actions;
  619.         $objTemplate->useQuantity = $arrConfig['useQuantity'] && null === $this->getCollectionItem();
  620.         $objTemplate->minimum_quantity = $this->getMinimumQuantity();
  621.         $objTemplate->raw = $this->arrData;
  622.         $objTemplate->raw_options = $this->getConfiguration();
  623.         $objTemplate->configuration = $this->getConfiguration();
  624.         $objTemplate->href = '';
  625.         $objTemplate->label_detail = $GLOBALS['TL_LANG']['MSC']['detailLabel'];
  626.         $objTemplate->options = $arrProductOptions;
  627.         $objTemplate->hasOptions = \count($arrProductOptions) > 0;
  628.         $objTemplate->enctype = $this->hasUpload ? 'multipart/form-data' : 'application/x-www-form-urlencoded';
  629.         $objTemplate->formId = $this->getFormId();
  630.         $objTemplate->formSubmit = $this->getFormId();
  631.         $objTemplate->product_id = $this->getProductId();
  632.         $objTemplate->module_id = $arrConfig['module']->id;
  634.         if (!$arrConfig['jumpTo'] instanceof PageModel || $arrConfig['jumpTo']->iso_readerMode !== 'none') {
  635.             $objTemplate->href = $this->generateUrl($arrConfig['jumpTo']);
  636.         }
  638.         if (!$arrConfig['disableOptions']) {
  639.             $GLOBALS['AJAX_PRODUCTS'][] = array('formId' => $this->getFormId(), 'attributes' => $arrAjaxOptions);
  640.         }
  642.         // !HOOK: alter product data before output
  643.         if (isset($GLOBALS['ISO_HOOKS']['generateProduct']) && \is_array($GLOBALS['ISO_HOOKS']['generateProduct'])) {
  644.             foreach ($GLOBALS['ISO_HOOKS']['generateProduct'] as $callback) {
  645.                 System::importStatic($callback[0])->{$callback[1]}($objTemplate, $this);
  646.             }
  647.         }
  649.         return trim($objTemplate->parse());
  650.     }
  653.     /**
  654.      * Return a widget object based on a product attribute's properties
  655.      *
  656.      * @param string $strField
  657.      * @param array  $arrVariantOptions
  658.      * @param array  $arrAjaxOptions
  659.      *
  660.      * @return string
  661.      */
  662.     protected function generateProductOptionWidget($strField, &$arrVariantOptions, &$arrAjaxOptions, &$objWidget = null)
  663.     {
  664.         $arrDefaults = $this->getOptionsDefaults();
  666.         /** @var IsotopeAttribute|IsotopeAttributeWithOptions|IsotopeAttributeForVariants|Attribute $objAttribute */
  667.         $objAttribute = $GLOBALS['TL_DCA']['tl_iso_product']['attributes'][$strField];
  668.         $arrData = $GLOBALS['TL_DCA']['tl_iso_product']['fields'][$strField];
  670.         /** @var Widget $strClass */
  671.         $strClass = $objAttribute->getFrontendWidget();
  673.         $arrData['eval']['required'] = $arrData['eval']['mandatory'];
  675.         // Value can be predefined in the URL, e.g. to preselect a variant
  676.         if (!empty($arrDefaults[$strField])) {
  677.             $arrData['default'] = $arrDefaults[$strField];
  678.         }
  680.         $arrField = $strClass::getAttributesFromDca($arrData, $strField, $arrData['default'] ?? null, $strField, static::$strTable, $this);
  682.         // Prepare variant selection field
  683.         // @todo in 3.0: $objAttribute instanceof IsotopeAttributeForVariants
  684.         if ($objAttribute->isVariantOption()) {
  685.             $arrOptions = $objAttribute->getOptionsForVariants($this->getVariantIds(), $arrVariantOptions);
  687.             // Hide selection if only one option is available (and "force_variant_options" is not set in product type)
  688.             if (\count($arrOptions) == 1 && !$this->getType()->force_variant_options) {
  689.                 $arrVariantOptions[$strField] = $arrOptions[0];
  690.                 return '';
  691.             }
  693.             if ($arrField['value'] != '' && \in_array($arrField['value'], $arrOptions)) {
  694.                 $arrVariantOptions[$strField] = $arrField['value'];
  695.             }
  697.             // Remove options not available in any product variant
  698.             if (\is_array($arrField['options'])) {
  699.                 $blankOption = null;
  701.                 foreach ($arrField['options'] as $k => $option) {
  702.                     // Keep groups and blankOptionLabels
  703.                     if ($option['value'] == '') {
  704.                         if (null !== $blankOption) {
  705.                             // Last blank option wins
  706.                             $arrField['options'][$blankOption] = $option;
  707.                             unset($arrField['options'][$k]);
  708.                         } else {
  709.                             $blankOption = $k;
  710.                         }
  711.                     } elseif (!\in_array($option['value'], $arrOptions) && !$option['group']) {
  712.                         unset($arrField['options'][$k]);
  713.                     }
  714.                 }
  716.                 $arrField['options'] = array_values($arrField['options']);
  717.             }
  719.             $arrField['value'] = $this->$strField;
  721.         } elseif ($objAttribute instanceof IsotopeAttributeWithOptions && empty($arrField['options'])) {
  722.             return '';
  723.         }
  725.         if ($objAttribute->isVariantOption()
  726.             || ($objAttribute instanceof IsotopeAttributeWithOptions && $objAttribute->canHavePrices())
  727.             || $arrData['attributes']['ajax_option']
  728.             || $arrField['attributes']['ajax_option'] // see https://github.com/isotope/core/issues/2096
  729.         ) {
  730.             $arrAjaxOptions[] = $strField;
  731.         }
  733.         // Convert optgroups so they work with FormSelectMenu
  734.         // @deprecated Remove in Isotope 3.0, the options should match for frontend if attribute is customer defined
  735.         if (
  736.             \is_array($arrField['options'])
  737.             && array_is_assoc($arrField['options'])
  738.             && \count(
  739.                 array_filter(
  740.                     $arrField['options'], function($v) {
  741.                         return !isset($v['label']);
  742.                     }
  743.                 )
  744.             ) > 0
  745.         ) {
  746.             $arrOptions = $arrField['options'];
  747.             $arrField['options'] = array();
  749.             foreach ($arrOptions as $k => $v) {
  750.                 if (isset($v['label'])) {
  751.                     $arrField['options'][] = $v;
  752.                 } else {
  753.                     $arrField['options'][] = array(
  754.                         'label'     => $k,
  755.                         'value'     => $k,
  756.                         'group'     => '1',
  757.                     );
  759.                     foreach ($v as $vv) {
  760.                         $arrField['options'][] = $vv;
  761.                     }
  762.                 }
  763.             }
  764.         }
  766.         $arrField['storeValues'] = true;
  767.         $arrField['tableless'] = true;
  768.         $arrField['product'] = $this;
  769.         $arrField['id'] .= '_' . $this->getFormId();
  771.         /** @var Widget|\stdClass $objWidget */
  772.         $objWidget = new $strClass($arrField);
  774.         // Validate input
  775.         if (Input::post('FORM_SUBMIT') == $this->getFormId()) {
  776.             $objWidget->validate();
  778.             if ($objWidget->hasErrors()) {
  779.                 $this->doNotSubmit = true;
  780.             } elseif ($objWidget->submitInput() || $objWidget instanceof \uploadable) {
  781.                 $varValue = $objWidget->value;
  783.                 // Convert date formats into timestamps
  784.                 if ($varValue != '' && \in_array($arrData['eval']['rgxp'], ['date', 'time', 'datim'], true)) {
  785.                     try {
  786.                         /** @var Date|object $objDate */
  787.                         $objDate = new Date($varValue, $GLOBALS['TL_CONFIG'][$arrData['eval']['rgxp'] . 'Format']);
  788.                         $varValue = $objDate->tstamp;
  790.                     } catch (\OutOfBoundsException $e) {
  791.                         $objWidget->addError(sprintf($GLOBALS['TL_LANG']['ERR'][$arrData['eval']['rgxp']], $GLOBALS['TL_CONFIG'][$arrData['eval']['rgxp'] . 'Format']));
  792.                     }
  793.                 }
  795.                 // Trigger the save_callback
  796.                 if (\is_array($arrData['save_callback'] ?? null)) {
  797.                     foreach ($arrData['save_callback'] as $callback) {
  798.                         try {
  799.                             if (\is_array($callback)) {
  800.                                 $varValue = System::importStatic($callback[0])->{$callback[1]}($varValue, $this, $objWidget);
  801.                             } else {
  802.                                 $varValue = $objAttribute->{$callback}($varValue, $this, $objWidget);
  803.                             }
  804.                         } catch (\Exception $e) {
  805.                             $objWidget->class = 'error';
  806.                             $objWidget->addError($e->getMessage());
  807.                             $this->doNotSubmit = true;
  808.                         }
  809.                     }
  810.                 }
  812.                 if (!$objWidget->hasErrors() && $varValue != '') {
  814.                     // @todo in 3.0: $objAttribute instanceof IsotopeAttributeForVariants
  815.                     if ($objAttribute->isVariantOption()) {
  816.                         $arrVariantOptions[$strField] = $varValue;
  817.                     } else {
  818.                         $this->arrCustomerConfig[$strField] = $varValue;
  819.                     }
  820.                 }
  821.             }
  822.         } elseif (isset($_GET[$strField]) && empty(Input::post('FORM_SUBMIT')) && !$objAttribute->isVariantOption()) {
  823.             $this->arrCustomerConfig[$strField] = $objWidget->value = Input::get($strField);
  824.         }
  826.         $wizard = '';
  828.         // Datepicker
  829.         if ($arrData['eval']['datepicker']) {
  831.             $GLOBALS['TL_JAVASCRIPT'][] = 'assets/datepicker/js/datepicker.min.js';
  832.             $GLOBALS['TL_CSS'][] = 'assets/datepicker/css/datepicker.min.css';
  833.             $icon = 'assets/datepicker/images/icon.svg';
  835.             $rgxp   = $arrData['eval']['rgxp'];
  836.             $format = Date::formatToJs($GLOBALS['TL_CONFIG'][$rgxp . 'Format']);
  838.             switch ($rgxp) {
  839.                 case 'datim':
  840.                     $time = ",\n      timePicker:true";
  841.                     break;
  843.                 case 'time':
  844.                     $time = ",\n      pickOnly:\"time\"";
  845.                     break;
  847.                 default:
  848.                     $time = '';
  849.                     break;
  850.             }
  852.             $wizard .= ' <img src="'.$icon.'" width="20" height="20" alt="" id="toggle_' . $objWidget->id . '" style="vertical-align:-6px">
  853.   <script>
  854.   window.addEvent("domready", function() {
  855.     new Picker.Date($$("#ctrl_' . $objWidget->id . '"), {
  856.       draggable:false,
  857.       toggle:$$("#toggle_' . $objWidget->id . '"),
  858.       format:"' . $format . '",
  859.       positionOffset:{x:-197,y:-182}' . $time . ',
  860.       pickerClass:"datepicker_bootstrap",
  861.       useFadeInOut:!Browser.ie,
  862.       startDay:' . $GLOBALS['TL_LANG']['MSC']['weekOffset'] . ',
  863.       titleFormat:"' . $GLOBALS['TL_LANG']['MSC']['titleFormat'] . '"
  864.     });
  865.   });
  866.   </script>';
  867.         }
  869.         // Add a custom wizard
  870.         if (\is_array($arrData['wizard'] ?? null)) {
  871.             foreach ($arrData['wizard'] as $callback) {
  872.                 $wizard .= System::importStatic($callback[0])->{$callback[1]}($this);
  873.             }
  874.         }
  876.         if ($objWidget instanceof \uploadable) {
  877.             $this->hasUpload = true;
  878.         }
  880.         return $objWidget->parse() . $wizard;
  881.     }
  883.     /**
  884.      * Load data of a product variant if the options match one
  885.      *
  886.      * @param bool $loadDefaultVariant
  887.      *
  888.      * @return IsotopeProduct|$this
  889.      */
  890.     public function validateVariant($loadDefaultVariant = true)
  891.     {
  892.         if (!$this->hasVariants()) {
  893.             return $this;
  894.         }
  896.         $hasOptions = null;
  897.         $arrOptions = array();
  898.         $arrDefaults = $this->getOptionsDefaults();
  900.         // We don't need to validate IsotopeAttributeForVariants interface here, because Attribute::getVariantOptionFields will check it
  901.         foreach (array_intersect($this->getType()->getVariantAttributes(), Attribute::getVariantOptionFields()) as $attribute) {
  903.             /** @var IsotopeAttribute|Attribute $objAttribute */
  904.             $objAttribute = $GLOBALS['TL_DCA']['tl_iso_product']['attributes'][$attribute];
  905.             $arrValues    = $objAttribute->getOptionsForVariants($this->getVariantIds(), $arrOptions);
  907.             if (Input::post('FORM_SUBMIT') == $this->getFormId() && \in_array(Input::post($attribute), $arrValues)) {
  908.                 $arrOptions[$attribute] = Input::post($attribute);
  909.             } elseif (Input::post('FORM_SUBMIT') == '' && \in_array($arrDefaults[$attribute], $arrValues)) {
  910.                 $arrOptions[$attribute] = $arrDefaults[$attribute];
  911.             } elseif (\count($arrValues) == 1) {
  912.                 $arrOptions[$attribute] = $arrValues[0];
  913.             } else {
  915.                 // Abort if any attribute does not have a value, we can't find a variant
  916.                 $hasOptions = false;
  917.                 break;
  918.             }
  920.             if (Input::post('FORM_SUBMIT') === $this->getFormId() && Input::post($attribute) === '') {
  921.                 Input::setPost($attribute, $arrOptions[$attribute]);
  922.             }
  923.         }
  925.         $hasOptions = false !== $hasOptions && \count($arrOptions) > 0;
  927.         if ($hasOptions && ($objVariant = static::findVariantOfProduct($this, $arrOptions)) !== null) {
  928.             return $objVariant;
  929.         }
  931.         if (!$hasOptions && $loadDefaultVariant && ($objVariant = static::findDefaultVariantOfProduct($this)) !== null) {
  932.             return $objVariant;
  933.         }
  935.         return $this;
  936.     }
  938.     /**
  939.      * Validate data and remove non-available attributes
  940.      *
  941.      * @param array $arrData
  942.      *
  943.      * @return $this
  944.      */
  945.     public function setRow(array $arrData)
  946.     {
  947.         if ($arrData['pid'] > 0) {
  948.             // Do not use the model, it would trigger setRow and generate too much
  949.             // @deprecated use static::buildFindQuery once we drop BC support for buildQueryString
  950.             /** @var object $objParent */
  951.             $objParent = Database::getInstance()->prepare(static::buildQueryString(array('table' => static::$strTable, 'column' => 'id')))->execute($arrData['pid']);
  953.             if (null === $objParent) {
  954.                 throw new \UnderflowException('Parent record of product variant ID ' . $arrData['id'] . ' not found');
  955.             }
  957.             $this->setRow($objParent->row());
  959.             // Must be set before call to getInheritedFields()
  960.             $this->arrData['id'] = $arrData['id'];
  961.             $this->arrData['pid'] = $arrData['pid'];
  962.             $this->arrData['inherit'] = $arrData['inherit'];
  964.             // Set all variant attributes, except if they are inherited
  965.             $arrFallbackFields = Attribute::getFetchFallbackFields();
  966.             $arrVariantFields = array_diff($this->getType()->getVariantAttributes(), $this->getInheritedFields());
  967.             foreach ($arrData as $attribute => $value) {
  968.                 if (
  969.                     \in_array($attribute, $arrVariantFields, true)
  970.                     || (($GLOBALS['TL_DCA']['tl_iso_product']['fields'][$attribute]['attributes']['legend'] ?? '') == ''
  971.                         && !\in_array(str_replace('_fallback', '', $attribute), $arrFallbackFields, true))
  972.                 ) {
  973.                     $this->arrData[$attribute] = $arrData[$attribute];
  975.                     if (\in_array($attribute, $arrFallbackFields, true)) {
  976.                         $this->arrData[$attribute . '_fallback'] = $arrData[$attribute . '_fallback'];
  977.                     }
  978.                 }
  979.             }
  981.             // Make sure publishing settings match product and variant (see #1120)
  982.             $this->arrData['published'] = $objParent->published ? $arrData['published'] : '';
  983.             $this->arrData['start'] = ($objParent->start != '' && ($arrData['start'] == '' || $objParent->start > $arrData['start'])) ? $objParent->start : $arrData['start'];
  984.             $this->arrData['stop'] = ($objParent->stop != '' && ($arrData['stop'] == '' || $objParent->stop < $arrData['stop'])) ? $objParent->stop : $arrData['stop'];
  986.             return $this;
  987.         }
  989.         // Empty cache
  990.         $this->objPrice             = false;
  991.         $this->arrAttributes        = null;
  992.         $this->arrVariantAttributes = null;
  993.         $this->arrVariantIds        = null;
  994.         $this->arrRelated           = [];
  996.         // Must initialize product type to have attributes etc.
  997.         if (($this->arrRelated['type'] = ProductType::findByPk($arrData['type'])) === null) {
  998.             throw new \UnderflowException('Product type for product ID ' . $arrData['id'] . ' not found');
  999.         }
  1001.         $this->strFormId = 'iso_product_' . $arrData['id'];
  1003.         // Remove attributes not in this product type
  1004.         foreach ($arrData as $attribute => $value) {
  1005.             if ((
  1006.                     !\in_array($attribute, $this->getType()->getAttributes(), true)
  1007.                     && !\in_array($attribute, $this->getType()->getVariantAttributes(), true)
  1008.                     && isset($GLOBALS['TL_DCA']['tl_iso_product']['fields'][$attribute]['attributes']['legend'])
  1009.                     && $GLOBALS['TL_DCA']['tl_iso_product']['fields'][$attribute]['attributes']['legend'] != ''
  1010.                 )
  1011.                 || \in_array($attribute, Attribute::getVariantOptionFields(), true)
  1012.             ) {
  1013.                 unset($arrData[$attribute]);
  1014.             }
  1015.         }
  1017.         return parent::setRow($arrData);
  1018.     }
  1020.     /**
  1021.      * Prevent reload of the database record
  1022.      * We would need to fetch parent data etc. again, pretty useless
  1023.      *
  1024.      * @param array $arrData
  1025.      *
  1026.      * @return $this
  1027.      */
  1028.     public function mergeRow(array $arrData)
  1029.     {
  1030.         // do not allow to reset the whole record
  1031.         if (isset($arrData['id'])) {
  1032.             return $this;
  1033.         }
  1035.         return parent::mergeRow($arrData);
  1036.     }
  1038.     /**
  1039.      * In a variant, only variant and non-inherited fields can be marked as modified
  1040.      *
  1041.      * @param string $strKey
  1042.      */
  1043.     public function markModified($strKey)
  1044.     {
  1045.         if ($this->isVariant()) {
  1046.             $arrAttributes = array_diff(
  1047.                 $this->getType()->getVariantAttributes(),
  1048.                 $this->getInheritedFields(),
  1049.                 Attribute::getCustomerDefinedFields()
  1050.             );
  1051.         } else {
  1052.             $arrAttributes = array_diff($this->getType()->getAttributes(), Attribute::getCustomerDefinedFields());
  1053.         }
  1055.         if (!\in_array($strKey, $arrAttributes, true)
  1056.             && '' !== (string) ($GLOBALS['TL_DCA'][static::$strTable]['fields'][$strKey]['attributes']['legend'] ?? '')
  1057.         ) {
  1058.             return;
  1059.         }
  1061.         parent::markModified($strKey);
  1062.     }
  1064.     /**
  1065.      * Generate url
  1066.      *
  1067.      * @return string
  1068.      *
  1069.      * @throws \InvalidArgumentException
  1070.      */
  1071.     public function generateUrl(PageModel $objJumpTo = null/*, bool $absolute = false*/)
  1072.     {
  1073.         $absolute = false;
  1075.         if (func_num_args() >= 2) {
  1076.             $absolute = (bool) func_get_arg(1);
  1077.         }
  1079.         if (null === $objJumpTo) {
  1080.             global $objPage;
  1081.             global $objIsotopeListPage;
  1083.             $objJumpTo = $objIsotopeListPage ?: $objPage;
  1084.         }
  1086.         if (!$objJumpTo instanceof PageModel) {
  1087.             return '';
  1088.         }
  1090.         $strParams = '';
  1092.         if ($objJumpTo->iso_readerMode !== 'none') {
  1093.             $strParams = '/'.($this->arrData['alias'] ?: $this->getProductId());
  1095.             if (!$GLOBALS['TL_CONFIG']['useAutoItem'] || !\in_array('product', $GLOBALS['TL_AUTO_ITEM'], true)) {
  1096.                 $strParams = '/product'.$strParams;
  1097.             }
  1098.         }
  1100.         $url = $absolute ? $objJumpTo->getAbsoluteUrl($strParams) : $objJumpTo->getFrontendUrl($strParams);
  1102.         return Url::addQueryString(http_build_query($this->getOptions()), $url);
  1103.     }
  1105.     /**
  1106.      * Return array of inherited attributes
  1107.      *
  1108.      * @return array
  1109.      */
  1110.     protected function getInheritedFields()
  1111.     {
  1112.         // Not a variant, no inherited fields
  1113.         if (!$this->isVariant()) {
  1114.             return array();
  1115.         }
  1117.         return array_merge(StringUtil::deserialize($this->arrData['inherit'], true), Attribute::getInheritFields());
  1118.     }
  1120.     private function getCollectionItem()
  1121.     {
  1122.         if (Input::get('collection_item') > 0) {
  1123.             $item = ProductCollectionItem::findByPk(Input::get('collection_item'));
  1125.             if (null !== $item
  1126.                 && $item->hasProduct()
  1127.                 && $item->getProduct()->getProductId() == $this->getProductId()
  1128.             ) {
  1129.                 return $item;
  1130.             }
  1131.         }
  1133.         return null;
  1134.     }
  1136.     /**
  1137.      * Load default values from URL
  1138.      */
  1139.     private function getOptionsDefaults()
  1140.     {
  1141.         if (\is_array($this->arrDefaults)) {
  1142.             return $this->arrDefaults;
  1143.         }
  1145.         $this->arrDefaults = array();
  1147.         if (($item = $this->getCollectionItem()) !== null) {
  1148.             $this->arrDefaults = $item->getOptions();
  1149.         } else {
  1150.             foreach ($_GET as $k => $v) {
  1151.                 $this->arrDefaults[$k] = Input::get($k);
  1152.             }
  1153.         }
  1155.         return $this->arrDefaults;
  1156.     }
  1157. }