Add AbstractActiveRecord::relationQuery() default method (#323)

Tigrov · web-flow · commit 107cd3012eed · 2024-05-20T14:02:15.000+07:00
diff --git a/src/AbstractActiveRecord.php b/src/AbstractActiveRecord.php
@@ -549,6 +549,31 @@ public function relation(string $name): ActiveRecordInterface|array|null
         return $this->retrieveRelation($name);
     }
 
+    /**
+     * @inheritdoc
+     *
+     * Relations can be defined using {@see hasOne()} and {@see hasMany()} methods. For example:
+     *
+     * ```php
+     * public function relationQuery(string $name): ActiveQueryInterface
+     * {
+     *     return match ($name) {
+     *         'orders' => $this->hasMany(Order::class, ['customer_id' => 'id']),
+     *         'country' => $this->hasOne(Country::class, ['id' => 'country_id']),
+     *         default => parent::relationQuery($name),
+     *     };
+     * }
+     * ```
+     */
+    public function relationQuery(string $name, bool $throwException = true): ActiveQueryInterface|null
+    {
+        if (!$throwException) {
+            return null;
+        }
+
+        throw new InvalidArgumentException(static::class . ' has no relation named "' . $name . '".');
+    }
+
     public function resetRelation(string $name): void
     {
         foreach ($this->relationsDependencies as &$relationNames) {
