Current path: home/webdevt/www/schtroumpf.fr/vendor/api-platform/core/src/Core/Bridge/Symfony/Bundle/Command/
?? Go up: /home/webdevt/www/schtroumpf.fr/vendor/api-platform/core/src/Core/Bridge/Symfony/Bundle
<?php
/*
* This file is part of the API Platform project.
*
* (c) Kévin Dunglas <dunglas@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Command;
use ApiPlatform\Core\Annotation\ApiResource;
use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Operation\Factory\SubresourceOperationFactoryInterface;
use ApiPlatform\Core\Upgrade\ColorConsoleDiffFormatter;
use ApiPlatform\Core\Upgrade\SubresourceTransformer;
use ApiPlatform\Core\Upgrade\UpgradeApiFilterVisitor;
use ApiPlatform\Core\Upgrade\UpgradeApiPropertyVisitor;
use ApiPlatform\Core\Upgrade\UpgradeApiResourceVisitor;
use ApiPlatform\Core\Upgrade\UpgradeApiSubresourceVisitor;
use ApiPlatform\Exception\ResourceClassNotFoundException;
use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
use Doctrine\Common\Annotations\AnnotationReader;
use PhpParser\Lexer\Emulative;
use PhpParser\NodeTraverser;
use PhpParser\Parser\Php7;
use PhpParser\PrettyPrinter\Standard;
use SebastianBergmann\Diff\Differ;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
#[AsCommand(name: 'api:upgrade-resource')]
final class UpgradeApiResourceCommand extends Command
{
/**
* @deprecated To be removed along with Symfony < 6.1 compatibility
*/
protected static $defaultName = 'api:upgrade-resource';
private $resourceNameCollectionFactory;
private $resourceMetadataFactory;
private $subresourceOperationFactory;
private $subresourceTransformer;
private $reader;
private $identifiersExtractor;
public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, SubresourceOperationFactoryInterface $subresourceOperationFactory, SubresourceTransformer $subresourceTransformer, IdentifiersExtractorInterface $identifiersExtractor, AnnotationReader $reader = null)
{
$this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
$this->resourceMetadataFactory = $resourceMetadataFactory;
$this->subresourceOperationFactory = $subresourceOperationFactory;
$this->subresourceTransformer = $subresourceTransformer;
$this->identifiersExtractor = $identifiersExtractor;
$this->reader = $reader;
parent::__construct();
}
/**
* {@inheritdoc}
*/
protected function configure()
{
$this
->setDescription('The "api:upgrade-resource" command upgrades your API Platform metadata from versions below 2.6 to the new metadata from versions above 2.7.
Once you executed this script, make sure that the "metadata_backward_compatibility_layer" flag is set to "false" in the API Platform configuration.
This will remove "ApiPlatform\Core\Annotation\ApiResource" annotation/attribute and use the "ApiPlatform\Metadata\ApiResource" attribute instead.')
->addOption('dry-run', '-d', InputOption::VALUE_OPTIONAL, 'Dry mode outputs a diff instead of writing files.', true)
->addOption('silent', '-s', InputOption::VALUE_NONE, 'Silent output.')
->addOption('force', '-f', InputOption::VALUE_NONE, 'Writes the files in place and skips PHP version check.');
}
/**
* {@inheritdoc}
*/
protected function execute(InputInterface $input, OutputInterface $output): int
{
if (!$input->getOption('force') && \PHP_VERSION_ID < 80100) {
$output->write('<error>The new metadata system only works with PHP 8.1 and above.');
return \defined(Command::class.'::INVALID') ? Command::INVALID : 2;
}
if (!class_exists(NodeTraverser::class)) {
$output->writeln('Run `composer require --dev `nikic/php-parser` or install phpunit to use this command.');
return \defined(Command::class.'::FAILURE') ? Command::FAILURE : 1;
}
$subresources = $this->getSubresources();
$prettyPrinter = new Standard();
foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
try {
$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
} catch (ResourceClassNotFoundException $e) {
continue;
}
$lexer = new Emulative([
'usedAttributes' => [
'comments',
'startLine',
'endLine',
'startTokenPos',
'endTokenPos',
],
]);
$parser = new Php7($lexer);
$fileName = (new \ReflectionClass($resourceClass))->getFilename();
$traverser = new NodeTraverser();
[$attribute, $isAnnotation] = $this->readApiResource($resourceClass);
$traverser->addVisitor(new UpgradeApiFilterVisitor($this->reader, $resourceClass));
$traverser->addVisitor(new UpgradeApiPropertyVisitor($this->reader, $resourceClass));
if (!$attribute) {
continue;
}
$traverser->addVisitor(new UpgradeApiResourceVisitor($attribute, $isAnnotation, $this->identifiersExtractor, $resourceClass));
if (isset($subresources[$resourceClass])) {
$referenceType = $resourceMetadata->getAttribute('url_generation_strategy');
foreach ($subresources[$resourceClass] as $subresourceMetadata) {
$traverser->addVisitor(new UpgradeApiSubresourceVisitor($subresourceMetadata, $referenceType));
}
}
$oldCode = file_get_contents($fileName);
$oldStmts = $parser->parse($oldCode);
$oldTokens = $lexer->getTokens();
$newStmts = $traverser->traverse($oldStmts);
$newCode = $prettyPrinter->printFormatPreserving($newStmts, $oldStmts, $oldTokens);
if (!$input->getOption('force') && $input->getOption('dry-run')) {
if ($input->getOption('silent')) {
continue;
}
if (!class_exists(Differ::class)) {
$output->writeln('Run `composer require --dev sebastian/diff` or install phpunit to print a diff.');
return \defined(Command::class.'::FAILURE') ? Command::FAILURE : 1;
}
$this->printDiff($oldCode, $newCode, $output);
continue;
}
file_put_contents($fileName, $newCode);
}
return \defined(Command::class.'::SUCCESS') ? Command::SUCCESS : 0;
}
/**
* This computes a local cache with resource classes having subresources.
* We first loop over all the classes and re-map the metadata on the correct Resource class.
* Then we transform the ApiSubresource to an ApiResource class.
*/
private function getSubresources(): array
{
$localCache = [];
foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
try {
new \ReflectionClass($resourceClass);
} catch (\Exception $e) {
continue;
}
if (!isset($localCache[$resourceClass])) {
$localCache[$resourceClass] = [];
}
foreach ($this->subresourceOperationFactory->create($resourceClass) as $subresourceMetadata) {
if (!isset($localCache[$subresourceMetadata['resource_class']])) {
$localCache[$subresourceMetadata['resource_class']] = [];
}
foreach ($localCache[$subresourceMetadata['resource_class']] as $currentSubresourceMetadata) {
if ($currentSubresourceMetadata['path'] === $subresourceMetadata['path']) {
continue 2;
}
}
$localCache[$subresourceMetadata['resource_class']][] = $subresourceMetadata;
}
}
// Compute URI variables
foreach ($localCache as $class => $subresources) {
if (!$subresources) {
unset($localCache[$class]);
continue;
}
foreach ($subresources as $i => $subresourceMetadata) {
$localCache[$class][$i]['uri_variables'] = $this->subresourceTransformer->toUriVariables($subresourceMetadata);
}
}
return $localCache;
}
private function printDiff(string $oldCode, string $newCode, OutputInterface $output): void
{
$consoleFormatter = new ColorConsoleDiffFormatter();
$differ = new Differ();
$diff = $differ->diff($oldCode, $newCode);
$output->write($consoleFormatter->format($diff));
}
/**
* @return array[ApiResource, bool]
*/
private function readApiResource(string $resourceClass): array
{
$reflectionClass = new \ReflectionClass($resourceClass);
if (\PHP_VERSION_ID >= 80000 && $attributes = $reflectionClass->getAttributes(ApiResource::class)) {
return [$attributes[0]->newInstance(), false];
}
if (null === $this->reader) {
throw new \RuntimeException(sprintf('Resource "%s" not found.', $resourceClass));
}
return [$this->reader->getClassAnnotation($reflectionClass, ApiResource::class), true];
}
}