Merge pull request #12563 from garak/defaultStringSchemaLength

Make default string length configurable in SchemaTool

Author: greg0ire

docs/en/reference/advanced-configuration.rst

@@ -232,6 +232,24 @@ For development you should use an array cache like
 ``Symfony\Component\Cache\Adapter\ArrayAdapter``
 which only caches data on a per-request basis.
 
+Default String Type Schema Length (**OPTIONAL**)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: php
+
+    <?php
+    $config->setDefaultStringTypeSchemaLength(191);
+    $config->getDefaultStringTypeSchemaLength();
+
+Gets or sets the default length used by the SchemaTool for string columns that
+have no explicit ``length`` value in the mapping. This is used when the schema is
+created from metadata and when discriminator columns are generated for single-table
+inheritance.
+
+The default value is ``255``. Setting it explicitly is useful for platforms or
+storage layouts that require shorter default string lengths, for example MySQL
+``utf8mb4`` schemas that often use ``191`` for indexed varchar columns.
+
 Query Cache (**RECOMMENDED**)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

src/Configuration.php

@@ -723,4 +723,14 @@ public function getEagerFetchBatchSize(): int
     {
         return $this->attributes['fetchModeSubselectBatchSize'] ?? 100;
     }
+
+    public function setDefaultStringTypeSchemaLength(int $length): void
+    {
+        $this->attributes['defaultStringTypeSchemaLength'] = $length;
+    }
+
+    public function getDefaultStringTypeSchemaLength(): int
+    {
+        return $this->attributes['defaultStringTypeSchemaLength'] ?? 255;
+    }
 }

src/Tools/SchemaTool.php

@@ -567,7 +567,7 @@ private function addDiscriminatorColumnDefinition(ClassMetadata $class, Table $t
 
         if (strtolower($discrColumn->type) === 'string' && ! isset($discrColumn->length)) {
             $discrColumn->type   = 'string';
-            $discrColumn->length = 255;
+            $discrColumn->length = $this->em->getConfiguration()->getDefaultStringTypeSchemaLength();
         }
 
         $options = [
@@ -623,7 +623,7 @@ private function gatherColumn(
         $options['platformOptions']['version'] = $class->isVersioned && $class->versionField === $mapping->fieldName;
 
         if (strtolower($columnType) === 'string' && $options['length'] === null) {
-            $options['length'] = 255;
+            $options['length'] = $this->em->getConfiguration()->getDefaultStringTypeSchemaLength();
         }
 
         if (isset($mapping->precision)) {

tests/Tests/ORM/Tools/SchemaToolTest.php

@@ -278,6 +278,64 @@ public function testSetDiscriminatorColumnWithoutLength(): void
         self::assertEquals(255, $column->getLength());
     }
 
+    public function testSetDefaultStringLength(): void
+    {
+        $em = $this->getTestEntityManager();
+        $em->getConfiguration()->setDefaultStringTypeSchemaLength(191);
+        $schemaTool = new SchemaTool($em);
+        $metadata   = $em->getClassMetadata(FirstEntity::class);
+
+        $schema = $schemaTool->getSchemaFromMetadata([$metadata]);
+
+        self::assertTrue($schema->hasTable('first_entity'));
+        $table = $schema->getTable('first_entity');
+
+        self::assertTrue($table->hasColumn('name'));
+        $column = $table->getColumn('name');
+
+        self::assertEquals(191, $column->getLength());
+    }
+
+    public function testSetDefaultStringLengthDoesNotOverrideExplicitLength(): void
+    {
+        $em = $this->getTestEntityManager();
+        $em->getConfiguration()->setDefaultStringTypeSchemaLength(191);
+        $schemaTool                              = new SchemaTool($em);
+        $metadata                                = $em->getClassMetadata(FirstEntity::class);
+        $metadata->fieldMappings['name']->length = 32;
+
+        $schema = $schemaTool->getSchemaFromMetadata([$metadata]);
+
+        self::assertTrue($schema->hasTable('first_entity'));
+        $table = $schema->getTable('first_entity');
+
+        self::assertTrue($table->hasColumn('name'));
+        $column = $table->getColumn('name');
+
+        self::assertEquals(32, $column->getLength());
+    }
+
+    public function testSetDiscriminatorColumnWithCustomDefaultLength(): void
+    {
+        $em = $this->getTestEntityManager();
+        $em->getConfiguration()->setDefaultStringTypeSchemaLength(191);
+        $schemaTool = new SchemaTool($em);
+        $metadata   = $em->getClassMetadata(FirstEntity::class);
+
+        $metadata->setInheritanceType(ClassMetadata::INHERITANCE_TYPE_SINGLE_TABLE);
+        $metadata->setDiscriminatorColumn(['name' => 'discriminator', 'type' => 'string']);
+
+        $schema = $schemaTool->getSchemaFromMetadata([$metadata]);
+
+        self::assertTrue($schema->hasTable('first_entity'));
+        $table = $schema->getTable('first_entity');
+
+        self::assertTrue($table->hasColumn('discriminator'));
+        $column = $table->getColumn('discriminator');
+
+        self::assertEquals(191, $column->getLength());
+    }
+
     public function testSetDiscriminatorColumnWithEnumType(): void
     {
         if (! class_exists(EnumType::class)) {