Skip to content

Add optional parameter to cache:clean and cache:flush to exclude type(s) #40288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: 2.4-develop
Choose a base branch
from
Open

Add optional parameter to cache:clean and cache:flush to exclude type(s) #40288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
615c852
Added an option to exclude cache type while clearing or flushing
sandy-1873 Nov 12, 2025
41c2537
fixed static issues
sandy-1873 Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 26 additions & 7 deletions app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,19 @@

use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;

/**
* @api
* @since 100.0.2
*/
abstract class AbstractCacheManageCommand extends AbstractCacheCommand
{
/**
* Input argument types
*/
const INPUT_KEY_TYPES = 'types';
public const INPUT_KEY_TYPES = 'types';

public const EXCLUDE_KEY_TYPES = 'exclude';

/**
* {@inheritdoc}
* @inheritdoc
*/
protected function configure()
{
Expand All @@ -30,6 +29,12 @@ protected function configure()
InputArgument::IS_ARRAY,
'Space-separated list of cache types or omit to apply to all cache types.'
);
$this->addOption(
self::EXCLUDE_KEY_TYPES,
'e',
InputOption::VALUE_OPTIONAL,
'Comma separated list of cache types to omit'
);
parent::configure();
}

Expand All @@ -46,8 +51,16 @@ protected function getRequestedTypes(InputInterface $input)
$requestedTypes = $input->getArgument(self::INPUT_KEY_TYPES);
$requestedTypes = array_filter(array_map('trim', $requestedTypes), 'strlen');
}
$excludeTypes = $input->getOption(self::EXCLUDE_KEY_TYPES);
if (empty($requestedTypes)) {
return $this->cacheManager->getAvailableTypes();
$cacheTypes = $this->cacheManager->getAvailableTypes();
if (!empty($excludeTypes)) {
foreach (explode(',', $excludeTypes) as $item) {
unset($cacheTypes[array_search($item, $cacheTypes)]);
}
$cacheTypes = array_values($cacheTypes);
}
return $cacheTypes;
} else {
$availableTypes = $this->cacheManager->getAvailableTypes();
$unsupportedTypes = array_diff($requestedTypes, $availableTypes);
Expand All @@ -57,6 +70,12 @@ protected function getRequestedTypes(InputInterface $input)
. "'." . PHP_EOL . 'Supported types: ' . join(", ", $availableTypes)
);
}
if (!empty($excludeTypes)) {
foreach (explode(',', $excludeTypes) as $item) {
unset($availableTypes[array_search($item, $availableTypes)]);
}
$availableTypes = array_values($availableTypes);
}
return array_values(array_intersect($availableTypes, $requestedTypes));
}
}
Expand Down
7 changes: 7 additions & 0 deletions app/code/Magento/Backend/Console/Command/AbstractCacheTypeManageCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,13 @@ protected function execute(InputInterface $input, OutputInterface $output)
$this->performAction($types);
$output->writeln($this->getDisplayMessage());
$output->writeln(join(PHP_EOL, $types));
$excludeTypes = $input->getOption(self::EXCLUDE_KEY_TYPES);
if (!empty($excludeTypes)) {
$output->writeln('Excluded Cache Type');
foreach (explode(',', $excludeTypes) as $type) {
$output->writeln($type);
}
}

return Cli::RETURN_SUCCESS;
}
Expand Down