Laravel& PHP:返回特殊格式的JSON

时间:2015-06-11 01:44:17

标签: php mysql json laravel

在进行查询后,我如何创建回显格式化的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”字段,还有一个“结果”标签和一个“元”标签,还没有弄清楚如何输出这样的JSON。

提前致谢

3 个答案:

答案 0 :(得分:3)

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

一个非常受欢迎的包被Phil Sturgeon称为Fractal(http://fractal.thephpleague.com/)。有一个Laravel软件包可能会让它更容易使用,称为Larasponse(https://github.com/salebab/larasponse)。

菲尔实际上是关于这一天的博客文章 - 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));

答案 1 :(得分:0)

该方法存在:

- >的toJSON()

参考:http://laravel.com/docs/4.2/eloquent#converting-to-arrays-or-json

将您的getAgenciesJson更新为:

public function getAgenciesJson() {

    return DB::table('users')->where('type','a')->orWhere('type','l')->toJson();

}

然后你可以回应:

<?= SomeModel::getAgenciesJson(); ?>

要修改列名,您可以更新您的选择。以下是Laravel文档中的一个示例:

$users = DB::table('users')->select('name as user_name')->get();

这是一个更完全实现的你正在寻找的版本减去列别名,因为你没有真正提到它们是什么。

public function getAgenciesJson($page, $per_page = 10) {
   $output = [
        'results' => [],
        'meta'    => [],
    ];

    // Get Results
    $output['results'] = DB::table('users')->where('type','a')->orWhere('type','l')->take($per_page)->skip($per_page * ($page - 1))->get();

    // Set Meta
    $output['meta'] = [
        'page'        => $page,
        'per_page'    => $per_page,
        'count'       => DB::select('SELECT FOUND_ROWS()'),
        'total_pages' => DB::table('users')->count() / $per_page        
    ];

    // Return
    return json_encode($output);
}

您的原始代码并未尝试获取或处理分页信息,但此示例涵盖了此示例,以便提供您希望返回的元数据。

不确定您是否希望Count为当前结果集的编号或该表上所有记录的计数。如果你不想要当前设置你而是整个计数你可以使用DB :: table(&#39; users&#39;) - &gt; count()虽然我会将它分配给变量并使用而不是在元信息中调用它两次。

答案 2 :(得分:-1)

public function getAgenciesJson() {

    $agencies = DB::table('users')->where('type','a')->orWhere('type','l')->get();
    return response()->tojson($agencies,200);//for response with status code 200
}

你应该调用get函数来获取数组格式的数据,响应函数会将输出格式化为json。第二个参数表示您必须为响应分配的状态代码。