Paginator object formatting

[terion-name]

I don't make a pull request because this enhancement should be thought over, but I think that this have sense to be implemented.
Here is my "peace of code" from controller, that normalizes Paginator object to json api format:

if ($response instanceof \Illuminate\Pagination\Paginator) {
    $items = $response->getCollection();
    $itemsKey = 'items';
    $return = [];
    if ($items->count() > 0 && ($firstItem = $items->get(0)) instanceof \Illuminate\Database\Eloquent\Model) {
        $itemsKey = $firstItem->getTable();
    }
    $meta = [
        'total' => $response->getTotal(),
        'per_page' => $response->getPerPage(),
        'current_page' => $response->getCurrentPage(),
        'last_page' => $response->getLastPage(),
        'from' => $response->getFrom(),
        'to' => $response->getTo()
    ];
    if ($items->count() > 0) {
        $return[$itemsKey] = $items;
    }
    $return['meta'] = $meta;
    return $return;
}

This will result in output:

{"users": [
    {
        "_id": "535fa16f6e6c631f936cb2a1",
        "name": "Foo"
    },
    {
        "_id": "535fa16f6e6c631f936cb2a2",
        "name": "Bar"
    }
], "meta": {
    "total": 2,
    "per_page": 10,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 2
}}

What do you think about implementation of this?

[jasonlewis]

Yeah I'm currently toying with implementing Fractal to actually handle the transformation of models and the associated data. There's a few things I need to look into first. At this point in time you're going to have to keep doing what you're doing.

[terion-name]

Ok, thanx

[hskrasek]

@jasonlewis Now that Fractal has been implemented, I noticed that there is no way currently to take advantage of its Pagination or Cursor support. Is this something you have planned to add? I was mulling over the best way to handle that pagination side of things, but at the moment all I could come up with was an optional addition to API::transform(), making it look something like this:

API::transform('User', 'UserTransformer', 'EloquentUserRepository::paginate()');

Not saying thats the best way to handle that, not even sure if I am doing pagination via repository pattern the proper way, but so far it has worked for me so far. Just wanted to see if this was on the radar.

[jasonlewis]

Shall be looking in to this today.
On 1 May 2014 11:29, "Hunter Skrasek" notifications@github.com wrote:

@jasonlewis https://github.com/jasonlewis Now that Fractal has been
implemented, I noticed that there is no way currently to take advantage of
its Pagination or Cursor support. Is this something you have planned to
add? I was mulling over the best way to handle that pagination side of
things, but at the moment all I could come up with was an optional addition
to API::transform(), making it look something like this:

API::transform('User', 'UserTransformer', 'EloquentUserRepository::paginate()');

Not saying thats the best way to handle that, not even sure if I am doing
pagination via repository pattern the proper way, but so far it has worked
for me so far. Just wanted to see if this was on the radar.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/19#issuecomment-41870943
.

[jasonlewis]

I've added in support for the pagination side of things with Fractal at 6e80d4a (only in develop as yet).

You just simply return a paginated model.

return Post::paginate(10);

I'm not too sure on the best way to implement cursors as yet. They require configuration in userland so it's going to be difficult.

[hskrasek]

Meant to hop in before the issue was closed, but for the moment I think the best way to implement cursors would probably have to be a configuration of sorts.

Maybe something like:

API::setCursorable($modelName);

That way the package knows that if an instance of say Post shows up, grab the current cursor using $current = Input::get(Config::get('api.cursor_key'));, and then finish off the creation of a Cursor object with $posts->last()->id, and $posts->count(). Just an idea at the moment, no clue if something like that would be super developer friendly though.

[jasonlewis]

Yeah I'm not 100% on cursors. Like... Will the developer always want to use
the last ID? I dunno... Open a new issue so I can keep it in mind. Heh.
On 1 May 2014 15:44, "Hunter Skrasek" notifications@github.com wrote:

Meant to hop in before the issue was closed, but for the moment I think
the best way to implement cursors would probably have to be a configuration
of sorts.

Maybe something like:

API::setCursorable($modelName);

That way the package knows that if an instance of say Post shows up, grab
the current cursor using $current =
Input::get(Config::get('api.cursor_key'));, and then finish off the
creation of a Cursor object with $posts->last()->id, and $posts->count().
Just an idea at the moment, no clue if something like that would be super
developer friendly though.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/19#issuecomment-41882783
.

[terion-name]

You just simply return a paginated model.

@jasonlewis I've updated api package, updated config, added a Transformer, in app service provider added following:

    public function boot()
    {
        parent::boot();

        $this->bindTransformers();
    }

    protected function bindTransformers() {
        API::transform('CRM\Models\User', 'CRM\Services\Transformers\UserTransformer'); // returns instance of Dingo\Api\Transforme, so it works
    }

But when I return Paginator from controller — I still get non-transformed output... Do I need to do something more to make it work?

[jasonlewis]

This is most likely related to #30 which has now been fixed. You should be able to run composer update and grab v0.3.1.

[terion-name]

Thanx, it is not available yet, I'll check when it will begin to load.
But there is one more problem:
Now, when I return a model instance passed through a transformer, it is keyed as "data" that is violating json api spec:

{
data: {
id: "5363641cb80de470031f81e0",
email: "sava.gordeev@grishinmuhin.ru",
first_name: "Флорентина",
last_name: "Алексеев",
photo: "/tmp/1d410b9cbf2a3c0a6457680314e689ea.jpg",
bio: "Alice said very politely, 'for I can't get out again. Suddenly she came suddenly upon.",
group: "employee",
gender: "female",
updated_at: {
date: "2014-05-02 12:23:40",
timezone_type: 3,
timezone: "Europe/Kiev"
},
created_at: {
date: "2014-05-02 12:23:40",
timezone_type: 3,
timezone: "Europe/Kiev"
}
}
}

[jasonlewis]

That is hard coded in to Fractal at the moment. A PR is currently being worked on and you can view it here.

[terion-name]

Awesome) You are doing a very great thing, thank you)

Is there a way to temporary workaround this?

[jasonlewis]

Not that I know of, sorry. It would require a bit of "hacking" I'd say.