Merge remote-tracking branch 'mainline/develop' into ext-s51

Author: Dale Sikkema

app/code/Magento/Backend/Console/Command/AbstractCacheCommand.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Backend\Console\Command;
+
+use Magento\Framework\App\Cache\Manager;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputOption;
+
+abstract class AbstractCacheCommand extends Command
+{
+    /**
+     * Input option bootsrap
+     */
+    const INPUT_KEY_BOOTSTRAP = 'bootstrap';
+
+    /**
+     * CacheManager
+     *
+     * @var Manager
+     */
+    protected $cacheManager;
+
+    /**
+     * Constructor
+     *
+     * @param Manager $cacheManager
+     */
+    public function __construct(Manager $cacheManager)
+    {
+        $this->cacheManager = $cacheManager;
+        parent::__construct();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this->addOption(
+            self::INPUT_KEY_BOOTSTRAP,
+            null,
+            InputOption::VALUE_REQUIRED,
+            'add or override parameters of the bootstrap'
+        );
+    }
+}

app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php

@@ -0,0 +1,72 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Backend\Console\Command;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+
+abstract class AbstractCacheManageCommand extends AbstractCacheCommand
+{
+    /**
+     * Input argument types
+     */
+    const INPUT_KEY_TYPES = 'types';
+
+    /**
+     * Input key all
+     */
+    const INPUT_KEY_ALL = 'all';
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this->addArgument(
+            self::INPUT_KEY_TYPES,
+            InputArgument::IS_ARRAY,
+            'List of cache types, space separated. If omitted, all caches will be affected'
+        );
+        $this->addOption(
+            self::INPUT_KEY_ALL,
+            null,
+            InputOption::VALUE_NONE,
+            'All cache types'
+        );
+        parent::configure();
+    }
+
+
+    /**
+     * Get requested cache types
+     *
+     * @param InputInterface $input
+     * @return array
+     */
+    protected function getRequestedTypes(InputInterface $input)
+    {
+        $requestedTypes = [];
+        if ($input->getArgument(self::INPUT_KEY_TYPES)) {
+            $requestedTypes = $input->getArgument(self::INPUT_KEY_TYPES);
+            $requestedTypes = array_filter(array_map('trim', $requestedTypes), 'strlen');
+        }
+        if (empty($requestedTypes)) {
+            return [];
+        } else {
+            $availableTypes = $this->cacheManager->getAvailableTypes();
+            $unsupportedTypes = array_diff($requestedTypes, $availableTypes);
+            if ($unsupportedTypes) {
+                throw new \InvalidArgumentException(
+                    "The following requested cache types are not supported: '" . join("', '", $unsupportedTypes)
+                    . "'." . PHP_EOL . 'Supported types: ' . join(", ", $availableTypes)
+                );
+            }
+            return array_values(array_intersect($availableTypes, $requestedTypes));
+        }
+    }
+}

app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Backend\Console\Command;
+
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+abstract class AbstractCacheSetCommand extends AbstractCacheManageCommand
+{
+    /**
+     * Is enable cache or not
+     *
+     * @return bool
+     */
+    abstract protected function isEnable();
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $isEnable = $this->isEnable();
+        if ($input->getOption(self::INPUT_KEY_ALL)) {
+            $types = $this->cacheManager->getAvailableTypes();
+        } else {
+            $types = $this->getRequestedTypes($input);
+        }
+        $changedTypes = $this->cacheManager->setEnabled($types, $isEnable);
+        if ($changedTypes) {
+            $output->writeln('Changed cache status:');
+            foreach ($changedTypes as $type) {
+                $output->writeln(sprintf('%30s: %d -> %d', $type, !$isEnable, $isEnable));
+            }
+        } else {
+            $output->writeln('There is nothing to change in cache status');
+        }
+        if (!empty($changedTypes) && $isEnable) {
+            $this->cacheManager->clean($changedTypes);
+            $output->writeln('Cleaned cache types:');
+            $output->writeln(join(PHP_EOL, $changedTypes));
+        }
+    }
+}

app/code/Magento/Backend/Console/Command/AbstractCacheTypeManageCommand.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Backend\Console\Command;
+
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+abstract class AbstractCacheTypeManageCommand extends AbstractCacheManageCommand
+{
+    /**
+     * Perform a cache management action on cache types
+     *
+     * @param array $cacheTypes
+     * @return void
+     */
+    abstract protected function performAction(array $cacheTypes);
+
+    /**
+     * Get display message
+     *
+     * @return string
+     */
+    abstract protected function getDisplayMessage();
+
+    /**
+     * Perform cache management action
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return void
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        if ($input->getOption(self::INPUT_KEY_ALL)) {
+            $types = $this->cacheManager->getAvailableTypes();
+        } else {
+            $types = $this->getRequestedTypes($input);
+        }
+        $this->performAction($types);
+        $output->writeln($this->getDisplayMessage());
+        $output->writeln(join(PHP_EOL, $types));
+    }
+}

app/code/Magento/Backend/Console/Command/CacheCleanCommand.php

@@ -0,0 +1,42 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Backend\Console\Command;
+
+/**
+ * Command for cleaning cache
+ */
+class CacheCleanCommand extends AbstractCacheTypeManageCommand
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this->setName('cache:clean');
+        $this->setDescription('Cleans cache type(s)');
+        parent::configure();
+    }
+
+    /**
+     * Cleans cache types
+     *
+     * @param array $cacheTypes
+     * @return void
+     */
+    protected function performAction(array $cacheTypes)
+    {
+        $this->cacheManager->clean($cacheTypes);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getDisplayMessage()
+    {
+        return 'Cleaned cache types:';
+    }
+}

app/code/Magento/Backend/Console/Command/CacheDisableCommand.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Backend\Console\Command;
+
+/**
+ * Command for disabling cache
+ */
+class CacheDisableCommand extends AbstractCacheSetCommand
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this->setName('cache:disable');
+        $this->setDescription('Disables cache type(s)');
+        parent::configure();
+    }
+
+    /**
+     * Is Disable cache
+     *
+     * @return bool
+     */
+    protected function isEnable()
+    {
+        return false;
+    }
+}

app/code/Magento/Backend/Console/Command/CacheEnableCommand.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Backend\Console\Command;
+
+/**
+ * Command for enabling cache
+ */
+class CacheEnableCommand extends AbstractCacheSetCommand
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this->setName('cache:enable');
+        $this->setDescription('Enables cache type(s)');
+        parent::configure();
+    }
+
+    /**
+     * Is enable cache
+     *
+     * @return bool
+     */
+    protected function isEnable()
+    {
+        return true;
+    }
+}

app/code/Magento/Backend/Console/Command/CacheFlushCommand.php

@@ -0,0 +1,42 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Backend\Console\Command;
+
+/**
+ * Command for flushing cache
+ */
+class CacheFlushCommand extends AbstractCacheTypeManageCommand
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this->setName('cache:flush');
+        $this->setDescription('Flushes cache storage used by cache type(s)');
+        parent::configure();
+    }
+
+    /**
+     * Flushes cache types
+     *
+     * @param array $cacheTypes
+     * @return void
+     */
+    protected function performAction(array $cacheTypes)
+    {
+        $this->cacheManager->flush($cacheTypes);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getDisplayMessage()
+    {
+        return 'Flushed cache types:';
+    }
+}