IndexerSetDimensionsModeCommand.php

Go to the documentation of this file.

<?php
declare(strict_types=1);

namespace Magento\Indexer\Console\Command;

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputArgument;
use Magento\Framework\App\ObjectManagerFactory;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\Console\Cli;
use Magento\Indexer\Model\ModeSwitcherInterface;

class IndexerSetDimensionsModeCommand extends AbstractIndexerCommand
{
    const INPUT_KEY_MODE = 'mode';
    const INPUT_KEY_INDEXER = 'indexer';
    const DIMENSION_MODE_NONE = 'none';
    const XML_PATH_DIMENSIONS_MODE_MASK = 'indexer/%s/dimensions_mode';

    private $commandName = 'indexer:set-dimensions-mode';

    private $configReader;

    private $dimensionProviders;

    public function __construct(
        ObjectManagerFactory $objectManagerFactory,
        ScopeConfigInterface $configReader,
        array $dimensionSwitchers
    ) {
        $this->configReader = $configReader;
        $this->dimensionProviders = $dimensionSwitchers;
        parent::__construct($objectManagerFactory);
    }

    protected function configure()
    {
        $this->setName($this->commandName)
            ->setDescription('Set Indexer Dimensions Mode')
            ->setDefinition($this->getInputList());
        parent::configure();
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $errors = $this->validate($input);
        if ($errors) {
            throw new \InvalidArgumentException(implode(PHP_EOL, $errors));
        }
        $returnValue = Cli::RETURN_SUCCESS;
        $indexer = $this->getObjectManager()->get(\Magento\Indexer\Model\Indexer::class);
        try {
            $selectedIndexer = (string)$input->getArgument(self::INPUT_KEY_INDEXER);
            if (!$selectedIndexer) {
                $this->showAvailableModes($output);
            } else {
                $indexer->load($selectedIndexer);
                $currentMode = $input->getArgument(self::INPUT_KEY_MODE);
                $configPath = sprintf(self::XML_PATH_DIMENSIONS_MODE_MASK, $selectedIndexer);
                $previousMode = $this->configReader->getValue($configPath) ?: self::DIMENSION_MODE_NONE;
                if ($previousMode !== $currentMode) {
                    $modeSwitcher = $this->dimensionProviders[$selectedIndexer];
                    // Switch dimensions mode
                    $modeSwitcher->switchMode($currentMode, $previousMode);
                    $output->writeln(
                        'Dimensions mode for indexer "' . $indexer->getTitle() . '" was changed from \''
                        . $previousMode . '\' to \'' . $currentMode . '\''
                    );
                } else {
                    $output->writeln('Dimensions mode for indexer "' . $indexer->getTitle() . '" has not been changed');
                }
            }
        } catch (\Exception $e) {
            $output->writeln('"' . $indexer->getTitle() . '" indexer process unknown error:' . PHP_EOL);
            $output->writeln($e->getMessage() . PHP_EOL);
            // we must have an exit code higher than zero to indicate something was wrong
            $returnValue = Cli::RETURN_FAILURE;
        }

        return $returnValue;
    }

    private function showAvailableModes(OutputInterface $output)
    {
        $output->writeln(sprintf('%-50s', 'Indexer') . 'Available modes');
        foreach ($this->dimensionProviders as $indexer => $provider) {
            $availableModes = implode(',', array_keys($provider->getDimensionModes()->getDimensions()));
            $output->writeln(sprintf('%-50s', $indexer) . $availableModes);
        }
    }

    private function getInputList(): array
    {
        $dimensionProvidersList = array_keys($this->dimensionProviders);
        $indexerOptionDescription = 'Indexer name [' . implode('|', $dimensionProvidersList) . ']';
        $arguments[] = new InputArgument(
            self::INPUT_KEY_INDEXER,
            InputArgument::OPTIONAL,
            $indexerOptionDescription
        );
        $modeOptionDescription = 'Indexer dimension modes' . PHP_EOL;
        foreach ($this->dimensionProviders as $indexer => $provider) {
            $availableModes = implode(',', array_keys($provider->getDimensionModes()->getDimensions()));
            $modeOptionDescription .= sprintf('%-30s ', $indexer) . $availableModes . PHP_EOL;
        }
        $arguments[] = new InputArgument(
            self::INPUT_KEY_MODE,
            InputArgument::OPTIONAL,
            $modeOptionDescription
        );

        return $arguments;
    }

    private function validate(InputInterface $input): array
    {
        $errors = [];
        $inputIndexer = (string)$input->getArgument(self::INPUT_KEY_INDEXER);
        if ($inputIndexer) {
            $acceptedValues = array_keys($this->dimensionProviders);
            $errors = $this->validateArgument(self::INPUT_KEY_INDEXER, $inputIndexer, $acceptedValues);
            if (!$errors) {
                $inputIndexerDimensionMode = (string)$input->getArgument(self::INPUT_KEY_MODE);
                $modeSwitcher = $this->dimensionProviders[$inputIndexer];
                $acceptedValues = array_keys($modeSwitcher->getDimensionModes()->getDimensions());
                $errors = $this->validateArgument(self::INPUT_KEY_MODE, $inputIndexerDimensionMode, $acceptedValues);
            }
        }

        return $errors;
    }

    private function validateArgument(string $inputKey, string $inputIndexer, array $acceptedValues): array
    {
        $errors = [];
        $acceptedIndexerValues = ' Accepted values for "<' . $inputKey . '>" are \'' .
            implode(',', $acceptedValues) . '\'';
        if (!$inputIndexer) {
            $errors[] = 'Missing argument "<' . $inputKey . '>".' . $acceptedIndexerValues;
        } elseif (!\in_array($inputIndexer, $acceptedValues)) {
            $errors[] = 'Invalid value for "<' . $inputKey . '>" argument.' . $acceptedIndexerValues;
        }

        return $errors;
    }
}