Comment obtenir de réponse au format json(application/json) dans yii?

Comment obtenir de réponse au format json(application/json) dans yii?

InformationsquelleAutor tq0fqeu | 2010-05-13
  1. 86

    Pour Yii 1:

    De créer cette fonction dans votre (de base) Contrôleur:

    /**
 * 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();
}

    Puis il suffit d'appeler à la fin de votre action:

    $this->renderJSON($yourData);

    Pour Yii 2:

    Yii 2 dispose de cette fonctionnalité intégrée, utilisez le code suivant à la fin de votre action de contrôleur:

    Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;
return $data;
    • J'ai remarqué que la définition de la header() ou Yii::app()->end(); ne fait aucune différence. Dans Chrome Developer Tools, si vous remarquez l' en-Tête de Réponse sous Header onglet, ils donnent tous le même Contenu de Longueur. Si l'ajax a été faite avec la sortie attendue dans la "json", format, alors même si le HTML est envoyé au navigateur/jQuery traite que de la réponse json. Et il semble que cela fonctionne dans tous les navigateurs modernes. Cependant, je n'ai pas de nier que le réglage de l'en-tête() est une bonne chose.
    • Au lieu de désactiver le web journal des routes, cette approche sera plus robuste (pas encore testé): ~~~ ob_start(); Yii::app()->fin(0, false); ob_end_clean(); exit(0);
    • Construit dans la façon de le faire est de stackoverflow.com/a/32346042/1670956
    InformationsquelleAutor marcovtwout
  2. 18
    $this->layout=false;
header('Content-type: application/json');
echo CJavaScript::jsonEncode($arr);
Yii::app()->end();
    • Aussi n'oubliez pas de désactiver WebLogRoutes avant d'appeler Yii::app()->end(), ou les informations de débogage peut obtenir de joindre à votre json et potentiellement la rend invalide.
    • assez sûr que la fin() désactive les logs, c'est pourquoi je l'ai ajouté ici
    • Il ne le fait pas. fin(): "met fin à l'application. Cette méthode remplace PHP de la fonction exit() en appelant onEndRequest avant de quitter." Et dans CLogRouter (yiiframework.com/doc/api/1.1/CLogRouter#processLogs-detail): "Cette méthode est un gestionnaire d'événement à l'CApplication::onEndRequest événement."
    • oui, vous avez raison. Je pensais que exit() qui se termine par l'application avant de Yii pouvez donc pas de journal.
    • Construit dans la façon de le faire est de stackoverflow.com/a/32346042/1670956
    InformationsquelleAutor Neil McGuigan
  3. 15

    Pour Yii2 à l'intérieur d'un contrôleur:

    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;
}
    • Ce doit avoir été accepté de répondre. +1 pour la suite de Yii de l'api.
    • Merci Monsieur! ^-^
    InformationsquelleAutor Sergey Onishchenko
  4. 9
    $this->layout=false;
header('Content-type: application/json');
echo json_encode($arr);
Yii::app()->end();
    • json_encode ne fonctionne pas avec les modèles
    • Quelques tewaks: utilisation CJSON::encode() pour les modèles; pas besoin de faire $this->layout=false depuis Yii::app()->end() mettra fin à l'application sans la sortie de la mise en page.
    • Je pense que c'est mieux vous modifiez la meilleure réponse à @marcovtwout
    InformationsquelleAutor tq0fqeu
  5. 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');
    }

}
    InformationsquelleAutor Andrey Mischenko
  6. 0

    un moyen plus simple en utilisant 

    echo CJSON::encode($result);

    exemple de 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 🙂

    InformationsquelleAutor Developer
  7. 0

    Dans le contrôleur de l'action que vous souhaitez rendre JSON de données, 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
}

    Voir plus Yii API

    InformationsquelleAutor Truongnq
  8. -1
    Yii::app()->end()

    Je pense que cette solution n'est pas la meilleure façon de mettre fin à l'application de flux, car il utilise PHP exit() fonction, ce qui signifie immédiate de sortie du flux d'exécution. Oui, il y a Yii est onEndRequest gestionnaire, et de PHP register_shutdown_function mais il reste encore trop fataliste.

    Pour moi la meilleure manière est-ce

    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;
}

    Ainsi, le flux de l'application continue de s'exécuter même après.

    • Si vous avez déjà mis layout=false, un simple "retour" va faire? Peut même être omis. Je ne vois aucune raison de try/catch et de créer sur mesure d'exception.
    • C'est juste une mauvaise. Lancement d'une Exception à la sortie de la réponse.
    • Maintenant, après un certain temps, je suis totalement d'accord que l'utilisation d'exceptions pour gérer contrôleur/logique de présentation est erronée.
    InformationsquelleAutor Mihailoff