web-dev-qa-db-ja.com

symfony2コントローラーでjson応答を送信するにはどうすればよいですか

Symfonyで構築されたフォームを編集するためにjQueryを使用しています。

JQueryダイアログでフォームを表示してから送信しています。

データベースにデータが正しく入力されています。

しかし、jQueryにJSONを返送する必要があるかどうかはわかりません。実際、私はJSONのことと少し混同しています。

JQueryを使用してテーブルに行を追加し、フォームを送信した後、データを送信した後、それらの行データを送り返し、追加されたデータを表示するためにテーブル行を動的に追加するとします。

私はそのデータを取り戻す方法が混乱しています

これは私の現在のコードです

$editForm = $this->createForm(new StepsType(), $entity);

$request = $this->getRequest();

$editForm->bindRequest($request);

if ($editForm->isValid()) {
    $em->persist($entity);
    $em->flush();

    return $this->render('::success.html.twig');               
}

これは成功メッセージのある単なるテンプレートです

phpjavascriptjsonsymfony
87
user825904

Symfony 2.1

$response = new Response(json_encode(array('name' => $name)));
$response->headers->set('Content-Type', 'application/json');

return $response;

Symfony 2.2以降

特別な JsonResponse クラスがあり、配列をJSONにシリアル化します：

return new JsonResponse(array('name' => $name));

ただし、問題がエンティティのシリアル化方法の場合は、 JMSSerializerBundle を参照してください。

あなたがそれをインストールしていると仮定すると、あなたは単にする必要があります

$serializedEntity = $this->container->get('serializer')->serialize($entity, 'json');

return new Response($serializedEntity);

StackOverflowでも同様の問題を確認する必要があります。

186
Vitalii Zurian

Symfony 2.1には JsonResponse クラスがあります。

return new JsonResponse(array('name' => $name));

渡された配列はJSONエンコードされ、ステータスコードはデフォルトで200になり、コンテンツタイプはapplication/jsonに設定されます。

JSONP用の便利なsetCallback関数もあります。

55
jmaloney

Symfony 3.1以降では、JSONヘルパーを使用できます http://symfony.com/doc/current/book/controller.html#json-helper

public function indexAction()
{
// returns '{"username":"jane.doe"}' and sets the proper Content-Type header
return $this->json(array('username' => 'jane.doe'));

// the shortcut defines three optional arguments
// return $this->json($data, $status = 200, $headers = array(), $context = array());
}
15
Bettinz

@thecatontheflat回答を完了するには、アクションをtry ... catchブロック内にラップすることもお勧めします。これにより、JSONエンドポイントが例外で壊れることがなくなります。私が使用するスケルトンは次のとおりです。

public function someAction()
{
    try {

        // Your logic here...

        return new JsonResponse([
            'success' => true,
            'data'    => [] // Your data here
        ]);

    } catch (\Exception $exception) {

        return new JsonResponse([
            'success' => false,
            'code'    => $exception->getCode(),
            'message' => $exception->getMessage(),
        ]);

    }
}

これにより、エラーが発生した場合でもエンドポイントは一貫して動作し、クライアント側でそれらを正しく処理できます。

9
Slava Fomin II

データが既にシリアル化されている場合：

a）JSON応答を送信する

public function someAction()
{
    $response = new Response();
    $response->setContent(file_get_contents('path/to/file'));
    $response->headers->set('Content-Type', 'application/json');
    return $response;
}

b）JSONP応答を送信します（コールバック付き）

public function someAction()
{
    $response = new Response();
    $response->setContent('/**/FUNCTION_CALLBACK_NAME(' . file_get_contents('path/to/file') . ');');
    $response->headers->set('Content-Type', 'text/javascript');
    return $response;
}

データをシリアル化する必要がある場合：

c）JSON応答を送信する

public function someAction()
{
    $response = new JsonResponse();
    $response->setData([some array]);
    return $response;
}

d）JSONP応答を送信する（コールバックを使用）

public function someAction()
{
    $response = new JsonResponse();
    $response->setData([some array]);
    $response->setCallback('FUNCTION_CALLBACK_NAME');
    return $response;
}

e）Symfony 3.x.xでグループを使用する

エンティティ内にグループを作成

<?php

namespace Mindlahus;

use Symfony\Component\Serializer\Annotation\Groups;

/**
 * Some Super Class Name
 *
 * @ORM    able("table_name")
 * @ORM\Entity(repositoryClass="SomeSuperClassNameRepository")
 * @UniqueEntity(
 *  fields={"foo", "boo"},
 *  ignoreNull=false
 * )
 */
class SomeSuperClassName
{
    /**
     * @Groups({"group1", "group2"})
     */
    public $foo;
    /**
     * @Groups({"group1"})
     */
    public $date;

    /**
     * @Groups({"group3"})
     */
    public function getBar() // is* methods are also supported
    {
        return $this->bar;
    }

    // ...
}

アプリケーションのロジック内でDoctrineオブジェクトを正規化する

<?php

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
// For annotations
use Doctrine\Common\Annotations\AnnotationReader;
use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
use Symfony\Component\Serializer\Serializer;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Encoder\JsonEncoder;

...

$repository = $this->getDoctrine()->getRepository('Mindlahus:SomeSuperClassName');
$SomeSuperObject = $repository->findOneById($id);

$classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
$encoder = new JsonEncoder();
$normalizer = new ObjectNormalizer($classMetadataFactory);
$callback = function ($dateTime) {
    return $dateTime instanceof \DateTime
        ? $dateTime->format('m-d-Y')
        : '';
};
$normalizer->setCallbacks(array('date' => $callback));
$serializer = new Serializer(array($normalizer), array($encoder));
$data = $serializer->normalize($SomeSuperObject, null, array('groups' => array('group1')));

$response = new Response();
$response->setContent($serializer->serialize($data, 'json'));
$response->headers->set('Content-Type', 'application/json');
return $response;
8
Avram Cosmin