Есть ли аналог Rabl для PHP (фильтрация сериализуемых данных)?

Question

[Кирилл Несмеянов]

Ситуация следующая. Допустим, есть роут /blog/:id, который ведёт на метод контроллера:

public function show($id)
{
    return Blog::find($id);
}

Метод контроллера вызывает метод find у модели Blog и в случае успеха возвращает объект этой блогозаписи, далее данные автоматом сериализуются в json вида:

{
  "id": 1,
  "title": "Тестовая запись",
  "content": "****** *****",
  "original_content": "***"
 и т.д.
}

Так вот, вопрос в следующем - требуется механизм, который бы позволял отсекать лишние данные и добавлять требуемые, например:

public function show($id)
{
    return (new JsonData(Blog::find($id)))
      ->with(['id', 'title', 'content', 'user.login', 'user.avatar', 'user.id']);
}

Что было бы аналогично (привожу пример не учитывая того, что find может вернуть null):

public function show($id)
{
    $blog = Blog::find($id);
    return [
      'id' => $blog->id,
      'title' => $blog->title,
      'content' => $blog->content,
      'user' => [
          'id' => $blog->user->id,
          'avatar' => $blog->user->avatar,
          'login' => $blog->user->login
      ]
    ];
}

Для рубей есть отличный гем, называется Rabl, который позволяет делать именно то, что надо:

attributes :id, :title, :description, :start, :end, :location
child :creator => :creator do
  extends 'users/base'
end
 
## JSON output:
# {
#     "event": {
#         "id": 7,
#         "title": "Et earum sed fuga.",
#         "description": "Quis sed ..e ad.",
#         "start": "2011-05-31T08:31:45Z",
#         "end": "2011-06-01T08:31:45Z",
#         "location": "Saul Tunnel",
#         "creator": {
#             "id": 1,
#             "username": "alanna",
#             "email": "[e-mail]",
#             "display_name": "Mrs. Gaylord Hoeger"
#         }
#     }
# }

Может, кто сталкивался с подобным? Что-нибудь посоветуете?

Answer 1

[Сергей Протько]

JMSSerializer? Документация у него конечно стремненькая, но все что вы хотите он умеет.

Comments

[Кирилл Несмеянов]

Насколько я понял он ориентируется по аннотациям класса сериализуемой модели, верно?

Функционал скрытия данных при сериализации модели уже присутствует внутри фреймворка, который я использую, но проблема в том что в разных местах требуется получать разные данные, используя одну и ту же модель, т.е. отвязаться от унификации данных и фильтровать их на ходу.

Пока набросал примерчик "в лоб": pastebin.com/AeuGMwET Но как понятно - он очень простой и не позволяет строить сложные структуры, т.е. на каждый чих придётся лезть в исходники и править их.

[Кирилл Несмеянов]

Ну или просто я пока не совсем вкурил идею JMSSerializer'a, сейчас попробую вчитаться.

[Сергей Протько]

@SerafimArts, не только аннотациями, можно и через yml и через xml настраивать.

JMSSerializer вам нужно посмотреть на serialization groups, по сути то же что и группы для валидаторов (по виду вы используете Yii2, там это вроде называется сценариями).

[Сергей Протько]

@SerafimArts, на основе групп, и описания связанных типов можно строить очень сложные структуры.

[Кирилл Несмеянов]

Вы правы, документация стрёмная. Потратил пол часа, что бы найти группы сериализации - не нашёл, есть вариант потыкать меня носом? Или исходники стоит смотреть?

З.Ы. Фрейм Laravel 4, но это думаю не существенно.