From 224a69a10fa9c8533f31554baa0ada2a7581e5e3 Mon Sep 17 00:00:00 2001
From: Aleksei Lebedev <1329824+LastDragon-ru@users.noreply.github.com>
Date: Thu, 14 Mar 2024 13:31:29 +0400
Subject: [PATCH] deprecate(graphql):
 `*:getDirectiveLocations()`/`*:getLocations()`, please use `*::locations()`
 instead.

---
 .../Directives/ExtendOperatorsDirective.php    | 18 +++++++++++++++---
 .../Builder/Directives/IgnoredDirective.php    | 18 +++++++++++++++---
 .../Builder/Directives/OperatorDirective.php   | 17 ++++++++++++++---
 .../Builder/Directives/OperatorsDirective.php  |  2 +-
 .../graphql/src/SearchBy/Operators/Child.php   |  2 +-
 .../Operators/Complex/Relationship.php         |  2 +-
 .../src/SearchBy/Operators/Condition.php       |  2 +-
 .../graphql/src/SearchBy/Operators/Field.php   |  2 +-
 .../src/SearchBy/Operators/Logical/Logical.php |  2 +-
 .../src/SortBy/Directives/DirectiveTest.php    |  4 ++--
 .../graphql/src/SortBy/Operators/Child.php     |  2 +-
 .../src/SortBy/Operators/Extra/NullsFirst.php  |  2 +-
 .../src/SortBy/Operators/Extra/NullsLast.php   |  2 +-
 .../src/SortBy/Operators/Extra/Random.php      |  2 +-
 .../graphql/src/SortBy/Operators/Field.php     |  2 +-
 packages/graphql/src/SortBy/Operators/Sort.php |  2 +-
 16 files changed, 58 insertions(+), 23 deletions(-)

diff --git a/packages/graphql/src/Builder/Directives/ExtendOperatorsDirective.php b/packages/graphql/src/Builder/Directives/ExtendOperatorsDirective.php
index ef723ac6e..cc19c32cf 100644
--- a/packages/graphql/src/Builder/Directives/ExtendOperatorsDirective.php
+++ b/packages/graphql/src/Builder/Directives/ExtendOperatorsDirective.php
@@ -8,6 +8,7 @@
 use Nuwave\Lighthouse\Schema\Directives\BaseDirective;
 use Override;
 
+use function array_merge;
 use function array_unique;
 use function implode;
 
@@ -19,7 +20,7 @@ public function __construct() {
     #[Override]
     public static function definition(): string {
         $name      = DirectiveLocator::directiveName(static::class);
-        $locations = implode(' | ', array_unique(static::getDirectiveLocations()));
+        $locations = implode(' | ', array_unique(static::locations()));
 
         return <<<GRAPHQL
             """
@@ -33,10 +34,21 @@ public static function definition(): string {
     /**
      * @return non-empty-list<string>
      */
-    protected static function getDirectiveLocations(): array {
-        return [
+    protected static function locations(): array {
+        return array_merge(static::getDirectiveLocations(), [
             DirectiveLocation::SCALAR,
             DirectiveLocation::ENUM,
+        ]);
+    }
+
+    /**
+     * @deprecated 6.0.0 Use {@see self::locations()} instead.
+     *
+     * @return list<string>
+     */
+    protected static function getDirectiveLocations(): array {
+        return [
+            // empty
         ];
     }
 
diff --git a/packages/graphql/src/Builder/Directives/IgnoredDirective.php b/packages/graphql/src/Builder/Directives/IgnoredDirective.php
index 866e4cc9f..758ae83e9 100644
--- a/packages/graphql/src/Builder/Directives/IgnoredDirective.php
+++ b/packages/graphql/src/Builder/Directives/IgnoredDirective.php
@@ -7,6 +7,7 @@
 use Nuwave\Lighthouse\Schema\Directives\BaseDirective;
 use Override;
 
+use function array_merge;
 use function array_unique;
 use function implode;
 
@@ -18,7 +19,7 @@ public function __construct() {
     #[Override]
     public static function definition(): string {
         $name      = DirectiveLocator::directiveName(static::class);
-        $locations = implode(' | ', array_unique(static::getDirectiveLocations()));
+        $locations = implode(' | ', array_unique(static::locations()));
 
         return <<<GRAPHQL
             """
@@ -31,14 +32,25 @@ public static function definition(): string {
     /**
      * @return non-empty-list<string>
      */
-    protected static function getDirectiveLocations(): array {
-        return [
+    protected static function locations(): array {
+        return array_merge(static::getDirectiveLocations(), [
             DirectiveLocation::FIELD_DEFINITION,
             DirectiveLocation::INPUT_FIELD_DEFINITION,
             DirectiveLocation::OBJECT,
             DirectiveLocation::INPUT_OBJECT,
             DirectiveLocation::ENUM,
             DirectiveLocation::SCALAR,
+        ]);
+    }
+
+    /**
+     * @deprecated 6.0.0 Use {@see self::locations()} instead.
+     *
+     * @return list<string>
+     */
+    protected static function getDirectiveLocations(): array {
+        return [
+            // empty
         ];
     }
 }
diff --git a/packages/graphql/src/Builder/Directives/OperatorDirective.php b/packages/graphql/src/Builder/Directives/OperatorDirective.php
index 0189a3f9f..3c6e4c663 100644
--- a/packages/graphql/src/Builder/Directives/OperatorDirective.php
+++ b/packages/graphql/src/Builder/Directives/OperatorDirective.php
@@ -31,7 +31,7 @@ public static function definition(): string {
             ' | ',
             array_unique(
                 array_merge(
-                    static::getLocations(),
+                    static::locations(),
                     [
                         // Location is mandatory to be able to call the operator
                         DirectiveLocation::INPUT_FIELD_DEFINITION,
@@ -48,11 +48,22 @@ public static function definition(): string {
     /**
      * @return list<string>
      */
-    protected static function getLocations(): array {
-        return [
+    protected static function locations(): array {
+        return array_merge(static::getLocations(), [
             // Locations are required to be able to add operators inside the schema
             DirectiveLocation::SCALAR,
             DirectiveLocation::ENUM,
+        ]);
+    }
+
+    /**
+     * @deprecated 6.0.0 Use {@see self::locations()} instead.
+     *
+     * @return list<string>
+     */
+    protected static function getLocations(): array {
+        return [
+            // empty
         ];
     }
 
diff --git a/packages/graphql/src/Builder/Directives/OperatorsDirective.php b/packages/graphql/src/Builder/Directives/OperatorsDirective.php
index 8675c1405..da51bb90d 100644
--- a/packages/graphql/src/Builder/Directives/OperatorsDirective.php
+++ b/packages/graphql/src/Builder/Directives/OperatorsDirective.php
@@ -17,7 +17,7 @@ abstract class OperatorsDirective extends ExtendOperatorsDirective {
     #[Override]
     public static function definition(): string {
         $name      = DirectiveLocator::directiveName(static::class);
-        $locations = implode(' | ', array_unique(static::getDirectiveLocations()));
+        $locations = implode(' | ', array_unique(static::locations()));
 
         return <<<GRAPHQL
             """
diff --git a/packages/graphql/src/SearchBy/Operators/Child.php b/packages/graphql/src/SearchBy/Operators/Child.php
index 7548512b7..b48d26e5b 100644
--- a/packages/graphql/src/SearchBy/Operators/Child.php
+++ b/packages/graphql/src/SearchBy/Operators/Child.php
@@ -20,7 +20,7 @@ class Child extends Operator {
      * @inheritDoc
      */
     #[Override]
-    protected static function getLocations(): array {
+    protected static function locations(): array {
         return [
             DirectiveLocation::SCALAR,
         ];
diff --git a/packages/graphql/src/SearchBy/Operators/Complex/Relationship.php b/packages/graphql/src/SearchBy/Operators/Complex/Relationship.php
index 592defca9..794c314f5 100644
--- a/packages/graphql/src/SearchBy/Operators/Complex/Relationship.php
+++ b/packages/graphql/src/SearchBy/Operators/Complex/Relationship.php
@@ -38,7 +38,7 @@ public function __construct(
      * @inheritDoc
      */
     #[Override]
-    protected static function getLocations(): array {
+    protected static function locations(): array {
         return [
             DirectiveLocation::SCALAR,
             DirectiveLocation::FIELD_DEFINITION,
diff --git a/packages/graphql/src/SearchBy/Operators/Condition.php b/packages/graphql/src/SearchBy/Operators/Condition.php
index 113b030dd..8833d4077 100644
--- a/packages/graphql/src/SearchBy/Operators/Condition.php
+++ b/packages/graphql/src/SearchBy/Operators/Condition.php
@@ -19,7 +19,7 @@ class Condition extends Operator {
      * @inheritDoc
      */
     #[Override]
-    protected static function getLocations(): array {
+    protected static function locations(): array {
         return [
             // empty
         ];
diff --git a/packages/graphql/src/SearchBy/Operators/Field.php b/packages/graphql/src/SearchBy/Operators/Field.php
index 683297a27..41b638171 100644
--- a/packages/graphql/src/SearchBy/Operators/Field.php
+++ b/packages/graphql/src/SearchBy/Operators/Field.php
@@ -22,7 +22,7 @@ class Field extends Operator {
      * @inheritDoc
      */
     #[Override]
-    protected static function getLocations(): array {
+    protected static function locations(): array {
         return [
             DirectiveLocation::SCALAR,
         ];
diff --git a/packages/graphql/src/SearchBy/Operators/Logical/Logical.php b/packages/graphql/src/SearchBy/Operators/Logical/Logical.php
index fd2d1f413..0667a9d43 100644
--- a/packages/graphql/src/SearchBy/Operators/Logical/Logical.php
+++ b/packages/graphql/src/SearchBy/Operators/Logical/Logical.php
@@ -27,7 +27,7 @@ abstract class Logical extends Operator {
      * @inheritDoc
      */
     #[Override]
-    protected static function getLocations(): array {
+    protected static function locations(): array {
         return [
             DirectiveLocation::SCALAR,
         ];
diff --git a/packages/graphql/src/SortBy/Directives/DirectiveTest.php b/packages/graphql/src/SortBy/Directives/DirectiveTest.php
index bde72111d..0c562d1ab 100644
--- a/packages/graphql/src/SortBy/Directives/DirectiveTest.php
+++ b/packages/graphql/src/SortBy/Directives/DirectiveTest.php
@@ -1581,7 +1581,7 @@ class DirectiveTest__CustomOperatorDirective extends Child {
      * @inheritDoc
      */
     #[Override]
-    protected static function getLocations(): array {
-        return array_merge(parent::getLocations(), [DirectiveLocation::FIELD_DEFINITION]);
+    protected static function locations(): array {
+        return array_merge(parent::locations(), [DirectiveLocation::FIELD_DEFINITION]);
     }
 }
diff --git a/packages/graphql/src/SortBy/Operators/Child.php b/packages/graphql/src/SortBy/Operators/Child.php
index c20478329..c0bcfd12a 100644
--- a/packages/graphql/src/SortBy/Operators/Child.php
+++ b/packages/graphql/src/SortBy/Operators/Child.php
@@ -21,7 +21,7 @@ class Child extends Operator {
      * @inheritDoc
      */
     #[Override]
-    protected static function getLocations(): array {
+    protected static function locations(): array {
         return [
             DirectiveLocation::SCALAR,
         ];
diff --git a/packages/graphql/src/SortBy/Operators/Extra/NullsFirst.php b/packages/graphql/src/SortBy/Operators/Extra/NullsFirst.php
index 1c2b8ad82..f327c7f6b 100644
--- a/packages/graphql/src/SortBy/Operators/Extra/NullsFirst.php
+++ b/packages/graphql/src/SortBy/Operators/Extra/NullsFirst.php
@@ -35,7 +35,7 @@ public function __construct(
      * @inheritDoc
      */
     #[Override]
-    protected static function getLocations(): array {
+    protected static function locations(): array {
         return [
             DirectiveLocation::SCALAR,
         ];
diff --git a/packages/graphql/src/SortBy/Operators/Extra/NullsLast.php b/packages/graphql/src/SortBy/Operators/Extra/NullsLast.php
index 71a4d7f95..6963bd203 100644
--- a/packages/graphql/src/SortBy/Operators/Extra/NullsLast.php
+++ b/packages/graphql/src/SortBy/Operators/Extra/NullsLast.php
@@ -35,7 +35,7 @@ public function __construct(
      * @inheritDoc
      */
     #[Override]
-    protected static function getLocations(): array {
+    protected static function locations(): array {
         return [
             DirectiveLocation::SCALAR,
         ];
diff --git a/packages/graphql/src/SortBy/Operators/Extra/Random.php b/packages/graphql/src/SortBy/Operators/Extra/Random.php
index 8dc432216..25a634f13 100644
--- a/packages/graphql/src/SortBy/Operators/Extra/Random.php
+++ b/packages/graphql/src/SortBy/Operators/Extra/Random.php
@@ -23,7 +23,7 @@ class Random extends Operator {
      * @inheritDoc
      */
     #[Override]
-    protected static function getLocations(): array {
+    protected static function locations(): array {
         return [
             DirectiveLocation::SCALAR,
         ];
diff --git a/packages/graphql/src/SortBy/Operators/Field.php b/packages/graphql/src/SortBy/Operators/Field.php
index ce676bddf..7e3d4f9b5 100644
--- a/packages/graphql/src/SortBy/Operators/Field.php
+++ b/packages/graphql/src/SortBy/Operators/Field.php
@@ -22,7 +22,7 @@ class Field extends Operator {
      * @inheritDoc
      */
     #[Override]
-    protected static function getLocations(): array {
+    protected static function locations(): array {
         return [
             DirectiveLocation::SCALAR,
         ];
diff --git a/packages/graphql/src/SortBy/Operators/Sort.php b/packages/graphql/src/SortBy/Operators/Sort.php
index 24cbd24f8..449d235b0 100644
--- a/packages/graphql/src/SortBy/Operators/Sort.php
+++ b/packages/graphql/src/SortBy/Operators/Sort.php
@@ -36,7 +36,7 @@ public function __construct(
      * @inheritDoc
      */
     #[Override]
-    protected static function getLocations(): array {
+    protected static function locations(): array {
         return [
             // empty
         ];