cycle · roxblnfk · Jan 5, 2024 · Sep 15, 2023 · Sep 18, 2023 · Nov 1, 2023
diff --git a/composer.json b/composer.json
@@ -8,7 +8,7 @@
     "require": {
         "php": ">=8.1",
         "cycle/orm": "^2.2.0",
-        "cycle/schema-builder": "^2.5.1",
+        "cycle/schema-builder": "^2.6",
         "spiral/attributes": "^2.8|^3.0",
         "spiral/tokenizer": "^2.8|^3.0",
         "doctrine/inflector": "^2.0"

diff --git a/src/Annotation/Column.php b/src/Annotation/Column.php
@@ -11,9 +11,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target({"PROPERTY", "ANNOTATION", "CLASS"})
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]

diff --git a/src/Annotation/Embeddable.php b/src/Annotation/Embeddable.php
@@ -9,9 +9,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("CLASS")
  */
 #[\Attribute(\Attribute::TARGET_CLASS), NamedArgumentConstructor]

diff --git a/src/Annotation/Entity.php b/src/Annotation/Entity.php
@@ -9,9 +9,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("CLASS")
  */
 #[\Attribute(\Attribute::TARGET_CLASS), NamedArgumentConstructor]
@@ -29,6 +27,7 @@ class Entity
      * @param non-empty-string|non-empty-string[]|null $typecast
      * @param class-string|null $scope Class name of constraint to be applied to every entity query.
      * @param Column[] $columns Entity columns.
+     * @param ForeignKey[] $foreignKeys Entity foreign keys.
      */
     public function __construct(
         protected ?string $role = null,
@@ -40,7 +39,8 @@ public function __construct(
         protected ?string $source = null,
         protected array|string|null $typecast = null,
         protected ?string $scope = null,
-        protected array $columns = []
+        protected array $columns = [],
+        protected array $foreignKeys = [],
     ) {
     }
 
@@ -113,6 +113,14 @@ public function getColumns(): array
         return $this->columns;
     }
 
+    /**
+     * @return ForeignKey[]
+     */
+    public function getForeignKeys(): array
+    {
+        return $this->foreignKeys;
+    }
+
     /**
      * @return non-empty-string|non-empty-string[]|null
      */

diff --git a/src/Annotation/ForeignKey.php b/src/Annotation/ForeignKey.php
@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cycle\Annotated\Annotation;
+
+use Doctrine\Common\Annotations\Annotation\Target;
+use JetBrains\PhpStorm\ExpectedValues;
+use Spiral\Attributes\NamedArgumentConstructor;
+
+/**
+ * @Annotation
+ * @NamedArgumentConstructor
+ * @Target({"PROPERTY", "ANNOTATION", "CLASS"})
+ */
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
+#[NamedArgumentConstructor]
+class ForeignKey
+{
+    /**
+     * @param non-empty-string $target Role or class name of the target entity.
+     * @param list<non-empty-string>|non-empty-string|null $innerKey You don't need to specify this if the attribute
+     *        is used on a property.
+     * @param list<non-empty-string>|non-empty-string|null $outerKey Outer key in the target entity.
+     *        Defaults to the primary key.
+     * @param 'CASCADE'|'NO ACTION'|'SET null' $action
+     * @param bool $indexCreate Note: MySQL and MSSQL might create an index for the foreign key automatically.
+     */
+    public function __construct(
+        public string $target,
+        public array|string|null $innerKey = null,
+        public array|string|null $outerKey = null,
+        /**
+         * @Enum({"NO ACTION", "CASCADE", "SET NULL"})
+         */
+        #[ExpectedValues(values: ['NO ACTION', 'CASCADE', 'SET NULL'])]
+        public string $action = 'CASCADE',
+        public bool $indexCreate = true,
+    ) {
+    }
+}
diff --git a/src/Annotation/Inheritance/DiscriminatorColumn.php b/src/Annotation/Inheritance/DiscriminatorColumn.php
@@ -8,9 +8,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("CLASS")
  */
 #[\Attribute(\Attribute::TARGET_CLASS), NamedArgumentConstructor]

diff --git a/src/Annotation/Inheritance/JoinedTable.php b/src/Annotation/Inheritance/JoinedTable.php
@@ -10,9 +10,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("CLASS")
  */
 #[\Attribute(\Attribute::TARGET_CLASS), NamedArgumentConstructor]

diff --git a/src/Annotation/Inheritance/SingleTable.php b/src/Annotation/Inheritance/SingleTable.php
@@ -9,9 +9,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("CLASS")
  */
 #[\Attribute(\Attribute::TARGET_CLASS), NamedArgumentConstructor]

diff --git a/src/Annotation/Relation/BelongsTo.php b/src/Annotation/Relation/BelongsTo.php
@@ -11,9 +11,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("PROPERTY")
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY), NamedArgumentConstructor]

diff --git a/src/Annotation/Relation/Embedded.php b/src/Annotation/Relation/Embedded.php
@@ -9,9 +9,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("PROPERTY")
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY), NamedArgumentConstructor]

diff --git a/src/Annotation/Relation/HasMany.php b/src/Annotation/Relation/HasMany.php
@@ -10,9 +10,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("PROPERTY")
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY), NamedArgumentConstructor]

diff --git a/src/Annotation/Relation/HasOne.php b/src/Annotation/Relation/HasOne.php
@@ -11,9 +11,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("PROPERTY")
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY), NamedArgumentConstructor]

diff --git a/src/Annotation/Relation/Inverse.php b/src/Annotation/Relation/Inverse.php
@@ -11,9 +11,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target({"PROPERTY", "ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY), NamedArgumentConstructor]

diff --git a/src/Annotation/Relation/ManyToMany.php b/src/Annotation/Relation/ManyToMany.php
@@ -11,9 +11,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("PROPERTY")
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY), NamedArgumentConstructor]

diff --git a/src/Annotation/Relation/Morphed/BelongsToMorphed.php b/src/Annotation/Relation/Morphed/BelongsToMorphed.php
@@ -13,9 +13,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("PROPERTY")
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY), NamedArgumentConstructor]

diff --git a/src/Annotation/Relation/Morphed/MorphedHasMany.php b/src/Annotation/Relation/Morphed/MorphedHasMany.php
@@ -12,9 +12,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("PROPERTY")
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY), NamedArgumentConstructor]

diff --git a/src/Annotation/Relation/Morphed/MorphedHasOne.php b/src/Annotation/Relation/Morphed/MorphedHasOne.php
@@ -12,9 +12,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("PROPERTY")
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY), NamedArgumentConstructor]

diff --git a/src/Annotation/Relation/RefersTo.php b/src/Annotation/Relation/RefersTo.php
@@ -11,9 +11,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("PROPERTY")
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY), NamedArgumentConstructor]

diff --git a/src/Annotation/Table.php b/src/Annotation/Table.php
@@ -11,9 +11,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target({"CLASS", "ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_CLASS), NamedArgumentConstructor]

diff --git a/src/Annotation/Table/Index.php b/src/Annotation/Table/Index.php
@@ -9,9 +9,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("ANNOTATION", "CLASS")
  */
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE), NamedArgumentConstructor]

diff --git a/src/Annotation/Table/PrimaryKey.php b/src/Annotation/Table/PrimaryKey.php
@@ -9,9 +9,7 @@
 
 /**
  * @Annotation
- *
  * @NamedArgumentConstructor
- *
  * @Target("ANNOTATION", "CLASS")
  */
 #[\Attribute(\Attribute::TARGET_CLASS), NamedArgumentConstructor]