feat: add fieldsBefore and fieldsAfter ApiResource extenders (#4106)

flarum · Nov 9, 2024 · 3b69af2 · 3b69af2
1 parent c401e67
commit 3b69af2
Show file tree

Hide file tree

Showing 3 changed files with 403 additions and 331 deletions.
diff --git a/framework/core/src/Extend/ApiResource.php b/framework/core/src/Extend/ApiResource.php
@@ -25,6 +25,8 @@ class ApiResource implements ExtenderInterface
     private array $removeEndpoints = [];
     private array $endpoint = [];
     private array $fields = [];
+    private array $fieldsBefore = [];
+    private array $fieldsAfter = [];
     private array $removeFields = [];
     private array $field = [];
     private array $sorts = [];
@@ -93,6 +95,32 @@ public function fields(callable|string $fields): self
         return $this;
     }
 
+    /**
+     * Add fields to the resource before a certain field.
+     *
+     * @param string $before the name of the field to add the new fields before.
+     * @param callable|class-string $fields must be a callable that returns an array of objects that implement \Tobyz\JsonApiServer\Schema\Field.
+     */
+    public function fieldsBefore(string $before, callable|string $fields): self
+    {
+        $this->fieldsBefore[] = [$before, $fields];
+
+        return $this;
+    }
+
+    /**
+     * Add fields to the resource after a certain field.
+     *
+     * @param string $after the name of the field to add the new fields after.
+     * @param callable|class-string $fields must be a callable that returns an array of objects that implement \Tobyz\JsonApiServer\Schema\Field.
+     */
+    public function fieldsAfter(string $after, callable|string $fields): self
+    {
+        $this->fieldsAfter[] = [$after, $fields];
+
+        return $this;
+    }
+
     /**
      * Remove fields from the resource.
      *
@@ -221,6 +249,26 @@ function (array $endpoints, Resource $resource) use ($container): array {
                 $fields = array_merge($fields, $newFieldsCallback());
             }
 
+            foreach ($this->fieldsBefore as [$before, $newFieldsCallback]) {
+                $newFieldsCallback = ContainerUtil::wrapCallback($newFieldsCallback, $container);
+                $newFields = $newFieldsCallback();
+                $beforeIndex = array_search($before, array_column($fields, 'name'));
+
+                if ($beforeIndex !== false) {
+                    array_splice($fields, $beforeIndex, 0, $newFields);
+                }
+            }
+
+            foreach ($this->fieldsAfter as [$after, $newFieldsCallback]) {
+                $newFieldsCallback = ContainerUtil::wrapCallback($newFieldsCallback, $container);
+                $newFields = $newFieldsCallback();
+                $afterIndex = array_search($after, array_column($fields, 'name'));
+
+                if ($afterIndex !== false) {
+                    array_splice($fields, $afterIndex + 1, 0, $newFields);
+                }
+            }
+
             foreach ($this->removeFields as $field) {
                 [$fieldsToRemove, $condition] = $field;