Version 4

[Jasonej]

Version 4 seeks to make use of new functionality provided by PHP 8.0 and more strongly focus on formatting and a simpler, more extensible enhancement mechanism.

Changes without clutter from the clean slate commit can be found here.

Goals

Formatting

• Drop requirement for a format method naming convention.
• Support format aliases.
• Explicitly defined defaults.
• Implicit default when only format is present.
• Allow for selection of specific formats.
• Explicit default format on child class overrides default from parent class.
• Integrate formatting with Resource.
• Integrate formatting with ResourceCollection.
• Integrate formatting with AnonymousResourceCollection.

Enhancements

• Stack based enhancement application (similar to how state is applied with Eloquent factories).
• Powered by a modify method.
• Trait for the except enhancement.
• Trait for the only enhancement.
• Integrate enhancements with ResourceCollection.
• Integrate enhancements with AnonymousResourceCollection.

Miscellaneous

• Support specifying the intended response status code.
• Resourceable trait.
• Documentation.

Notes

• PHP 8.0 is required.
• The append enhancement is being dropped.
• The call enhancement is being replaced by the core enhance method functionality which will power the enhancement mechanism.
• The replace enhancement is being dropped.

[erik-perri]

Do any of the enhancement changes open the option to hook into the resource generation globally?

As an example, I'd like to force every resource in a project to return an automatically generated meta.type property.

[Jasonej]

Do any of the enhancement changes open the option to hook into the resource generation globally?

As an example, I'd like to force every resource in a project to return an automatically generated meta.type property.

I hadn't considered doing anything to support global, but I have been considering allowing for formats/enhancements for meta data. The with/additional data system provided by Laravel's resources is a little less straightforward, and the relationship between collections and meta data is something that would require some thought if we want to support enhancing it.

Do you have an idea for how you'd want to apply these global enhancements?

[erik-perri]

My initial thought was having it function like View composers, but the more I have thought about it the less sure I am about it being a useful feature.

I have been trying to think of other data that makes sense to attach globally and have not though of anything else that wouldn’t require a big if instanceof block, which is probably not something we want to encourage.

I will think about it some more to see if I can come up with anything else that could sanely make use of global hooks or a better approach to applying something like generic meta type data to each resource.

[jyann]

Should this be HasOnlyEnhancement?

[Jasonej]

Fixed, thanks!

[jyann]

Sure. Excited about all this new stuff! I like how the features are becoming more explicit and transparent

[erik-perri]

What is your opinion on resolving the AnonymousResourceCollection instance when creating a collection rather than using new?

In one of my projects, I previously created a custom collection resource handler to return the pagination meta information in a format I prefer. I decided to switch to the ::collection pattern using the pagination overrides Laravel now provides (see this PR). Doing so requires me to create both a Resource override with a collection method, and an AnonymousResourceCollection with the paginationInformation method. If it were resolved instead I could just create the AnonymousResourceCollection and use the container to switch the implementation. Not an issue if you'd prefer to leave it, one additional base class is not a big concern.

[Jasonej]

What is your opinion on resolving the AnonymousResourceCollection instance when creating a collection rather than using new?

Resolving it makes a ton of sense. I'll look into adding that in a bit.

[Jasonej]

Added Laravel 9 support, resolving AnonymousResourceCollection instead of direct instantiation, and tagged as v4.0.0-rc1.

[joeladam518]

This might need to be pushed to v5 because of #26. Adding Laravel 9 support required me to drop PHP7.4 and Laravel 7 support.