php - 拉维和 PHP : Return special formatted JSON

Question

完成查询后，如何创建并回显像这样的格式化 JSON:

{
  "results": [
    {
      "user_id": "1",
      "name": "Apple",
      "address": "7538 N LA CHOLLA BLVD",
      "city": "Palo Alto",
      "state": "CA",
      "latlon": [
        -111.012654,
        32.339807
      ],
    },
    {
      "user_id": "2",
      "name": "Microsoft",
      "address": "75 S BWY STE 400",
      "city": "Palo Alto",
      "state": "CA",
      "latlon": [
        -73.764497,
        41.031858
      ],
    },
   ],

  "meta": {
    "page": 1,
    "per_page": 10,
    "count": 493,
    "total_pages": 50
  }
}

这是我当前的查询:

public function getAgenciesJson() {

    $agencies = DB::table('users')->where('type','a')->orWhere('type','l');

}

考虑到我有一个像 [-111.012654,32.339807] 这样的“latlon”字段，还有一个“results”标签和一个“meta”标签，我还没有想出如何输出这样的 JSON。

提前致谢

Answer 1

您需要的是一种称为转换器(或演示器)的东西，将您的原始模型转换为可以发送给您的用户的格式。

Phil Sturgeon 有一个非常流行的包叫做 Fractal ( http://fractal.thephpleague.com/ )。有一个名为 Larasponse ( https://github.com/salebab/larasponse ) 的 Laravel 包，可能会使它更易于使用。

Phil 实际上是前几天关于此的博客文章 - https://philsturgeon.uk/api/2015/05/30/serializing-api-output/ - 这就是为什么您应该始终在您的模型和您发送给用户的内容之间有某种转换器。

还有一个关于使用 Larasponse 和 Fractal 的指南可能在这里有用 - http://laravelista.com/laravel-fractal/ .

它的要点归结为将模型传递给另一个类，该类将采用模型值并以已知/固定格式构建数组/对象，例如(来自 Phil 的博文)

return [
    'id'      => (int) $book->id,
    'title'   => $book->title,
    'year'    => (int) $book->yr,
    'author'  => [
        'name'  => $book->author_name,
        'email' => $book->author_email,
    ],
    'links'   => [
        [
            'rel' => 'self',
            'uri' => '/books/'.$book->id,
        ]
    ]
];

这样您就不会公开您的原始字段名称，如果您的列名称在任何时候应该更改，您只需在一个地方更新它，而不必让您的 JSON 的任何用户更新他们的网站/应用程序。它还将允许您对 latlon 列进行字符串操作，以便将其拆分为 2 个不同的值。

使用来自 Fractal 文档的稍微修改过的示例。假设您有一个用户转换器

class UserTransformer extends Fractal\TransformerAbstract
{
    public function transform(User $user) 
    {
        return [
            'id' => (int) $user->id,
            'name' => $user->first_name . ' ' . $user->last_name,
        ];
    }
}

然后您可以使用此类来转换集合中的单个项目

$user = User::find(1);
$resource = new Fractal\Resource\Item($user, new UserTransformer);

// Or transform a collection
// $users = User::all();
// $resource = new Fractal\Resource\Collection($users, new UserTransformer);

// Use a manager to convert the data into an array or json
$json = (new League\Fractal\Manager)->createData($resource)->toJson();

Fractal 包含一个可立即使用的 Laravel 分页器适配器

$paginator = User::paginate();
$users = $paginator->getCollection();

$resource = new Collection($users, new UserTransformer);
$resource->setPaginator(new IlluminatePaginatorAdapter($paginator));