isFormatSimple = false;
}
/**
* {@inheritdoc}
*/
public function configure()
{
$this
->setName('prestashop:list:commands-and-queries')
->setDescription('Lists available CQRS commands and queries')
->addOption(
'domain',
'd',
InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED,
'Filter available CQRS by domain.'
)
->addOption(
'format',
'f',
InputOption::VALUE_REQUIRED,
'Outputs either a regular or simplified format.',
'regular'
)
->addOption(
'hasApiEndpoint',
'',
InputOption::VALUE_OPTIONAL,
'Filter CQRS with (1) or without (0) an endpoint'
)
;
}
/**
* {@inheritdoc}
*/
protected function execute(InputInterface $input, OutputInterface $output): int
{
$this->apiResourcesList = $this->getResourceList();
$this->handleOptions($input);
$outputStyle = new OutputFormatterStyle('blue', null);
$output->getFormatter()->setStyle('blue', $outputStyle);
$optionHasApiEndpoint = $input->getOption('hasApiEndpoint') !== null ? (bool) $input->getOption('hasApiEndpoint') : null;
foreach ($this->commandAndQueries as $key => $commandName) {
$commandDefinition = $this->commandDefinitionParser->parseDefinition($commandName);
$cqrsEndpointURI = $this->getCQRSEndpointURI($commandDefinition);
if ($optionHasApiEndpoint !== null) {
if (($optionHasApiEndpoint && empty($cqrsEndpointURI)) || (!$optionHasApiEndpoint && !empty($cqrsEndpointURI))) {
continue;
}
}
if ($this->isFormatSimple) {
$output->writeln('' . $commandDefinition->getClassName() . (!empty($cqrsEndpointURI) ? ' OK' : ' NOT OK') . '');
} else {
$output->writeln(++$key . '.');
$output->writeln('Class: ' . $commandDefinition->getClassName() . '');
$output->writeln('Type: ' . $commandDefinition->getCommandType() . '');
if (!empty($cqrsEndpointURI)) {
$output->writeln('API: ' . $cqrsEndpointURI . '');
}
$output->writeln('' . $commandDefinition->getDescription() . '');
$output->writeln('');
}
}
return 0;
}
private function handleOptions(InputInterface $input): void
{
if ($input->getOption('domain') !== []) {
$this->filterCQRS($input->getOption('domain'));
}
if ($input->getOption('format') === 'simple') {
$this->isFormatSimple = true;
}
}
/**
* @param string[] $filters
*/
private function filterCQRS(array $filters): void
{
$this->commandAndQueries = array_filter($this->commandAndQueries, function (string $currentCQRS) use ($filters) {
foreach ($filters as $filter) {
// We append a backslash behind the filter to find only exact matches
if (str_contains($currentCQRS, $filter . '\\') !== false) {
return true;
}
}
return false;
});
}
/**
* This method rebuild the resources from the api platform attributes including modules.
*
* @return ResourceMetadataCollection[]
*/
private function getResourceList(): array
{
$resourceMetadataCollection = [];
// Get core resources (original working logic)
foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
try {
$resourceMetadataCollection[] = $this->resourceMetadataFactory->create($resourceClass);
} catch (Exception $e) {
// Skip resources that can't be loaded
continue;
}
}
// Get resource classes from modules
$moduleApiResourceScopes = array_filter(
$this->apiResourceScopesExtractor->getAllApiResourceScopes(),
fn ($scope) => !$scope->fromCore()
);
foreach ($moduleApiResourceScopes as $apiResourceScope) {
$moduleName = $apiResourceScope->getModuleName();
$moduleResourcePaths = $this->getModuleResourcePaths($moduleName);
if (empty($moduleResourcePaths)) {
continue;
}
try {
$moduleResourceExtractor = new AttributesResourceNameCollectionFactory($moduleResourcePaths);
foreach ($moduleResourceExtractor->create() as $resourceClass) {
try {
$resourceMetadataCollection[] = $this->resourceMetadataFactory->create($resourceClass);
} catch (Exception $e) {
// Skip individual resources that can't be loaded (e.g., missing dependencies)
continue;
}
}
} catch (Exception $e) {
// Skip entire module if resource factory fails (e.g., invalid path)
continue;
}
}
return $resourceMetadataCollection;
}
private function getModuleResourcePaths(string $moduleName): array
{
$paths = [];
$modulePath = $this->moduleDir . $moduleName;
// Folder containing ApiPlatform resources classes
$moduleResourcesPath = sprintf('%s/src/ApiPlatform/Resources', $modulePath);
if (file_exists($moduleResourcesPath)) {
$paths[] = $moduleResourcesPath;
}
return $paths;
}
/**
* This method takes the filtered list of routes, and checks it against the list of CQRS.
* The CQRS that have a route with the correct method are implemented, so we return the URI of the endpoint.
*/
private function getCQRSEndpointURI(CommandDefinition $commandDefinition): string
{
$cqrsClassName = $commandDefinition->getClassName();
$matchingEndpoints = [];
foreach ($this->apiResourcesList as $apiResources) {
foreach ($apiResources as $resource) {
$apiResourceOperations = $resource->getOperations();
foreach ($apiResourceOperations as $operation) {
$extraProperties = $operation->getExtraProperties();
// Check if this operation uses the same CQRS class
$operationCQRSClass = null;
if (!empty($extraProperties['CQRSQuery'])) {
$operationCQRSClass = $extraProperties['CQRSQuery'];
} elseif (!empty($extraProperties['CQRSCommand'])) {
$operationCQRSClass = $extraProperties['CQRSCommand'];
}
if ($operationCQRSClass === $cqrsClassName
&& $this->doesMethodsMatchType($operation->getMethod(), $commandDefinition->getCommandType())) {
$matchingEndpoints[] = [
'method' => $operation->getMethod(),
'uri' => $operation->getUriTemplate(),
];
}
}
}
}
if (empty($matchingEndpoints)) {
return '';
}
if (count($matchingEndpoints) === 1) {
return $matchingEndpoints[0]['method'] . ' ' . $matchingEndpoints[0]['uri'];
}
// Multiple endpoints - format as method:uri pairs
$formattedEndpoints = array_map(
fn ($endpoint) => $endpoint['method'] . ' ' . $endpoint['uri'],
$matchingEndpoints
);
return implode(', ', array_unique($formattedEndpoints));
}
private function doesMethodsMatchType(string $method, string $commandType): bool
{
switch ($commandType) {
case 'Command':
return in_array($method, ['POST', 'PUT', 'PATCH', 'DELETE']);
case 'Query':
return $method === 'GET';
default:
return false;
}
}
}