vendor/doctrine/orm/src/Mapping/Column.php line 17

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Mapping;
  7. use Attribute;
  8. use BackedEnum;
  9. use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
  11. /**
  12.  * @Annotation
  13.  * @NamedArgumentConstructor
  14.  * @Target({"PROPERTY","ANNOTATION"})
  15.  */
  16. #[Attribute(Attribute::TARGET_PROPERTY)]
  17. final class Column implements MappingAttribute
  18. {
  19.     /**
  20.      * @var string|null
  21.      * @readonly
  22.      */
  23.     public $name;
  25.     /**
  26.      * @var mixed
  27.      * @readonly
  28.      */
  29.     public $type;
  31.     /**
  32.      * @var int|null
  33.      * @readonly
  34.      */
  35.     public $length;
  37.     /**
  38.      * The precision for a decimal (exact numeric) column (Applies only for decimal column).
  39.      *
  40.      * @var int|null
  41.      * @readonly
  42.      */
  43.     public $precision = 0;
  45.     /**
  46.      * The scale for a decimal (exact numeric) column (Applies only for decimal column).
  47.      *
  48.      * @var int|null
  49.      * @readonly
  50.      */
  51.     public $scale = 0;
  53.     /**
  54.      * @var bool
  55.      * @readonly
  56.      */
  57.     public $unique = false;
  59.     /**
  60.      * @var bool
  61.      * @readonly
  62.      */
  63.     public $nullable = false;
  65.     /**
  66.      * @var bool
  67.      * @readonly
  68.      */
  69.     public $insertable = true;
  71.     /**
  72.      * @var bool
  73.      * @readonly
  74.      */
  75.     public $updatable = true;
  77.     /**
  78.      * @var class-string<BackedEnum>|null
  79.      * @readonly
  80.      */
  81.     public $enumType = null;
  83.     /**
  84.      * @var array<string,mixed>
  85.      * @readonly
  86.      */
  87.     public $options = [];
  89.     /**
  90.      * @var string|null
  91.      * @readonly
  92.      */
  93.     public $columnDefinition;
  95.     /**
  96.      * @var string|null
  97.      * @readonly
  98.      * @phpstan-var 'NEVER'|'INSERT'|'ALWAYS'|null
  99.      * @Enum({"NEVER", "INSERT", "ALWAYS"})
  100.      */
  101.     public $generated;
  103.     /**
  104.      * @param class-string<BackedEnum>|null $enumType
  105.      * @param array<string,mixed>           $options
  106.      * @phpstan-param 'NEVER'|'INSERT'|'ALWAYS'|null $generated
  107.      */
  108.     public function __construct(
  109.         ?string $name = null,
  110.         ?string $type = null,
  111.         ?int $length = null,
  112.         ?int $precision = null,
  113.         ?int $scale = null,
  114.         bool $unique = false,
  115.         bool $nullable = false,
  116.         bool $insertable = true,
  117.         bool $updatable = true,
  118.         ?string $enumType = null,
  119.         array $options = [],
  120.         ?string $columnDefinition = null,
  121.         ?string $generated = null
  122.     ) {
  123.         $this->name             = $name;
  124.         $this->type             = $type;
  125.         $this->length           = $length;
  126.         $this->precision        = $precision;
  127.         $this->scale            = $scale;
  128.         $this->unique           = $unique;
  129.         $this->nullable         = $nullable;
  130.         $this->insertable       = $insertable;
  131.         $this->updatable        = $updatable;
  132.         $this->enumType         = $enumType;
  133.         $this->options          = $options;
  134.         $this->columnDefinition = $columnDefinition;
  135.         $this->generated        = $generated;
  136.     }
  137. }