Overhauling Controller

[jasonlewis]

Okay the plan is to overhaul the controller that the API ships with to provide a bunch of helper methods to easily return better responses.

Currently responses are kind of "magically" transformed. I'd like to keep that, but perhaps add a configuration option to disable it (perhaps by default?) so that you can return raw responses (in regards to #50) and also make use of the helper methods.

Possible helper methods:

• withPaginator
• withCollection
• withModel
• withArray

Usage would be:

return $this->withModel(User::find(1));

Or something to that affect. Just after some thoughts and other possible methods.

/cc @philsturgeon

[terion-name]

maybe better something like return Response::make($data)->withPaginator()->format('xml')?

[jasonlewis]

I'm trying to keep any sort of formatting related stuff outside of the
controller. The format is set via the Accept header.

On Fri, May 23, 2014 at 9:34 PM, Terion notifications@github.com wrote:

maybe better something like return
Response::make($data)->withPaginator()->format('xml')?

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

[jasonlewis]

I'm thinking this might also need to belong in Dingo\Api\Http\Response so that if you are using closures for routes you can replace the Response facade and use it much like was shown above.

return Response::withPaginator($paginator);

[philsturgeon]

Sounds good. I only shoved them in the controller because it worked and I didn’t care about closures. Your way sounds better.

[jasonlewis]

So I'm just looking at this now and I'm not too sure what these methods should be doing. I know in your case Phil you'd like to have more control over how Fractal is handled. For others though they might not want that.

My train of thought at the moment is that simply allowing the "magic responses" to be disabled would be the best way forward, for now. That way you can still retain complete control over the responses that are returned.

I may be thinking about this all wrong though. So. Much. Thinking. 😁

[philsturgeon]

Sorry to bump you here mate, I know you've been working hard on Dingo. Where are we at?

[rizqidjamaluddin]

I know I prefer explicit responses whenever possible. In general I don't like the idea of too many layers doing things between the controller response and the actual response. A config switch, or supporting both, sound reasonable.