Merge branch 'release/2.0.0'

Command/AbstractCommand.php

@@ -0,0 +1,134 @@
+<?php
+/**
+ * Copyright © 2016 Rouven Alexander Rieker
+ * See LICENSE.md bundled with this module for license details.
+ */
+namespace Semaio\ConfigImportExport\Command;
+
+use Magento\Framework\App\ObjectManager\ConfigLoader;
+use Magento\Framework\App\State as AppState;
+use Magento\Framework\ObjectManagerInterface;
+use Magento\Framework\Registry;
+use Magento\Framework\App\Cache\Manager as CacheManager;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Helper\FormatterHelper;
+
+/**
+ * Class AbstractCommand
+ *
+ * @package Semaio\ConfigImportExport\Command
+ */
+abstract class AbstractCommand extends Command
+{
+    /**
+     * @var AppState
+     */
+    private $appState;
+
+    /**
+     * @var ObjectManagerInterface
+     */
+    private $objectManager;
+
+    /**
+     * @var ConfigLoader
+     */
+    private $configLoader;
+
+    /**
+     * @var Registry
+     */
+    private $registry;
+
+    /**
+     * @var InputInterface
+     */
+    private $input;
+
+    /**
+     * @var OutputInterface
+     */
+    private $output;
+
+    /**
+     * @var CacheManager
+     */
+    private $cacheManager;
+
+    /**
+     * @param Registry                 $registry
+     * @param AppState                 $appState
+     * @param ConfigLoader             $configLoader
+     * @param ObjectManagerInterface   $objectManager
+     * @param CacheManager             $cacheManager
+     * @param null                     $name
+     */
+    public function __construct(
+        Registry $registry,
+        AppState $appState,
+        ConfigLoader $configLoader,
+        ObjectManagerInterface $objectManager,
+        CacheManager $cacheManager,
+        $name = null
+    ) {
+        $this->registry = $registry;
+        $this->appState = $appState;
+        $this->configLoader = $configLoader;
+        $this->objectManager = $objectManager;
+        $this->cacheManager = $cacheManager;
+        parent::__construct($name);
+    }
+
+    /**
+     * @param InputInterface  $input
+     * @param OutputInterface $output
+     * @return null|int
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $this->input = $input;
+        $this->output = $output;
+
+        $this->appState->setAreaCode('adminhtml');
+        $this->objectManager->configure($this->configLoader->load('adminhtml'));
+        $this->registry->register('isSecureArea', true);
+    }
+
+    /**
+     * Retrieve the cache manager
+     *
+     * @return CacheManager
+     */
+    public function getCacheManager()
+    {
+        return $this->cacheManager;
+    }
+
+    /**
+     * @return string
+     */
+    public function getFormat()
+    {
+        return $this->input->getOption('format');
+    }
+
+    /**
+     * @param string $text
+     * @param string $style
+     */
+    public function writeSection($text, $style = 'bg=blue;fg=white')
+    {
+        $formatter = new FormatterHelper();
+        $this->output->writeln(['', $formatter->formatBlock($text, $style, true), '']);
+    }
+
+    /**
+     * @return ObjectManagerInterface
+     */
+    public function getObjectManager()
+    {
+        return $this->objectManager;
+    }
+}

Command/ExportCommand.php

@@ -0,0 +1,132 @@
+<?php
+/**
+ * Copyright © 2016 Rouven Alexander Rieker
+ * See LICENSE.md bundled with this module for license details.
+ */
+namespace Semaio\ConfigImportExport\Command;
+
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Magento\Framework\App\ObjectManager\ConfigLoader;
+use Magento\Framework\App\State as AppState;
+use Magento\Framework\ObjectManagerInterface;
+use Magento\Framework\Registry;
+use Magento\Framework\App\Cache\Manager as CacheManager;
+use Semaio\ConfigImportExport\Model\Processor\ExportProcessorInterface;
+
+/**
+ * Class ExportCommand
+ *
+ * @package Semaio\ConfigImportExport\Command
+ */
+class ExportCommand extends AbstractCommand
+{
+    /**
+     * Command Name
+     */
+    const COMMAND_NAME = 'config:data:export';
+
+    /**
+     * @var ExportProcessorInterface
+     */
+    private $exportProcessor;
+
+    /**
+     * @var array
+     */
+    private $writers;
+
+    /**
+     * @param Registry                 $registry
+     * @param AppState                 $appState
+     * @param ConfigLoader             $configLoader
+     * @param ObjectManagerInterface   $objectManager
+     * @param CacheManager             $cacheManager
+     * @param ExportProcessorInterface $exportProcessor
+     * @param array                    $writers
+     * @param null                     $name
+     */
+    public function __construct(
+        Registry $registry,
+        AppState $appState,
+        ConfigLoader $configLoader,
+        ObjectManagerInterface $objectManager,
+        CacheManager $cacheManager,
+        ExportProcessorInterface $exportProcessor,
+        array $writers = [],
+        $name = null
+    ) {
+        $this->exportProcessor = $exportProcessor;
+        $this->writers = $writers;
+        parent::__construct($registry, $appState, $configLoader, $objectManager, $cacheManager, $name);
+    }
+
+    /**
+     * Configure the command
+     */
+    protected function configure()
+    {
+        $this->setName(self::COMMAND_NAME);
+        $this->setDescription('Export settings from "core_config_data" into a file');
+        $this->addOption('format', 'm', InputOption::VALUE_OPTIONAL, 'Format: yaml, json', 'yaml');
+        $this->addOption('hierarchical', 'a', InputOption::VALUE_OPTIONAL, 'Create a hierarchical or a flat structure (not all export format supports that). Enable with: y', 'n');
+        $this->addOption('filename', 'f', InputOption::VALUE_OPTIONAL, 'File name into which should the export be written. Defaults into var directory.');
+        $this->addOption('include', 'i', InputOption::VALUE_OPTIONAL, 'Path prefix, multiple values can be comma separated; exports only those paths');
+        $this->addOption('includeScope', null, InputOption::VALUE_OPTIONAL, 'Scope name, multiple values can be comma separated; exports only those scopes');
+        $this->addOption('exclude', 'x', InputOption::VALUE_OPTIONAL, 'Path prefix, multiple values can be comma separated; exports everything except ...');
+        $this->addOption('filePerNameSpace', 's', InputOption::VALUE_OPTIONAL, 'Export each namespace into its own file. Enable with: y', 'n');
+
+        parent::configure();
+    }
+
+    /**
+     * @param InputInterface  $input
+     * @param OutputInterface $output
+     * @return null|int
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        parent::execute($input, $output);
+        $this->writeSection('Start Export');
+
+        $format = $this->getFormat();
+        if (!array_key_exists($format, $this->writers)) {
+            throw new \InvalidArgumentException('Format "' . $format . '" is currently not supported."');
+        }
+
+        /** @var \Semaio\ConfigImportExport\Model\File\Writer\WriterInterface $writer */
+        $writer = $this->getObjectManager()->create($this->writers[$format]);
+        if (!$writer || !is_object($writer)) {
+            throw new \InvalidArgumentException(ucfirst($format) . ' file writer could not be instantiated."');
+        }
+
+        $filename = (string)$input->getOption('filename');
+        if ($filename != '') {
+            $writer->setBaseFilename($filename);
+        }
+
+        $writer->setOutput($output);
+        $writer->setIsHierarchical('y' === $input->getOption('hierarchical'));
+        $writer->setIsFilePerNameSpace('y' === $input->getOption('filePerNameSpace'));
+
+        $include = $input->getOption('include');
+        if (!empty($include) && is_string($include) === true) {
+            $this->exportProcessor->setInclude($include);
+        }
+
+        $includeScope = $input->getOption('includeScope');
+        if (!empty($includeScope) && is_string($includeScope) === true) {
+            $this->exportProcessor->setIncludeScope($includeScope);
+        }
+
+        $exclude = $input->getOption('exclude');
+        if (!empty($exclude) && is_string($exclude) === true) {
+            $this->exportProcessor->setExclude($exclude);
+        }
+
+        $this->exportProcessor->setWriter($writer);
+        $this->exportProcessor->setOutput($output);
+        $this->exportProcessor->process();
+    }
+}