pref: 自定义 format 支持传参

jiannei · Dec 30, 2022 · 02e975a · 02e975a
1 parent 5926d0c
commit 02e975a
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 11 deletions.
diff --git a/composer.json b/composer.json
@@ -9,7 +9,8 @@
         }
     ],
     "require": {
-        "php": "^7.2.5|^8.0"
+        "php": "^7.2.5|^8.0",
+        "ext-json": "*"
     },
     "require-dev": {
         "orchestra/testbench": "^7.0",

diff --git a/config/response.php b/config/response.php
@@ -51,5 +51,51 @@
     ],
 
     // Set the structure of the response data
-    'format' => \Jiannei\Response\Laravel\Support\Format::class,
+    'format' => [
+        \Jiannei\Response\Laravel\Support\Format::class,
+        [
+            'status' => ['alias' => 'status', 'show' => true],
+            'code' => ['alias' => 'code', 'show' => true],
+            'message' => ['alias' => 'message', 'show' => true],
+            'error' => ['alias' => 'error', 'show' => true],
+            'data' => [
+                'alias' => 'data',
+                'show' => true,
+
+                'fields' => [
+                    // When data is nested with data, such as returning paged data, you can also set an alias for the inner data
+                    'data' => ['alias' => 'data', 'show' => true], // data/rows/list
+
+                    'meta' => [
+                        'alia' => 'meta',
+                        'show' => true,
+
+                        'fields' => [
+                            'pagination' => [
+                                'alias' => 'pagination',
+                                'show' => true,
+
+                                'fields' => [
+                                    'total' => ['alias' => 'total', 'show' => true],
+                                    'count' => ['alias' => 'count', 'show' => true],
+                                    'per_page' => ['alias' => 'per_page', 'show' => true],
+                                    'current_page' => ['alias' => 'current_page', 'show' => true],
+                                    'total_pages' => ['alias' => 'total_pages', 'show' => true],
+                                    'links' => [
+                                        'alias' => 'links',
+                                        'show' => true,
+
+                                        'fields' => [
+                                            'previous' => ['alias' => 'previous', 'show' => true],
+                                            'next' => ['alias' => 'next', 'show' => true],
+                                        ],
+                                    ],
+                                ],
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+        ],
+    ],
 ];
diff --git a/src/Providers/LaravelServiceProvider.php b/src/Providers/LaravelServiceProvider.php
@@ -22,10 +22,13 @@ public function register()
 
     public function boot()
     {
-        $formatter = $this->app['config']['response.format'];
+        $formatter = $this->app['config']->get('response.format.0',\Jiannei\Response\Laravel\Support\Format::class);
+        $config = $this->app['config']->get('response.format.1',[]);
 
         if (is_string($formatter) && class_exists($formatter)) {
-            $this->app->bind(\Jiannei\Response\Laravel\Contracts\Format::class, $formatter);
+            $this->app->bind(\Jiannei\Response\Laravel\Contracts\Format::class, function () use ($formatter,$config) {
+                return new $formatter($config);
+            });
         }
     }
 

diff --git a/src/Providers/LumenServiceProvider.php b/src/Providers/LumenServiceProvider.php
@@ -13,11 +13,6 @@
 
 class LumenServiceProvider extends LaravelServiceProvider
 {
-    public function boot()
-    {
-        $this->app->configure('response');
-    }
-
     protected function setupConfig()
     {
         $path = dirname(__DIR__, 2).'/config/response.php';

diff --git a/src/Support/Format.php b/src/Support/Format.php
@@ -22,6 +22,13 @@ class Format implements \Jiannei\Response\Laravel\Contracts\Format
 {
     use Macroable;
 
+    protected $config;
+
+    public function __construct($config = [])
+    {
+        $this->config = $config;
+    }
+
     /**
      * Format return data structure.
      *
@@ -39,7 +46,7 @@ public function data(?array $data, ?string $message, int $code, $errors = null):
             'message' => $this->formatMessage($code, $message),
             'data' => $data ?: (object) $data,
             'error' => $errors ?: (object) [],
-        ], Config::get('response.format.fields', []));
+        ], $this->config);
     }
 
     /**

diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -44,7 +44,7 @@ protected function defineEnvironment($app)
 
         $app['config']->set('response.enum', \Jiannei\Response\Laravel\Tests\Repositories\Enums\ResponseCodeEnum::class);
         if ($this instanceof FormatTest) {
-            $app['config']->set('response.format', \Jiannei\Response\Laravel\Tests\Support\Format::class);
+            $app['config']->set('response.format', [\Jiannei\Response\Laravel\Tests\Support\Format::class]);
         }
     }
 }