better typing

Author: jrushlow

src/FileManager.php

@@ -15,7 +15,6 @@
 use Symfony\Bundle\MakerBundle\Util\MakerFileLinkFormatter;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Filesystem\Filesystem;
-use Symfony\Component\Finder\Finder;
 
 /**
  * @author Javier Eguiluz <[email protected]>

src/Generator.php

@@ -23,26 +23,23 @@
  */
 class Generator
 {
-    private $fileManager;
-    private $twigHelper;
-    private $pendingOperations = [];
-    private $namespacePrefix;
-    private $phpCompatUtil;
-    private $templateComponentGenerator;
-
-    public function __construct(FileManager $fileManager, string $namespacePrefix, PhpCompatUtil $phpCompatUtil = null, TemplateComponentGenerator $templateComponentGenerator = null)
-    {
-        $this->fileManager = $fileManager;
+    private GeneratorTwigHelper $twigHelper;
+    private array $pendingOperations = [];
+    private ?TemplateComponentGenerator $templateComponentGenerator;
+
+    public function __construct(
+        private FileManager $fileManager,
+        private string $namespacePrefix,
+        PhpCompatUtil $phpCompatUtil = null,
+        TemplateComponentGenerator $templateComponentGenerator = null,
+    ) {
         $this->twigHelper = new GeneratorTwigHelper($fileManager);
         $this->namespacePrefix = trim($namespacePrefix, '\\');
 
         if (null === $phpCompatUtil) {
-            $phpCompatUtil = new PhpCompatUtil($fileManager);
-
-            trigger_deprecation('symfony/maker-bundle', '1.25', 'Initializing Generator without providing an instance of PhpCompatUtil is deprecated.');
+            trigger_deprecation('symfony/maker-bundle', '1.25', 'Initializing Generator while providing an instance of PhpCompatUtil is deprecated.');
         }
 
-        $this->phpCompatUtil = $phpCompatUtil;
         $this->templateComponentGenerator = $templateComponentGenerator;
     }
 
@@ -151,7 +148,7 @@ public function createClassNameDetails(string $name, string $namespacePrefix, st
 
         // if this is a custom class, we may be completely different than the namespace prefix
         // the best way can do, is find the PSR4 prefix and use that
-        if (0 !== strpos($className, $fullNamespacePrefix)) {
+        if (!str_starts_with($className, $fullNamespacePrefix)) {
             $fullNamespacePrefix = $this->fileManager->getNamespacePrefixForClass($className);
         }
 
@@ -163,7 +160,7 @@ public function getRootDirectory(): string
         return $this->fileManager->getRootDirectory();
     }
 
-    private function addOperation(string $targetPath, string $templateName, array $variables)
+    private function addOperation(string $targetPath, string $templateName, array $variables): void
     {
         if ($this->fileManager->fileExists($targetPath)) {
             throw new RuntimeCommandException(sprintf('The file "%s" can\'t be generated because it already exists.', $this->fileManager->relativizePath($targetPath)));
@@ -193,6 +190,8 @@ public function hasPendingOperations(): bool
 
     /**
      * Actually writes and file changes that are pending.
+     *
+     * @return void
      */
     public function writeChanges()
     {
@@ -231,6 +230,8 @@ public function generateController(string $controllerClassName, string $controll
 
     /**
      * Generate a template file.
+     *
+     * @return void
      */
     public function generateTemplate(string $targetPath, string $templateName, array $variables = [])
     {

src/GeneratorTwigHelper.php

@@ -16,16 +16,14 @@
  */
 final class GeneratorTwigHelper
 {
-    private $fileManager;
-
-    public function __construct(FileManager $fileManager)
-    {
-        $this->fileManager = $fileManager;
+    public function __construct(
+        private FileManager $fileManager,
+    ) {
     }
 
     public function getEntityFieldPrintCode($entity, $field): string
     {
-        $twigField = preg_replace_callback('/(?!^)_([a-z0-9])/', function ($s) {
+        $twigField = preg_replace_callback('/(?!^)_([a-z0-9])/', static function ($s) {
             return strtoupper($s[1]);
         }, $field['fieldName']);
         $printCode = $entity.'.'.str_replace('_', '', $twigField);

src/InputConfiguration.php

@@ -13,7 +13,7 @@
 
 final class InputConfiguration
 {
-    private $nonInteractiveArguments = [];
+    private array $nonInteractiveArguments = [];
 
     /**
      * Call in MakerInterface::configureCommand() to disable the automatic interactive

src/Str.php

@@ -21,8 +21,7 @@
  */
 final class Str
 {
-    /** @var Inflector|null */
-    private static $inflector;
+    private static ?Inflector $inflector = null;
 
     /**
      * Looks for suffixes in strings in a case-insensitive way.
@@ -203,6 +202,9 @@ public static function isValidPhpVariableName($name)
         return (bool) preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $name, $matches);
     }
 
+    /**
+     * @return bool
+     */
     public static function areClassesAlphabetical(string $class1, string $class2)
     {
         $arr1 = [$class1, $class2];

src/Validator.php

@@ -146,20 +146,17 @@ public static function validateBoolean($value)
         return $valueAsBool;
     }
 
-    public static function validatePropertyName(string $name)
+    public static function validatePropertyName(string $name): string
     {
         // check for valid PHP variable name
-        if (null !== $name && !Str::isValidPhpVariableName($name)) {
+        if (!Str::isValidPhpVariableName($name)) {
             throw new \InvalidArgumentException(sprintf('"%s" is not a valid PHP property name.', $name));
         }
 
         return $name;
     }
 
-    /**
-     * @param ManagerRegistry|LegacyManagerRegistry $registry
-     */
-    public static function validateDoctrineFieldName(string $name, $registry)
+    public static function validateDoctrineFieldName(string $name, ManagerRegistry|LegacyManagerRegistry $registry): string
     {
         if (!$registry instanceof ManagerRegistry && !$registry instanceof LegacyManagerRegistry) {
             throw new \InvalidArgumentException(sprintf('Argument 2 to %s::validateDoctrineFieldName must be an instance of %s, %s passed.', __CLASS__, ManagerRegistry::class, \is_object($registry) ? \get_class($registry) : \gettype($registry)));
@@ -184,12 +181,12 @@ public static function validateEmailAddress(?string $email): string
         return $email;
     }
 
-    public static function existsOrNull(string $className = null, array $entities = [])
+    public static function existsOrNull(?string $className = null, array $entities = []): ?string
     {
         if (null !== $className) {
             self::validateClassName($className);
 
-            if (0 === strpos($className, '\\')) {
+            if (str_starts_with($className, '\\')) {
                 self::classExists($className);
             } else {
                 self::entityExists($className, $entities);
@@ -220,7 +217,7 @@ public static function entityExists(string $className = null, array $entities =
             throw new RuntimeCommandException('There are no registered entities; please create an entity before using this command.');
         }
 
-        if (0 === strpos($className, '\\')) {
+        if (str_starts_with($className, '\\')) {
             self::classExists($className, sprintf('Entity "%s" doesn\'t exist; please enter an existing one or create a new one.', $className));
         }