IndexerShowDimensionsModeCommand.php 4.92 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\Indexer\Console\Command;

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

/**
 * Command to show indexers dimension modes
 */
class IndexerShowDimensionsModeCommand extends AbstractIndexerCommand
{
    const INPUT_KEY_INDEXER = 'indexer';
    const DIMENSION_MODE_NONE = 'none';
    const XML_PATH_DIMENSIONS_MODE_MASK = 'indexer/%s/dimensions_mode';
    /**
     * @var string
     */
    private $commandName = 'indexer:show-dimensions-mode';
    /**
     * ScopeConfigInterface
     *
     * @var ScopeConfigInterface
     */
    private $configReader;
    /**
     * @var string[]
     */
    private $indexers;

    /**
     * @param ObjectManagerFactory $objectManagerFactory
     * @param ScopeConfigInterface $configReader
     * @param array $indexers
     */
    public function __construct(
        ObjectManagerFactory $objectManagerFactory,
        ScopeConfigInterface $configReader,
        array $indexers
    ) {
        $this->configReader = $configReader;
        $this->indexers = $indexers;
        parent::__construct($objectManagerFactory);
    }

    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this->setName($this->commandName)
            ->setDescription('Shows Indexer Dimension Mode')
            ->setDefinition($this->getInputList());
        parent::configure();
    }

    /**
     * {@inheritdoc}
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return int
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $errors = $this->validate($input);
        if ($errors) {
            throw new \InvalidArgumentException(implode(PHP_EOL, $errors));
        }
        $returnValue = Cli::RETURN_SUCCESS;
        /** @var \Magento\Indexer\Model\Indexer $indexer */
        $indexer = $this->getObjectManager()->get(\Magento\Indexer\Model\Indexer::class);
        try {
            $selectedIndexers = $input->getArgument(self::INPUT_KEY_INDEXER);
            if ($selectedIndexers) {
                $indexersList = (array)$selectedIndexers;
            } else {
                $indexersList = $this->indexers;
            }
            foreach ($indexersList as $indexerId) {
                $indexer->load($indexerId);
                $configPath = sprintf(self::XML_PATH_DIMENSIONS_MODE_MASK, $indexerId);
                $mode = $this->configReader->getValue($configPath) ?: self::DIMENSION_MODE_NONE;
                $output->writeln(sprintf('%-50s ', $indexer->getTitle() . ':') . $mode);
            }
        } 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;
    }

    /**
     * Get list of arguments for the command
     *
     * @return InputArgument[]
     */
    private function getInputList(): array
    {
        $optionDescription = 'Space-separated list of index types or omit to apply to all indexes';
        $arguments[] = new InputArgument(
            self::INPUT_KEY_INDEXER,
            InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
            $optionDescription . ' (' . implode($this->indexers) . ')'
        );

        return $arguments;
    }

    /**
     * Check if all arguments are provided
     *
     * @param InputInterface $input
     * @return string[]
     */
    private function validate(InputInterface $input): array
    {
        $inputIndexer = (array)$input->getArgument(self::INPUT_KEY_INDEXER);
        $acceptedValues = array_keys($this->indexers);
        $errors = $this->validateArgument(self::INPUT_KEY_INDEXER, $inputIndexer, $acceptedValues);

        return $errors;
    }

    /**
     * Validate command argument and return errors in case if argument is invalid
     *
     * @param string $inputKey
     * @param array $inputIndexer
     * @param array $acceptedValues
     * @return array
     */
    private function validateArgument(string $inputKey, array $inputIndexer, array $acceptedValues): array
    {
        $errors = [];
        $acceptedIndexerValues = ' Accepted values for "<' . $inputKey . '>" are \'' .
            implode(',', $acceptedValues) . '\'';
        if (!empty($inputIndexer) && !\array_intersect($inputIndexer, $acceptedValues)) {
            $errors[] = 'Invalid value for "<' . $inputKey . '>" argument.' . $acceptedIndexerValues;
        }

        return $errors;
    }
}