IsProductSalableConditionChain.php

Go to the documentation of this file.

<?php
declare(strict_types=1);

namespace Magento\InventorySales\Model\IsProductSalableCondition;

use Magento\InventorySalesApi\Api\IsProductSalableInterface;
use Magento\Framework\Exception\LocalizedException;
use Magento\InventoryConfigurationApi\Exception\SkuIsNotAssignedToStockException;

class IsProductSalableConditionChain implements IsProductSalableInterface
{
    private $unrequiredConditions;

    private $requiredConditions;

    public function __construct(
        array $conditions
    ) {
        $this->setConditions($conditions);
    }

    private function setConditions(array $conditions)
    {
        $this->validateConditions($conditions);

        $unrequiredConditions = array_filter(
            $conditions,
            function ($item) {
                return !isset($item['required']);
            }
        );
        $this->unrequiredConditions = array_column($this->sortConditions($unrequiredConditions), 'object');

        $requiredConditions = array_filter(
            $conditions,
            function ($item) {
                return isset($item['required']) && (bool) $item['required'];
            }
        );
        $this->requiredConditions = array_column($requiredConditions, 'object');
    }

    private function validateConditions(array $conditions)
    {
        foreach ($conditions as $condition) {
            if (empty($condition['object'])) {
                throw new LocalizedException(__('Parameter "object" must be present.'));
            }

            if (empty($condition['required']) && empty($condition['sort_order'])) {
                throw new LocalizedException(__('Parameter "sort_order" must be present for unrequired conditions.'));
            }

            if (!$condition['object'] instanceof IsProductSalableInterface) {
                throw new LocalizedException(
                    __('Condition have to implement IsProductSalableInterface.')
                );
            }
        }
    }

    private function sortConditions(array $conditions)
    {
        usort($conditions, function (array $conditionLeft, array $conditionRight) {
            if ($conditionLeft['sort_order'] == $conditionRight['sort_order']) {
                return 0;
            }
            return ($conditionLeft['sort_order'] < $conditionRight['sort_order']) ? -1 : 1;
        });
        return $conditions;
    }

    public function execute(string $sku, int $stockId): bool
    {
        try {
            foreach ($this->requiredConditions as $requiredCondition) {
                if ($requiredCondition->execute($sku, $stockId) === false) {
                    return false;
                }
            }
            foreach ($this->unrequiredConditions as $unrequiredCondition) {
                if ($unrequiredCondition->execute($sku, $stockId) === true) {
                    return true;
                }
            }
        } catch (SkuIsNotAssignedToStockException $e) {
            return false;
        }

        return false;
    }
}