XF 2.0 Proper way to return JSON

[Jean-Baptiste]

Hello,

To return JSON responses from my Controller, I'm using the following code :

        header('Content-Type: application/json');
        echo json_encode($data);
        die();

What is the good way to return JSON ?

Thanks

 

[Jean-Baptiste]

Hello,
Any suggestions ?
I think that's quite easy but I don't know how to do that.

 

[grisha2217]

Hello,

To return JSON responses from my Controller, I'm using the following code :

        header('Content-Type: application/json');
        echo json_encode($data);
        die();

What is the good way to return JSON ?

Thanks

i think this is bad way, in xf 1.5.x you can return json data through jsonEncodeForOutput function in ViewPublic:

class Dev_TestAddon_ViewPublic_Test extends XenForo_ViewPublic_Base
{
    public function renderJson()
    {
        return XenForo_ViewRenderer_Json::jsonEncodeForOutput($this->_params);
    }
}

So, xf 2.0 must have the similar function to return json data

 

[DragonByte Tech]

If your Controller: $this->setResponseType('json');

Then, return $this->view('Your\AddOn:Your\View', '', $viewParams); and the contents of $viewParams will be returned as JSON. You do not need a View file if you don't want to modify the output.


Fillip

 

[Rasmus Vind]

I've been doing this:

        $reply = $this->message('Success');
        $reply->setJsonParams(['a' => 1, 'b' => 2]);
        return $reply;

The only ugly part is that I don't care for the message.

 

[Jean-Baptiste]

return $this->view('Your\AddOn:Your\View', '', $viewParams);

It doesn't work, I have no params that is being returned...

 

[DragonByte Tech]

It doesn't work, I have no params that is being returned...

Then your viewParams array is empty.


Fillip

 

[Ben Fillmore]

Sorry to pull up an old thread, but I try this:

    public function actionTest(){

        $this->setResponseType('json');

        return $this->view('Em8er\Auth:API', '', ["foo" => "bar"]);

    }

And the response I get is this:

{"status":"ok","html":{"content":""},"visitor":{"conversations_unread":"0","alerts_unread":"0","total_unread":"0"},"debug":{"time":0.1417,"queries":4,"memory":1.72}}

I'm not getting my foo:bar view parameter coming through.

Any advice?

 

[S Thomas]

Create a custom view class and return your params there.

 

[Ben Fillmore]

Worked. Thanks.

 

[abdfahim]

Create a custom view class and return your params there.

Could you provide an example or a link, please?

 

[Robust]

Could you provide an example or a link, please?

Create a view, something like:

use XF\Mvc\View;

class GenericApiRequest extends View
{
    public function renderJson()
    {
        return $this->params;
    }
}

Use this view class for your view.

 

[abdfahim]

Thanks, I am trying to follow the same for an Ajax call, but getting 400 bad Request from the server.

Can't the same strategy be used with an Ajax call?

jQuery.ajax({
    type: "POST",
    url: "{{ link('portal-a/reload') }}",  // portal-a/reload is the route to the action class
    dataType:"json",
    success: function(data){
        alert(success);
    },
    error: function(xhr){
        alert("An error occured: " + xhr.status + " " + xhr.statusText);
    }
});

namespace PortalA\Pub\Controller;


class PortalA extends \XF\Pub\Controller\AbstractController
{
    public function actionReload()
    {
        $viewParams = [
            'name' => "Test"
        ];

        return $this->view('PortalA\Pub\View\Test\PortalA', '', $viewParams);
    }
}

namespace PortalA\Pub\View\Test;

class PortalA extends \XF\Mvc\View
{
    public function renderJson()
    {
        $this->setResponseType('json');
        return $this->params;
        // Also tried return $this->response;
    }
}

 

[Robust]

The renderJson method in the view will not be called if the response type isn't already set to json in the controller, so trying to set it there is pointless.

Move $this->setResponseType('json'); to the top of your controller action.

 

[abdfahim]

Oh, thanks! Now I get pure JSON output from my page.

 

[Improvs]

That part working fine, I got json response and can see them inside post request. But how can I show json data in teamplate? How xf script working?

 <a href="mypathToAction" class="myclass"
            title="mytitle"
            data-xf-click="bookmark-click"
            data-sk-bookmarked="addClass:is-bookmarked"
            data-sk-bookmarkremoved="removeClass:is-bookmarked">
            click button ( {{$myParam}} )
   </a>

How can i change val of $myParam inside template? Json request send my new data of this param, but I can't understand how to change it on fly)