How to get response as json format(application/json) in yii?

Question

How to get response as json format(application/json) in yii?

Answer 1

For Yii 1:

Create this function in your (base) Controller:

/**
 * Return data to browser as JSON and end application.
 * @param array $data
 */
protected function renderJSON($data)
{
    header('Content-type: application/json');
    echo CJSON::encode($data);

    foreach (Yii::app()->log->routes as $route) {
        if($route instanceof CWebLogRoute) {
            $route->enabled = false; // disable any weblogroutes
        }
    }
    Yii::app()->end();
}

Then simply call at the end of your action:

$this->renderJSON($yourData);

For Yii 2:

Yii 2 has this functionality built-in, use the following code at the end of your controller action:

Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;
return $data;

Answer 2

$this->layout=false;
header('Content-type: application/json');
echo CJavaScript::jsonEncode($arr);
Yii::app()->end(); 

Answer 3

For Yii2 inside a controller:

public function actionSomeAjax() {
    $returnData = ['someData' => 'I am data', 'someAnotherData' => 'I am another data'];

    $response = Yii::$app->response;
    $response->format = \yii\web\Response::FORMAT_JSON;
    $response->data = $returnData;

    return $response;
}

Answer 4

$this->layout=false;
header('Content-type: application/json');
echo json_encode($arr);
Yii::app()->end(); 

Answer 5

class JsonController extends CController {

    protected $jsonData;

    protected function beforeAction($action) {
        ob_clean(); // clear output buffer to avoid rendering anything else
        header('Content-type: application/json'); // set content type header as json
        return parent::beforeAction($action);
    }

    protected function afterAction($action) {
        parent::afterAction($action);
        exit(json_encode($this->jsonData)); // exit with rendering json data
    }

}

class ApiController extends JsonController {

    public function actionIndex() {
        $this->jsonData = array('test');
    }

}

Answer 6

one more simple way by using

echo CJSON::encode($result);

example code:

public function actionSearch(){
    if (Yii::app()->request->isAjaxRequest && isset($_POST['term'])) {
            $models = Model::model()->searchNames($_POST['term']);
            $result = array();
            foreach($models as $m){
                $result[] = array(
                        'name' => $m->name,
                        'id' => $m->id,
                );


            }
            echo CJSON::encode($result);
        }
}

cheers :)

Answer 7

In the controller action that you want to render JSON data, e.g: actionJson()

public function actionJson(){
    $this->layout=false;
    header('Content-type: application/json');
    echo CJSON::encode($data);
    Yii::app()->end(); // equal to die() or exit() function
}

See more Yii API

Answer 8

Yii::app()->end()

I think this solution is not the best way to end application flow, because it uses PHP's exit() function, witch means immediate exit from execution flow. Yes, there is Yii's onEndRequest handler, and PHP's register_shutdown_function but it still remains too fatalistic.

For me the better way is this

public function run($actionID) 
{
    try
    {
        return parent::run($actionID);
    }
    catch(FinishOutputException $e)
    {
        return;
    }
}

public function actionHello()
{
    $this->layout=false;
    header('Content-type: application/json');
    echo CJavaScript::jsonEncode($arr);
    throw new FinishOutputException;
}

So, the application flow continues to execute even after.