[8.0] Support for Eloquent API Resources #1702

asahasrabuddhe · 2018-04-11T09:53:29Z

Hello,

This PR aims to address the following issues:

Laravel 5.5 introduced to us Eloquent API resources where we could easily describe the format that we wanted for our API responses. This package currently does not support the new API resources. Through this PR, I have added a new engine to handle API Resources, updated the configuration and added a new test case to test the new functionality.

We can use the package as below now:

DataTables::of(App\Http\Resources\UserResource::collection(App\User::all()))->toJson();

or

datatables()->of(App\Http\Resources\UserResource::collection(App\User::all()))->toJson();

or

DataTables::resource(App\Http\Resources\UserResource::collection(App\User::all()))->toJson();

or

datatables->resource(App\Http\Resources\UserResource::collection(App\User::all()))->toJson();

Please review and let me know if there are any corrections and/or enhancements that can be done here if this PR is considered to be merged.

Thanks!

yajra · 2018-04-17T03:05:49Z

Wow thanks! Will review this as soon as I can. ❤️

yajra · 2018-04-17T03:06:47Z

Just to be clear, this is only for collection and no support yet for pagination right?

asahasrabuddhe · 2018-04-17T03:15:23Z

It does support pagination. I have tested with these types of URLs and got proper responses.

http://localhost/datatable?draw=1&start=10&length=10

{
draw: 1,
recordsTotal: 50,
recordsFiltered: 50,
data: [
{
email: "francis71@example.org",
name: "Doug McLaughlin I"
},
{
email: "chandler.cassin@example.org",
name: "Conner Anderson"
},
{
email: "feil.javon@example.org",
name: "Prof. Allen Turcotte PhD"
},
{
email: "dkuhic@example.org",
name: "Jordan Marks"
},
{
email: "helga78@example.com",
name: "Arvid Crooks"
},
{
email: "corwin.emelie@example.net",
name: "Russel Morissette"
},
{
email: "rae.price@example.com",
name: "Shyann Beahan"
},
{
email: "omedhurst@example.net",
name: "Therese Monahan"
},
{
email: "larkin.russ@example.com",
name: "Percival Lynch"
},
{
email: "rosamond.hermiston@example.net",
name: "Mrs. Zoey Stiedemann"
}
],
input: {
draw: "1",
start: "10",
length: "10"
}
}

yajra

Please also remove file []? Thanks!

yajra · 2018-04-17T03:09:49Z

src/config/datatables.php

+        'eloquent'                    => \Yajra\DataTables\EloquentDataTable::class,
+        'query'                       => \Yajra\DataTables\QueryDataTable::class,
+        'collection'                  => \Yajra\DataTables\CollectionDataTable::class,
+        'anonymousresourcecollection' => \Yajra\DataTables\ApiResourceDataTable::class,


Maybe we use shorter syntax like resource? Also this matches, public function resource($resource).

yajra · 2018-04-17T03:10:35Z

src/ApiResourceDataTable.php

+    {
+        return $this;
+    }
+}


I think this class can inherit from CollectionDataTable to avoid duplicate codes?

yajra · 2018-04-17T03:18:26Z

Oh what I mean in pagination is App\User::paginate(10) as the resource value. :)

-- sorry, accidentally closed --

asahasrabuddhe · 2018-04-17T03:31:36Z

Oh what I mean in pagination is App\User::paginate(10) as the resource value. :)

This is not supported. I did not realise that this was supported for eloquent or collection engines. I can work on it if that is a requirement.

In the meanwhile, let me work on the couple of changes you have requested and do another commit.

yajra · 2018-04-17T03:34:38Z

It's not yet a requirement but I think some users will look for it once this is merged. :)

asahasrabuddhe · 2018-04-17T03:41:59Z

It's not yet a requirement but I think some users will look for it once this is merged. :)

This is working now. Look :

return DataTables::of(App\Http\Resources\UserResource::collection(App\User::paginate(10)))->toJson();

URL: http://localhost/datatable

Response:

{
draw: 0,
recordsTotal: 10,
recordsFiltered: 10,
data: [
{
email: "pkessler@example.com",
name: "Lucio Kessler"
},
{
email: "obergnaum@example.net",
name: "Hertha Lebsack"
},
{
email: "erohan@example.org",
name: "Tressie Dooley"
},
{
email: "pcassin@example.org",
name: "Florence West IV"
},
{
email: "joy53@example.net",
name: "Maggie Wunsch"
},
{
email: "nsporer@example.org",
name: "Peggie Hills"
},
{
email: "josiah79@example.com",
name: "Gerry Block"
},
{
email: "mitchell98@example.org",
name: "Jeffrey Kunze Jr."
},
{
email: "bbogisich@example.com",
name: "Alene Murray"
},
{
email: "ankunding.lavon@example.com",
name: "Suzanne Feeney"
}
],
input: [ ]
}

URL: http://localhost/datatable?draw=1&start=0&length=5

Response:

{
draw: 1,
recordsTotal: 10,
recordsFiltered: 10,
data: [
{
email: "pkessler@example.com",
name: "Lucio Kessler"
},
{
email: "obergnaum@example.net",
name: "Hertha Lebsack"
},
{
email: "erohan@example.org",
name: "Tressie Dooley"
},
{
email: "pcassin@example.org",
name: "Florence West IV"
},
{
email: "joy53@example.net",
name: "Maggie Wunsch"
}
],
input: {
draw: "1",
start: "0",
length: "5"
}
}

URL: http://localhost/datatable?draw=1&start=5&length=5

Response:

{
draw: 1,
recordsTotal: 10,
recordsFiltered: 10,
data: [
{
email: "nsporer@example.org",
name: "Peggie Hills"
},
{
email: "josiah79@example.com",
name: "Gerry Block"
},
{
email: "mitchell98@example.org",
name: "Jeffrey Kunze Jr."
},
{
email: "bbogisich@example.com",
name: "Alene Murray"
},
{
email: "ankunding.lavon@example.com",
name: "Suzanne Feeney"
}
],
input: {
draw: "1",
start: "5",
length: "5"
}
}

yajra · 2018-04-17T03:44:20Z

The result only return the first page (10 records) and does not reflect the total count.

recordsTotal: 10,
recordsFiltered: 10,

asahasrabuddhe · 2018-04-17T03:44:49Z

Now working on the remaining suggestions. Will do a commit soon! :)

asahasrabuddhe · 2018-04-17T03:48:49Z

The result only return the first 10 page and does not reflect the total count.

I am getting the total count from collection->count. Will need to look this into detail. Can we have this part integrated first and then fix this later?

… Class from CollectionDataTable class

asahasrabuddhe · 2018-04-17T04:11:24Z

The result only return the first page (10 records) and does not reflect the total count.

So in case of 50 users, if someone does this,

return DataTables::of(App\Http\Resources\UserResource::collection(App\User::paginate(10)))->toJson();

We will show totalRecords = 50 and filteredRecords=10?

asahasrabuddhe · 2018-04-17T04:27:08Z

How about this now?

Code:

return DataTables::of(App\Http\Resources\UserResource::collection(App\User::paginate(10)))->toJson();

URL: http://localhost/datatable

Response:

{
draw: 0,
recordsTotal: 50,
recordsFiltered: 10,
data: [
{
email: "pkessler@example.com",
name: "Lucio Kessler"
},
{
email: "obergnaum@example.net",
name: "Hertha Lebsack"
},
{
email: "erohan@example.org",
name: "Tressie Dooley"
},
{
email: "pcassin@example.org",
name: "Florence West IV"
},
{
email: "joy53@example.net",
name: "Maggie Wunsch"
},
{
email: "nsporer@example.org",
name: "Peggie Hills"
},
{
email: "josiah79@example.com",
name: "Gerry Block"
},
{
email: "mitchell98@example.org",
name: "Jeffrey Kunze Jr."
},
{
email: "bbogisich@example.com",
name: "Alene Murray"
},
{
email: "ankunding.lavon@example.com",
name: "Suzanne Feeney"
}
],
input: [ ]
}

URL: http://localhost/datatable?draw=1&start=5&length=5

Response:

{
draw: 1,
recordsTotal: 50,
recordsFiltered: 10,
data: [
{
email: "nsporer@example.org",
name: "Peggie Hills"
},
{
email: "josiah79@example.com",
name: "Gerry Block"
},
{
email: "mitchell98@example.org",
name: "Jeffrey Kunze Jr."
},
{
email: "bbogisich@example.com",
name: "Alene Murray"
},
{
email: "ankunding.lavon@example.com",
name: "Suzanne Feeney"
}
],
input: {
draw: "1",
start: "5",
length: "5"
}
}

URL: http://localhost/datatable?draw=1&start=5&length=5

Response:

{
draw: 1,
recordsTotal: 50,
recordsFiltered: 10,
data: [
{
email: "nsporer@example.org",
name: "Peggie Hills"
},
{
email: "josiah79@example.com",
name: "Gerry Block"
},
{
email: "mitchell98@example.org",
name: "Jeffrey Kunze Jr."
},
{
email: "bbogisich@example.com",
name: "Alene Murray"
},
{
email: "ankunding.lavon@example.com",
name: "Suzanne Feeney"
}
],
input: {
draw: "1",
start: "5",
length: "5"
}
}

asahasrabuddhe · 2018-04-17T04:55:05Z

@yajra Is this better?

yajra · 2018-04-17T05:06:44Z

@asahasrabuddhe looking good. Noticed something though but a bit trivial:

recordsFiltered: 10,
length: "5"

The result above does not sync well, but I guess this can be fixed by making the paginated value equal to the length request.

Will do some actual testing but this looks like good to go :).

yajra · 2018-04-17T07:01:08Z

src/ApiResourceDataTable.php

+     */
+    public static function canCreate($source)
+    {
+        return is_array($source) || $source instanceof AnonymousResourceCollection;


I think we can remove is_array here since it's handled by CollectionDataTable.

return $source instanceof AnonymousResourceCollection;

yajra · 2018-04-17T07:01:30Z

src/ApiResourceDataTable.php

+    /**
+     * Factory method, create and return an instance for the DataTable engine.
+     *
+     * @param array|Illuminate\Http\Resources\Json\AnonymousResourceCollection $source


@param should be * @param \Illuminate\Http\Resources\Json\AnonymousResourceCollection $source

yajra · 2018-04-17T07:02:09Z

src/ApiResourceDataTable.php

+     */
+    public static function create($source)
+    {
+        if (is_array($source)) {


We can remove the is_array part and let dt collection do the job.

/** * Factory method, create and return an instance for the DataTable engine. * * @param \Illuminate\Http\Resources\Json\AnonymousResourceCollection $source * @return ApiResourceDataTable|DataTableAbstract */ public static function create($source) { return new ApiResourceDataTable($source); }

asahasrabuddhe · 2018-04-17T20:30:30Z

Hello @yajra ,

I went through your feedback and made some more changes. I have setup a small demo here that demonstrates two use-cases.

User:all()
User::paginate(30)

On the link, you will see the table along with the response coming from the package. Please review.

Link: http://35.196.1.30/datatable

Regards,
Ajitem

yajra · 2018-04-18T02:13:17Z

I've seen the link and it works great. However, I think you accidentally deleted the count() method on code clean-up or it's intentional? I think the count override is needed to get the total count from paginator?

Anyways, will test this actual code later too. Thanks a lot!

yajra · 2018-04-18T02:15:43Z

BTW, I think API resource is only available on 5.6. We need to check too if this will break 5.5 installations.

asahasrabuddhe · 2018-04-18T05:02:47Z

Hello @yajra ,

I've seen the link and it works great. However, I think you accidentally deleted the count() method on code clean-up or it's intentional? I think the count override is needed to get the total count from paginator?

Thanks! The count method was intentionally removed.

BTW, I think API resource is only available on 5.6. We need to check too if this will break 5.5 installations.

API Resources were initially introduced in Laravel 5.5 Please refer the link below.

https://laravel.com/docs/5.5/releases

I don't think this will break 5.5 Nevertheless, I will do a test on my end and share results with you.

Regards,
Ajitem

asahasrabuddhe · 2018-04-18T06:20:49Z

Hi,

I have checked on both 5.5 and 5.6. Here are the links:

http://dtl56.theapptest.xyz/datatable
http://dtl55.theapptest.xyz/datatable

Please review.

asahasrabuddhe · 2018-04-18T06:22:07Z

Also, until we explicitly pass an API Resource to the Datatable instance, the new engine won't load. So, I don't think we are risking breaking any of existing installations.

yajra · 2018-04-18T06:46:49Z

@asahasrabuddhe thanks for the feedback. I now found on whats confusing me. On the link you provided:

Collection returns:

    "recordsTotal": 50,
    "recordsFiltered": 50,

While paginate returns:

    "recordsTotal": 30,
    "recordsFiltered": 30,

Given that you are using the same data, we then expect that the records total for paginated results should be the same with collection. This is where we need to use the paginator total to reflect the actual total records. However, I think filtered records needs more work be done or we can just set it always equal to total records?

asahasrabuddhe · 2018-04-18T09:30:56Z

@yajra I think it is best if we try to implement support for Paginate in a separate PR. I tried using User::paginate() with DataTables::of() method without wrapping it in the UserResource::collection() but it gave me an error of no engine found.

What I think is with Paginate, we can set start, length properties of datatable by default for the first load. They will remain the same until the user chooses to customise them.

Handling this separately will allow us to think and implement it in a better way. As far as I know, I have not seen a single datatable example that supports paging links in the response. What do you think?

asahasrabuddhe · 2018-04-18T09:38:28Z

When I convert a pagianted resource to collection, i get all records on page 1. For now, we can leave it as it is. User::paginate can be used under ::collection(), ::resource() or ::of(). I will now start working on proper support for paginated resource for all of these methods.

We can discuss that and implement it separately from here as this PR is more focused on allowing use of API resources with the plugin.

yajra · 2018-04-28T02:19:30Z

I agree with you on separating the support for paginated source.

On the other hand, lets wait some feedback from other users maybe for a week. If no feedbacks, I guess I can merge the PR then. Thanks!

asahasrabuddhe · 2018-05-09T11:18:06Z

Hello @yajra

Any updates here?

Regards,
Ajitem

yajra · 2018-05-10T02:23:48Z

Released on v8.5.0, thanks a lot 🍻

* 8.0: Bump v8.5.0 🚀 [8.0] Support for Eloquent API Resources (#1702)

shamsuljewel · 2019-10-15T16:08:17Z

Hi I am using API Resource and it working great, until I have tried add another resource into it. like
return [ 'id' => $this->id, 'name' => $this->name, 'users' => UserResource::collection($this->whenLoaded('getusers')),

when I loaded getusers then it's not using the UserResoure, it's just return me back the resource from database!!

"users": { "collects": "App\\Http\\Resources\\V1\\UserResource", "collection": [ { "resource": { "id": "141", "email": "test.platform@doorhub.io", "permissions": [], "last_login": "2019-10-14 16:50:23", "first_name": "Test",

where as I expected id, userName, etc.

Is it supported? or I am doing wrong?

asahasrabuddhe added 5 commits April 10, 2018 18:06

Support Added for Laravel API Resources

c9e7a7b

Bug Fixes

dc861bf

Test Cases Added

84ebcaa

Applied DIFF from StyleCI

f70ad7c

Fix Failed test on Laravel 5.5

3cdd6ec

yajra requested changes Apr 17, 2018

View reviewed changes

yajra closed this Apr 17, 2018

yajra reopened this Apr 17, 2018

Removed file []

0b8c468

asahasrabuddhe added 2 commits April 17, 2018 09:21

Reduced length on configuration key and extended ApiResourceDataTable…

f1cc54a

… Class from CollectionDataTable class

Style CI Changes

993ffee

asahasrabuddhe added 4 commits April 17, 2018 09:57

Add Support for Paginated Resource

e5f6cd3

Style CI Fixes applied

a8d1bd1

Fix failing test

90ac5b4

Style CI Changes

a049840

Added Tests for Paginated Resources

2a6a988

yajra requested changes Apr 17, 2018

View reviewed changes

asahasrabuddhe added 4 commits April 17, 2018 20:09

Modified create and canCreate methods as per suggestions

3e5e552

Bugfixes:

0713387

Code Cleanup

778f10e

fix failing test

800d58b

yajra approved these changes Apr 18, 2018

View reviewed changes

yajra added for review help wanted labels Apr 28, 2018

yajra changed the title ~~Support for Eloquent API Resources~~ [8.0] Support for Eloquent API Resources May 10, 2018

yajra merged commit 8fb61c3 into yajra:8.0 May 10, 2018

yajra mentioned this pull request May 10, 2018

API Resource Support #1515

Closed

yajra added a commit that referenced this pull request May 10, 2018

Merge branch '8.0'

5540a60

* 8.0: Bump v8.5.0 🚀 [8.0] Support for Eloquent API Resources (#1702)

This was referenced May 10, 2018

Is feature available for Laravel Api Resources on this data table? #1659

Closed

Q: Using [Eloquent: API Resources] for data transformation #1351

Closed

yajra mentioned this pull request Sep 13, 2018

Support for Laravel Resources [Feature Request] #1838

Closed

yajra added the need docs label Oct 2, 2018

shamsuljewel mentioned this pull request Oct 18, 2019

Hi I am using API Resource and it working great, until I have tried add another resource into it. like #2213

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[8.0] Support for Eloquent API Resources #1702

[8.0] Support for Eloquent API Resources #1702

asahasrabuddhe commented Apr 11, 2018 •

edited

Loading

yajra commented Apr 17, 2018

yajra commented Apr 17, 2018

asahasrabuddhe commented Apr 17, 2018 •

edited

Loading

yajra left a comment

yajra Apr 17, 2018

yajra Apr 17, 2018

yajra commented Apr 17, 2018 •

edited

Loading

asahasrabuddhe commented Apr 17, 2018

yajra commented Apr 17, 2018

asahasrabuddhe commented Apr 17, 2018

yajra commented Apr 17, 2018 •

edited

Loading

asahasrabuddhe commented Apr 17, 2018

asahasrabuddhe commented Apr 17, 2018

asahasrabuddhe commented Apr 17, 2018

asahasrabuddhe commented Apr 17, 2018

asahasrabuddhe commented Apr 17, 2018

yajra commented Apr 17, 2018

yajra Apr 17, 2018

yajra Apr 17, 2018

yajra Apr 17, 2018

asahasrabuddhe commented Apr 17, 2018

yajra commented Apr 18, 2018

yajra commented Apr 18, 2018

asahasrabuddhe commented Apr 18, 2018

asahasrabuddhe commented Apr 18, 2018

asahasrabuddhe commented Apr 18, 2018

yajra commented Apr 18, 2018

asahasrabuddhe commented Apr 18, 2018

asahasrabuddhe commented Apr 18, 2018

yajra commented Apr 28, 2018

asahasrabuddhe commented May 9, 2018

yajra commented May 10, 2018

shamsuljewel commented Oct 15, 2019

[8.0] Support for Eloquent API Resources #1702

[8.0] Support for Eloquent API Resources #1702

Conversation

asahasrabuddhe commented Apr 11, 2018 • edited Loading

yajra commented Apr 17, 2018

yajra commented Apr 17, 2018

asahasrabuddhe commented Apr 17, 2018 • edited Loading

yajra left a comment

Choose a reason for hiding this comment

yajra Apr 17, 2018

Choose a reason for hiding this comment

yajra Apr 17, 2018

Choose a reason for hiding this comment

yajra commented Apr 17, 2018 • edited Loading

asahasrabuddhe commented Apr 17, 2018

yajra commented Apr 17, 2018

asahasrabuddhe commented Apr 17, 2018

yajra commented Apr 17, 2018 • edited Loading

asahasrabuddhe commented Apr 17, 2018

asahasrabuddhe commented Apr 17, 2018

asahasrabuddhe commented Apr 17, 2018

asahasrabuddhe commented Apr 17, 2018

asahasrabuddhe commented Apr 17, 2018

yajra commented Apr 17, 2018

yajra Apr 17, 2018

Choose a reason for hiding this comment

yajra Apr 17, 2018

Choose a reason for hiding this comment

yajra Apr 17, 2018

Choose a reason for hiding this comment

asahasrabuddhe commented Apr 17, 2018

yajra commented Apr 18, 2018

yajra commented Apr 18, 2018

asahasrabuddhe commented Apr 18, 2018

asahasrabuddhe commented Apr 18, 2018

asahasrabuddhe commented Apr 18, 2018

yajra commented Apr 18, 2018

asahasrabuddhe commented Apr 18, 2018

asahasrabuddhe commented Apr 18, 2018

yajra commented Apr 28, 2018

asahasrabuddhe commented May 9, 2018

yajra commented May 10, 2018

shamsuljewel commented Oct 15, 2019

asahasrabuddhe commented Apr 11, 2018 •

edited

Loading

asahasrabuddhe commented Apr 17, 2018 •

edited

Loading

yajra commented Apr 17, 2018 •

edited

Loading

yajra commented Apr 17, 2018 •

edited

Loading