Add source of column information

CHANGELOG.md

@@ -180,6 +180,7 @@
 - Bug #1109: Fix column definition parsing in cases with brackets and escaped quotes (@vjik)
 - New #1107: Add abstract enumeration column type (@vjik)
 - Bug #1115: Do not reset `$retryHandler` property on `AbstractCommand::reset()` method call (@Tigrov)
+- New #1124: Add source of column information (@Tigrov)
 
 ## 1.3.0 March 21, 2024
 

src/Constant/ColumnInfoSource.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Yiisoft\Db\Constant;
+
+use Yiisoft\Db\Schema\Column\ColumnFactoryInterface;
+
+/**
+ * Defines the possible sources of column information.
+ *
+ * It can be used in `ColumnFactoryInterface` instances when creating column objects.
+ *
+ * @see ColumnFactoryInterface
+ */
+final class ColumnInfoSource
+{
+    /**
+     * @var string Used to indicate that column information is taken from the column definition.
+     */
+    public const DEFINITION = 'definition';
+
+    /**
+     * @var string Used to indicate that column information is taken from the database table schema.
+     */
+    public const TABLE_SCHEMA = 'table_schema';
+
+    /**
+     * @var string Used to indicate that column information is taken from the query result.
+     */
+    public const QUERY_RESULT = 'query_result';
+}

src/Schema/Column/AbstractColumnFactory.php

@@ -5,6 +5,7 @@
 namespace Yiisoft\Db\Schema\Column;
 
 use Closure;
+use Yiisoft\Db\Constant\ColumnInfoSource;
 use Yiisoft\Db\Constant\ColumnType;
 use Yiisoft\Db\Constant\PseudoType;
 use Yiisoft\Db\Expression\Expression;
@@ -142,6 +143,7 @@ public function fromDefinition(string $definition, array $info = []): ColumnInte
         unset($definitionInfo['type']);
 
         $info = array_merge($info, $definitionInfo);
+        $info['source'] ??= ColumnInfoSource::DEFINITION;
 
         if ($this->isDbType($type)) {
             return $this->fromDbType($type, $info);

src/Schema/Column/ColumnFactoryInterface.php

@@ -4,6 +4,7 @@
 
 namespace Yiisoft\Db\Schema\Column;
 
+use Yiisoft\Db\Constant\ColumnInfoSource;
 use Yiisoft\Db\Constant\ColumnType;
 use Yiisoft\Db\Constant\PseudoType;
 use Yiisoft\Db\Constraint\ForeignKey;
@@ -26,14 +27,14 @@
  *     defaultValueRaw?: string|null,
  *     dimension?: positive-int,
  *     extra?: string|null,
- *     fromResult?: bool,
  *     primaryKey?: bool,
  *     name?: string|null,
  *     notNull?: bool,
  *     reference?: ForeignKey|null,
  *     scale?: int|null,
  *     schema?: string|null,
  *     size?: int|null,
+ *     source?: ColumnInfoSource::*,
  *     table?: string|null,
  *     type?: ColumnType::*,
  *     unique?: bool,