feature #1128 improve PHP 8 support w/ rector, removes legacy code, d…

…eprecates unused methods (jrushlow) This PR was squashed before being merged into the 1.0-dev branch. Discussion ---------- improve PHP 8 support w/ rector, removes legacy code, deprecates unused methods - removes Argon2 support with `make:user` - deprecates unused methods that are not `final` or `internal` - removes PHP 7.x version checks - uses rector (not included) to bring `src` up to PHP 8 standards Commits ------- 88148d0 improve PHP 8 support w/ rector, removes legacy code, deprecates unused methods
symfony · May 31, 2022 · 48c1634 · 48c1634
2 parents 33fb24f + 88148d0
commit 48c1634
Show file tree

Hide file tree

Showing 50 changed files with 195 additions and 372 deletions.
diff --git a/src/Command/MakerCommand.php b/src/Command/MakerCommand.php
@@ -57,10 +57,6 @@ protected function initialize(InputInterface $input, OutputInterface $output): v
             $dependencies = new DependencyBuilder();
             $this->maker->configureDependencies($dependencies, $input);
 
-            if (!$dependencies->isPhpVersionSatisfied()) {
-                throw new RuntimeCommandException('The make:entity command requires that you use PHP 7.1 or higher.');
-            }
-
             if ($missingPackagesMessage = $dependencies->getMissingPackagesMessage($this->getName())) {
                 throw new RuntimeCommandException($missingPackagesMessage);
             }

diff --git a/src/Console/MigrationDiffFilteredOutput.php b/src/Console/MigrationDiffFilteredOutput.php
@@ -14,9 +14,9 @@
 use Symfony\Component\Console\Formatter\OutputFormatterInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
-if (\PHP_VERSION_ID < 80000
-    // look for the "string|iterable" type on OutputInterface::write()
-    || !(new \ReflectionMethod(OutputInterface::class, 'write'))->getParameters()[0]->getType()) {
+// look for the "string|iterable" type on OutputInterface::write()
+// @legacy - Use MigrationDiffFilteredOutput_php8 when Symfony 5.4 is no longer supported
+if (!(new \ReflectionMethod(OutputInterface::class, 'write'))->getParameters()[0]->getType()) {
     class MigrationDiffFilteredOutput implements OutputInterface
     {
         use BaseMakerMigrationDiffFilteredOuputTrait;
@@ -47,13 +47,12 @@ public function setDecorated($decorated)
 
 trait BaseMakerMigrationDiffFilteredOuputTrait
 {
-    private $output;
-    private $buffer = '';
-    private $previousLineWasRemoved = false;
+    private string $buffer = '';
+    private bool $previousLineWasRemoved = false;
 
-    public function __construct(OutputInterface $output)
-    {
-        $this->output = $output;
+    public function __construct(
+        private OutputInterface $output,
+    ) {
     }
 
     public function _write($messages, bool $newline = false, $options = 0)
@@ -144,7 +143,7 @@ private function filterMessages($messages, bool $newLine)
 
             $this->previousLineWasRemoved = false;
             foreach ($hiddenPhrases as $hiddenPhrase) {
-                if (false !== strpos($message, $hiddenPhrase)) {
+                if (str_contains($message, $hiddenPhrase)) {
                     $this->previousLineWasRemoved = true;
                     unset($messages[$key]);
 

diff --git a/src/ConsoleStyle.php b/src/ConsoleStyle.php
@@ -21,12 +21,10 @@
  */
 final class ConsoleStyle extends SymfonyStyle
 {
-    private $output;
-
-    public function __construct(InputInterface $input, OutputInterface $output)
-    {
-        $this->output = $output;
-
+    public function __construct(
+        InputInterface $input,
+        private OutputInterface $output,
+    ) {
         parent::__construct($input, $output);
     }
 

diff --git a/src/DependencyBuilder.php b/src/DependencyBuilder.php
@@ -13,10 +13,8 @@
 
 final class DependencyBuilder
 {
-    private $dependencies = [];
-    private $devDependencies = [];
-
-    private $minimumPHPVersion = 70100;
+    private array $dependencies = [];
+    private array $devDependencies = [];
 
     /**
      * Add a dependency that will be reported if the given class is missing.
@@ -44,7 +42,7 @@ public function addClassDependency(string $class, string $package, bool $require
 
     public function requirePHP71(): void
     {
-        // no-op - MakerBundle now required PHP 7.1
+        trigger_deprecation('symfony/maker-bundle', 'v1.44.0', 'requirePHP71() is deprecated and will be removed in a future version.');
     }
 
     /**
@@ -110,14 +108,6 @@ public function getMissingPackagesMessage(string $commandName, $message = null):
         return $message;
     }
 
-    /**
-     * @internal
-     */
-    public function isPhpVersionSatisfied(): bool
-    {
-        return \PHP_VERSION_ID >= $this->minimumPHPVersion;
-    }
-
     private function getRequiredDependencyNames(array $dependencies): array
     {
         $packages = [];
@@ -149,6 +139,6 @@ private function calculateMissingDependencies(array $dependencies): array
             return [];
         }
 
-        return array_unique(array_merge($missingPackages, $missingOptionalPackages));
+        return array_unique([...$missingPackages, ...$missingOptionalPackages]);
     }
 }
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -22,12 +22,7 @@ class Configuration implements ConfigurationInterface
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('maker');
-        if (method_exists($treeBuilder, 'getRootNode')) {
-            $rootNode = $treeBuilder->getRootNode();
-        } else {
-            // BC layer for symfony/config 4.1 and older
-            $rootNode = $treeBuilder->root('maker');
-        }
+        $rootNode = $treeBuilder->getRootNode();
 
         $rootNode
             ->children()

diff --git a/src/Docker/DockerDatabaseServices.php b/src/Docker/DockerDatabaseServices.php
@@ -83,17 +83,11 @@ public static function getSuggestedServiceVersion(string $name): string
 
     public static function getMissingExtensionName(string $name): ?string
     {
-        switch ($name) {
-            case 'mariadb':
-            case 'mysql':
-                $driver = 'mysql';
-                break;
-            case 'postgres':
-                $driver = 'pgsql';
-                break;
-            default:
-                self::throwInvalidDatabase($name);
-        }
+        $driver = match ($name) {
+            'mariadb', 'mysql' => 'mysql',
+            'postgres' => 'pgsql',
+            default => self::throwInvalidDatabase($name),
+        };
 
         if (!\in_array($driver, \PDO::getAvailableDrivers(), true)) {
             return $driver;

diff --git a/src/Doctrine/DoctrineHelper.php b/src/Doctrine/DoctrineHelper.php
@@ -68,7 +68,7 @@ public function doesClassUseDriver(string $className, string $driverClass): bool
         try {
             /** @var EntityManagerInterface $em */
             $em = $this->getRegistry()->getManagerForClass($className);
-        } catch (\ReflectionException $exception) {
+        } catch (\ReflectionException) {
             // this exception will be thrown by the registry if the class isn't created yet.
             // an example case is the "make:entity" command, which needs to know which driver is used for the class to determine
             // if the class should be generated with attributes or annotations. If this exception is thrown, we will check based on the
@@ -167,7 +167,7 @@ public function getMetadata(string $classOrNamespace = null, bool $disconnected
             if ($disconnected) {
                 try {
                     $loaded = $cmf->getAllMetadata();
-                } catch (ORMMappingException|PersistenceMappingException $e) {
+                } catch (ORMMappingException|PersistenceMappingException) {
                     $loaded = $this->isInstanceOf($cmf, AbstractClassMetadataFactory::class) ? $cmf->getLoadedMetadata() : [];
                 }
 

diff --git a/src/Doctrine/EntityDetails.php b/src/Doctrine/EntityDetails.php
@@ -52,9 +52,7 @@ public function getFormFields(): array
 
         if (!empty($this->metadata->embeddedClasses)) {
             foreach (array_keys($this->metadata->embeddedClasses) as $embeddedClassKey) {
-                $fields = array_filter($fields, function ($v) use ($embeddedClassKey) {
-                    return 0 !== strpos($v, $embeddedClassKey.'.');
-                });
+                $fields = array_filter($fields, static fn ($v) => !str_starts_with($v, $embeddedClassKey.'.'));
             }
         }
 

diff --git a/src/Doctrine/EntityRegenerator.php b/src/Doctrine/EntityRegenerator.php
@@ -38,7 +38,7 @@ public function regenerateEntities(string $classOrNamespace): void
     {
         try {
             $metadata = $this->doctrineHelper->getMetadata($classOrNamespace);
-        } catch (MappingException|LegacyCommonMappingException|PersistenceMappingException $mappingException) {
+        } catch (MappingException|LegacyCommonMappingException|PersistenceMappingException) {
             $metadata = $this->doctrineHelper->getMetadata($classOrNamespace, true);
         }
 
@@ -72,7 +72,7 @@ public function regenerateEntities(string $classOrNamespace): void
             $embeddedClasses = [];
 
             foreach ($classMetadata->embeddedClasses as $fieldName => $mapping) {
-                if (false !== strpos($fieldName, '.')) {
+                if (str_contains($fieldName, '.')) {
                     continue;
                 }
 
@@ -91,7 +91,7 @@ public function regenerateEntities(string $classOrNamespace): void
 
             foreach ($classMetadata->fieldMappings as $fieldName => $mapping) {
                 // skip embedded fields
-                if (false !== strpos($fieldName, '.')) {
+                if (str_contains($fieldName, '.')) {
                     [$fieldName, $embeddedFiledName] = explode('.', $fieldName);
 
                     $operations[$embeddedClasses[$fieldName]]->addEntityField($embeddedFiledName, $mapping);
@@ -238,11 +238,11 @@ private function getMappedFieldsInEntity(ClassMetadata $classMetadata): array
         /** @var \ReflectionClass $classReflection */
         $classReflection = $classMetadata->reflClass;
 
-        $targetFields = array_merge(
-            array_keys($classMetadata->fieldMappings),
-            array_keys($classMetadata->associationMappings),
-            array_keys($classMetadata->embeddedClasses)
-        );
+        $targetFields = [
+            ...array_keys($classMetadata->fieldMappings),
+            ...array_keys($classMetadata->associationMappings),
+            ...array_keys($classMetadata->embeddedClasses),
+        ];
 
         if ($classReflection) {
             // exclude traits
@@ -257,10 +257,8 @@ private function getMappedFieldsInEntity(ClassMetadata $classMetadata): array
             $targetFields = array_diff($targetFields, $traitProperties);
 
             // exclude inherited properties
-            $targetFields = array_filter($targetFields, static function ($field) use ($classReflection) {
-                return $classReflection->hasProperty($field) &&
-                    $classReflection->getProperty($field)->getDeclaringClass()->getName() == $classReflection->getName();
-            });
+            $targetFields = array_filter($targetFields, static fn ($field) => $classReflection->hasProperty($field) &&
+                $classReflection->getProperty($field)->getDeclaringClass()->getName() === $classReflection->getName());
         }
 
         return $targetFields;

diff --git a/src/Event/ConsoleErrorSubscriber.php b/src/Event/ConsoleErrorSubscriber.php
@@ -25,7 +25,7 @@
  */
 final class ConsoleErrorSubscriber implements EventSubscriberInterface
 {
-    private $setExitCode = false;
+    private bool $setExitCode = false;
 
     public function onConsoleError(ConsoleErrorEvent $event): void
     {

diff --git a/src/EventRegistry.php b/src/EventRegistry.php
@@ -43,7 +43,7 @@
 class EventRegistry
 {
     // list of *known* events to always include (if they exist)
-    private static $newEventsMap = [
+    private static array $newEventsMap = [
         'kernel.exception' => ExceptionEvent::class,
         'kernel.request' => RequestEvent::class,
         'kernel.response' => ResponseEvent::class,
@@ -53,7 +53,7 @@ class EventRegistry
         'kernel.terminate' => TerminateEvent::class,
     ];
 
-    private static $eventsMap = [
+    private static array $eventsMap = [
         'console.command' => ConsoleCommandEvent::class,
         'console.terminate' => ConsoleTerminateEvent::class,
         'console.error' => ConsoleErrorEvent::class,
@@ -71,12 +71,9 @@ class EventRegistry
         'security.switch_user' => SwitchUserEvent::class,
     ];
 
-    private $eventDispatcher;
-
-    public function __construct(EventDispatcherInterface $eventDispatcher)
-    {
-        $this->eventDispatcher = $eventDispatcher;
-
+    public function __construct(
+        private EventDispatcherInterface $eventDispatcher,
+    ) {
         // Loop through the new event classes
         foreach (self::$newEventsMap as $eventName => $newEventClass) {
             // Check if the new event classes exist, if so replace the old one with the new.