ENGCOM-7016: Add support for char element to dto factory #22442

Author: slavvka

app/etc/di.xml

@@ -1445,6 +1445,7 @@
                 <item name="mediumtext" xsi:type="object">\Magento\Framework\Setup\Declaration\Schema\Dto\Factories\MediumText</item>
                 <item name="text" xsi:type="object">\Magento\Framework\Setup\Declaration\Schema\Dto\Factories\Text</item>
                 <item name="varchar" xsi:type="object">\Magento\Framework\Setup\Declaration\Schema\Dto\Factories\StringBinary</item>
+                <item name="char" xsi:type="object">\Magento\Framework\Setup\Declaration\Schema\Dto\Factories\StringBinary</item>
                 <item name="varbinary" xsi:type="object">\Magento\Framework\Setup\Declaration\Schema\Dto\Factories\StringBinary</item>
                 <item name="blob" xsi:type="object">\Magento\Framework\Setup\Declaration\Schema\Dto\Factories\Blob</item>
                 <item name="mediumblob" xsi:type="object">\Magento\Framework\Setup\Declaration\Schema\Dto\Factories\MediumBlob</item>
@@ -1592,6 +1593,7 @@
                 <item name="longblog" xsi:type="object">Magento\Framework\Setup\SchemaListenerDefinition\TextBlobDefinition</item>
                 <item name="varbinary" xsi:type="object">Magento\Framework\Setup\SchemaListenerDefinition\TextBlobDefinition</item>
                 <item name="varchar" xsi:type="object">Magento\Framework\Setup\SchemaListenerDefinition\TextBlobDefinition</item>
+                <item name="char" xsi:type="object">Magento\Framework\Setup\SchemaListenerDefinition\CharDefinition</item>
                 <item name="timestamp" xsi:type="object">Magento\Framework\Setup\SchemaListenerDefinition\TimestampDefinition</item>
                 <item name="datetime" xsi:type="object">Magento\Framework\Setup\SchemaListenerDefinition\TimestampDefinition</item>
                 <item name="date" xsi:type="object">Magento\Framework\Setup\SchemaListenerDefinition\DateDefinition</item>

dev/tests/setup-integration/_files/Magento/TestSetupDeclarationModule1/etc/db_schema.xml

@@ -48,6 +48,7 @@
         <column xsi:type="longtext" name="longtext"/>
         <column xsi:type="mediumtext" name="mediumtext"/>
         <column xsi:type="varchar" name="varchar" length="254" nullable="true"/>
+        <column xsi:type="char" name="char" length="255" nullable="true"/>
         <column xsi:type="mediumblob" name="mediumblob"/>
         <column xsi:type="blob" name="blob"/>
         <column xsi:type="boolean" name="boolean"/>

dev/tests/setup-integration/_files/Magento/TestSetupDeclarationModule1/fixture/declarative_installer/column_modification.php

@@ -36,6 +36,7 @@
   `longtext` longtext,
   `mediumtext` mediumtext,
   `varchar` varchar(100) DEFAULT NULL,
+  `char` char(255) DEFAULT NULL,
   `mediumblob` mediumblob,
   `blob` blob,
   `boolean` tinyint(1) DEFAULT \'1\',

dev/tests/setup-integration/_files/Magento/TestSetupDeclarationModule1/fixture/declarative_installer/constraint_modification.php

@@ -38,6 +38,7 @@
   `longtext` longtext,
   `mediumtext` mediumtext,
   `varchar` varchar(254) DEFAULT NULL,
+  `char` char(255) DEFAULT NULL,
   `mediumblob` mediumblob,
   `blob` blob,
   `boolean` tinyint(1) DEFAULT NULL,

dev/tests/setup-integration/_files/Magento/TestSetupDeclarationModule1/fixture/dry_run_log.php

@@ -38,6 +38,7 @@
 `longtext` longtext NULL , 
 `mediumtext` mediumtext NULL , 
 `varchar` varchar(254) NULL  , 
+`char` char(255) NULL  , 
 `mediumblob` mediumblob NULL , 
 `blob` blob NULL , 
 `boolean` BOOLEAN NULL  , 

dev/tests/setup-integration/_files/Magento/TestSetupDeclarationModule1/fixture/valid_xml_revision_1.php

@@ -199,6 +199,12 @@
                     'type' => 'mediumtext',
                     'name' => 'mediumtext',
                 ],
+                'char' => [
+                    'type' => 'char',
+                    'name' => 'char',
+                    'length' => '255',
+                    'nullable' => 'true',
+                ],
                 'varchar' => [
                     'type' => 'varchar',
                     'name' => 'varchar',

lib/internal/Magento/Framework/Setup/Declaration/Schema/Dto/Columns/StringBinary.php

@@ -11,7 +11,7 @@
 
 /**
  * String or Binary column.
- * Declared in SQL, like VARCHAR(L), BINARY(L)
+ * Declared in SQL, like CHAR(L), VARCHAR(L), BINARY(L)
  * where L - length.
  */
 class StringBinary extends Column implements
@@ -73,10 +73,9 @@ public function isNullable()
     }
 
     /**
-     * Return default value.
-     * Note: default value should be string.
+     * Return default value, Note: default value should be string.
      *
-     * @return string | null
+     * @return string|null
      */
     public function getDefault()
     {

lib/internal/Magento/Framework/Setup/Declaration/Schema/etc/schema.xsd

@@ -20,6 +20,7 @@
     <xs:include schemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/types/texts/longtext.xsd" />
     <xs:include schemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/types/texts/mediumtext.xsd" />
     <xs:include schemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/types/texts/varchar.xsd" />
+    <xs:include schemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/types/texts/char.xsd" />
     <xs:include schemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/types/texts/json.xsd" />
     <xs:include schemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/types/binaries/blob.xsd" />
     <xs:include schemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/types/binaries/mediumblob.xsd" />

lib/internal/Magento/Framework/Setup/Declaration/Schema/etc/types/texts/char.xsd

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
+    <xs:include schemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/types/column.xsd"/>
+
+    <xs:complexType name="char">
+        <xs:complexContent>
+            <xs:extension base="abstractColumnType">
+                <xs:annotation>
+                    <xs:documentation>
+                        Here plain text can be persisted without trailing spaces. Length of this field can't be more than 255 characters
+                        When CHAR values are retrieved, trailing spaces are removed unless the PAD_CHAR_TO_FULL_LENGTH SQL mode is enabled.
+                    </xs:documentation>
+                </xs:annotation>
+
+                <xs:attribute name="length">
+                    <xs:simpleType>
+                        <xs:restriction base="xs:integer">
+                            <xs:maxInclusive value="255"/>
+                        </xs:restriction>
+                    </xs:simpleType>
+                </xs:attribute>
+                <xs:attribute name="default" type="xs:string" />
+                <xs:attribute name="nullable" type="xs:boolean" />
+            </xs:extension>
+        </xs:complexContent>
+    </xs:complexType>
+</xs:schema>

lib/internal/Magento/Framework/Setup/SchemaListenerDefinition/CharDefinition.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\Setup\SchemaListenerDefinition;
+
+/**
+ * Char type definition.
+ */
+class CharDefinition implements DefinitionConverterInterface
+{
+    private const DEFAULT_TEXT_LENGTH = 255;
+
+    /**
+     * @inheritdoc
+     */
+    public function convertToDefinition(array $definition)
+    {
+        return [
+            'xsi:type' => $definition['type'],
+            'name' => $definition['name'],
+            'length' => $definition['length'] ?? self::DEFAULT_TEXT_LENGTH,
+            'default' => isset($definition['default']) ? (bool) $definition['default'] : null,
+            'nullable' => $definition['nullable'] ?? true,
+        ];
+    }
+}