MappableConditionsProcessor.php

Go to the documentation of this file.

<?php
declare(strict_types=1);

namespace Magento\CatalogRule\Model\Rule\Condition;

use Magento\Framework\Exception\InputException;
use Magento\Framework\Api\SearchCriteria\CollectionProcessor\ConditionProcessor\CustomConditionProviderInterface;
use Magento\CatalogRule\Model\Rule\Condition\Combine as CombinedCondition;
use Magento\CatalogRule\Model\Rule\Condition\Product as SimpleCondition;

class MappableConditionsProcessor
{
    private $customConditionProvider;

    private $eavConfig;

    public function __construct(
        CustomConditionProviderInterface $customConditionProvider,
        \Magento\Eav\Model\Config $eavConfig
    ) {
        $this->customConditionProvider = $customConditionProvider;
        $this->eavConfig = $eavConfig;
    }

    public function rebuildConditionsTree(CombinedCondition $conditions): CombinedCondition
    {
        return $this->rebuildCombinedCondition($conditions);
    }

    private function rebuildCombinedCondition(CombinedCondition $originalConditions): CombinedCondition
    {
        $validConditions = [];
        $invalidConditions = [];

        foreach ($originalConditions->getConditions() as $condition) {
            if ($condition->getType() === CombinedCondition::class) {
                $rebuildSubCondition = $this->rebuildCombinedCondition($condition);

                if (count($rebuildSubCondition->getConditions()) > 0) {
                    $validConditions[] = $rebuildSubCondition;
                } else {
                    $invalidConditions[] = $rebuildSubCondition;
                }

                continue;
            }

            if ($condition->getType() === SimpleCondition::class) {
                if ($this->validateSimpleCondition($condition)) {
                    $validConditions[] = $condition;
                } else {
                    $invalidConditions[] = $condition;
                }

                continue;
            }

            throw new InputException(
                __('Undefined condition type "%1" passed in.', $condition->getType())
            );
        }

        // if resulted condition group has left no mappable conditions - we can remove it at all
        if (count($invalidConditions) > 0 && strtolower($originalConditions->getAggregator()) === 'any') {
            $validConditions = [];
        }

        $rebuildCondition = clone $originalConditions;
        $rebuildCondition->setConditions($validConditions);

        return $rebuildCondition;
    }

    private function validateSimpleCondition(SimpleCondition $originalConditions): bool
    {
        return $this->canUseFieldForMapping($originalConditions->getAttribute());
    }

    private function canUseFieldForMapping(string $fieldName): bool
    {
        // We can map field to search criteria if we have custom processor for it
        if ($this->customConditionProvider->hasProcessorForField($fieldName)) {
            return true;
        }

        // Also we can map field to search criteria if it is an EAV attribute
        $attribute = $this->eavConfig->getAttribute(\Magento\Catalog\Model\Product::ENTITY, $fieldName);

        // We have this weird check for getBackendType() to verify that attribute really exists
        // because due to eavConfig behavior even if pass non existing attribute code we still receive AbstractAttribute
        // getAttributeId() is not sufficient too because some attributes don't have it - e.g. attribute_set_id
        if ($attribute && $attribute->getBackendType() !== null) {
            return true;
        }

        // In any other cases we can't map field to search criteria
        return false;
    }
}