Add index mapping to Column

Adds a new option to Column mapping to add indexes to class fields
directly instead of having to use the Index() class attribute.
This allows users to define indexes in traits
where access to the class isn't available.
Fixes #11982

Author: jannes-io

docs/en/reference/attributes-reference.rst

@@ -175,6 +175,10 @@ Optional parameters:
 -  **unique**: Boolean value to determine if the value of the column
    should be unique across all rows of the underlying entities table.
 
+-  **index**: Boolean value to generate an index for this column.
+   For more advanced usages, take a look at :ref:`#[Index] <attrref_index>`.
+   If not specified, default value is ``false``.
+
 -  **nullable**: Determines if NULL values allowed for this column.
     If not specified, default value is ``false``.
 
@@ -245,6 +249,9 @@ Examples:
     #[Column(type: "string", length: 32, unique: true, nullable: false)]
     protected $username;
 
+    #[Column(type: "string", index: true)]
+    protected $firstName;
+
     #[Column(type: "string", columnDefinition: "CHAR(2) NOT NULL")]
     protected $country;
 

docs/en/reference/php-mapping.rst

@@ -209,6 +209,7 @@ Field & Association Getters
 
 -  ``isUniqueField($fieldName)``
 -  ``isNullable($fieldName)``
+-  ``isIndexed($fieldName)``
 -  ``getColumnName($fieldName)``
 -  ``getFieldMapping($fieldName)``
 -  ``getAssociationMapping($fieldName)``

docs/en/reference/xml-mapping.rst

@@ -112,7 +112,6 @@ of several common elements:
 
             <indexes>
                 <index name="name_idx" columns="name"/>
-                <index columns="user_email"/>
             </indexes>
 
             <unique-constraints>
@@ -131,7 +130,7 @@ of several common elements:
             </id>
 
             <field name="name" column="name" type="string" length="50" nullable="true" unique="true" />
-            <field name="email" column="user_email" type="string" column-definition="CHAR(32) NOT NULL" />
+            <field name="email" column="user_email" type="string" index="true" column-definition="CHAR(32) NOT NULL" />
 
             <one-to-one field="address" target-entity="Address" inversed-by="user">
                 <cascade><cascade-remove /></cascade>
@@ -255,6 +254,8 @@ Optional attributes:
    only.
 -  unique - Should this field contain a unique value across the
    table? Defaults to false.
+-  index - Should an index be created for this column? Defaults to
+   false.
 -  nullable - Should this field allow NULL as a value? Defaults to
    false.
 -  insertable - Should this field be inserted? Defaults to true.

doctrine-mapping.xsd

@@ -243,6 +243,7 @@
     <xs:attribute name="length" type="xs:NMTOKEN" />
     <xs:attribute name="unique" type="xs:boolean" default="false" />
     <xs:attribute name="nullable" type="xs:boolean" default="false" />
+    <xs:attribute name="index" type="xs:boolean" default="false" />
     <xs:attribute name="insertable" type="xs:boolean" default="true" />
     <xs:attribute name="updatable" type="xs:boolean" default="true" />
     <xs:attribute name="generated" type="orm:generated-type" default="NEVER" />

src/Mapping/Builder/FieldBuilder.php

@@ -64,6 +64,18 @@ public function unique(bool $flag = true): static
         return $this;
     }
 
+    /**
+     * Sets indexed.
+     *
+     * @return $this
+     */
+    public function index(bool $flag = true): static
+    {
+        $this->mapping['index'] = $flag;
+
+        return $this;
+    }
+
     /**
      * Sets column name.
      *

src/Mapping/ClassMetadata.php

@@ -1056,6 +1056,13 @@ public function isNullable(string $fieldName): bool
         return $mapping !== false && isset($mapping->nullable) && $mapping->nullable;
     }
 
+    public function isIndexed(string $fieldName): bool
+    {
+        $mapping = $this->getFieldMapping($fieldName);
+
+        return isset($mapping->index) && $mapping->index;
+    }
+
     /**
      * Gets a column name for a field name.
      * If the column name for the field cannot be found, the given field name

src/Mapping/Column.php

@@ -31,6 +31,7 @@ public function __construct(
         public readonly array $options = [],
         public readonly string|null $columnDefinition = null,
         public readonly string|null $generated = null,
+        public readonly bool $index = false,
     ) {
     }
 }

src/Mapping/Driver/AttributeDriver.php

@@ -710,6 +710,7 @@ private function joinColumnToArray(Mapping\JoinColumn|Mapping\InverseJoinColumn
      *                   length: int,
      *                   unique: bool,
      *                   nullable: bool,
+     *                   index: bool,
      *                   precision: int,
      *                   enumType?: class-string,
      *                   options?: mixed[],
@@ -726,6 +727,7 @@ private function columnToArray(string $fieldName, Mapping\Column $column): array
             'length'    => $column->length,
             'unique'    => $column->unique,
             'nullable'  => $column->nullable,
+            'index'     => $column->index,
             'precision' => $column->precision,
         ];
 

src/Mapping/Driver/XmlDriver.php

@@ -754,6 +754,7 @@ private function joinColumnToArray(SimpleXMLElement $joinColumnElement): array
       *                   scale?: int,
       *                   unique?: bool,
       *                   nullable?: bool,
+      *                   index?: bool,
       *                   notInsertable?: bool,
       *                   notUpdatable?: bool,
       *                   enumType?: string,
@@ -792,6 +793,10 @@ private function columnToArray(SimpleXMLElement $fieldMapping): array
             $mapping['unique'] = $this->evaluateBoolean($fieldMapping['unique']);
         }
 
+        if (isset($fieldMapping['index'])) {
+            $mapping['index'] = $this->evaluateBoolean($fieldMapping['index']);
+        }
+
         if (isset($fieldMapping['nullable'])) {
             $mapping['nullable'] = $this->evaluateBoolean($fieldMapping['nullable']);
         }

src/Mapping/FieldMapping.php

@@ -42,6 +42,8 @@ final class FieldMapping implements ArrayAccess
     public int|null $scale = null;
     /** Whether a unique constraint should be generated for the column. */
     public bool|null $unique = null;
+    /** Whether an index should be generated for the column. */
+    public bool|null $index = null;
     /**
      * @var class-string|null This is set when the field is inherited by this
      * class from another (inheritance) parent <em>entity</em> class. The value
@@ -93,6 +95,7 @@ public function __construct(
      *     length?: int|null,
      *     id?: bool|null,
      *     nullable?: bool|null,
+     *     index?: bool|null,
      *     notInsertable?: bool|null,
      *     notUpdatable?: bool|null,
      *     columnDefinition?: string|null,