JSON形式のファイルを_serializeを使って表示できない

Question

前提・実現したいこと

CakePHP3を使い、Ajax通信でデータベースからデーターを取得するソースを作成しています

発生している問題・エラーメッセージ

こちらの質問を参考に、このようなソースをコントローラにかきました(一部省略)

$this->set('res', $res);
$this->set('_serialize', ['res']);

すると何も表示されず、開発者ツールではパースが失敗している？ようなエラーが出ていました

何かエラーに心当たりのある方がいらっしゃいましたら、教えていただけますと幸いです

該当のソースコード

現在コードが入ったUSBを外出先に忘れてきてしまっています。
USBを回収した後に追記いたします。

動作確認に必要そうなコントローラ、ビューファイルを追記いたしました。

不足な点があれば、修正依頼を頂けると幸いです。
下のソースコードではecho json_encode($this->paginate($query))を使い、サーバから結果を返すようになっていますが、その部分をset _serializeを用いた手法に変えた際にうまく動かなくなってしまいます。

src/Controller/ArticlesController.php(viewアクション、paginatorで使う部分を抜粋)

        public $paginate = [
                'limit' => 5,
                'maxLimit' => 10
        ];

        public function initialize()
        {
                parent::initialize();
                $this->loadComponent('Security');
                $this->loadComponent('Paginator');
        }

        public function view($id = null)
        {
                $article = $this->Articles->get($id);
                $comment = $this->Articles->Comments->newEntity();
                $query = $this->Articles->Comments->find()->where(["article_id" => $id]);
                $this->set(compact("article", "comment"));
                $this->set("comments", $this->paginate($query));
        }

src/Template/Articles/view.ctp

<h1><?= h($article->title) ?></h1>
<p><?= h($article->name) ?></p>
<p><?= h($article->body) ?></p>
<p><small>Created: <?= $article->created->format(DATE_RFC850) ?></small></p>
<hr>

<?php
        echo $this->Form->create($comment, ["url" => ["controller" => "Comments", "action" => "add"]]);
        echo $this->Form->control('title');
        echo $this->Form->control('body', ['rows' => '3']);
        echo $this->Form->hidden("article_id", ["default"=>h($article->id)]);
        echo $this->Form->button(__('Save Article'));
        echo $this->Form->end();
?>
<?php if (!$comments->isEmpty()): ?>

        <?php foreach ($comments as $comment): ?>
                <?php var_dump($comment) ?>
        <?php endforeach; ?>
        <?php $this->Paginator->options([
                'url' => [
                        'controller' => 'Comments',
                        'action' => 'get'
                ]
        ]); ?>
        <ul class="pagination">
                <?= $this->Paginator->first('<<') ?>
                <?= $this->Paginator->prev('<') ?>
                <?php if (!empty($this->Paginator->numbers())): ?>
                        <?= $this->Paginator->numbers() ?>
                <?php else: ?>
                        <li><?= $this->Paginator->current("Comments") ?></li>
                <?php endif; ?>
                <?= $this->Paginator->next('>') ?>
                <?= $this->Paginator->last('>>') ?>
        </ul>
<?php else: ?>
        <p>この記事にはまだコメントがありません。</p>
<?php endif; ?>

<hr>

<div id="result">
</div>


<script>
        $(function () {
                $(".pagination a").on("click", function () {
                        $.getJSON($(this).attr("href"), { article_id: <?= $article->id ?>  }, function (data){
                                console.log(data);
                        });
                        return false;
                });
        });
</script>

Controller/CommentsController.php(コメント取得部分等を抜粋、コメント追加アクション等一部は省略)

<?php
namespace App\Controller;

class CommentsController extends AppController
{
        public $paginate = [
                'limit' => 5,
                'maxLimit' => 10
        ];

        public function __construct($request, $response)
        {
                parent::__construct($request, $response);
                $this->autoRender = false;
        }

        public function initialize()
        {
                parent::initialize();
                $this->loadComponent('Security');
                $this->loadComponent('Paginator');
                $this->loadComponent('RequestHandler');
        }


        public function get()
        {
                $id = $this->request->getQuery("article_id");
                $query = $this->Comments->find()->where(["article_id" => $id]);
                $this->response->charset("UTF-8");
                $this->response->type("json");
                echo json_encode($this->paginate($query));
        }
}

Model/Table/ArticlesTable.php

<?php
namespace App\Model\Table;

use Cake\ORM\Table;
use Cake\Validation\Validator;

class ArticlesTable extends Table
{
        public function initialize(array $config)
        {
                $this->addBehavior("Timestamp");
                $this->hasMany("Comments")
                    ->setDependent(true);
        }

        public function validationDefault(Validator $validator)
        {
                $validator
                        ->notEmpty("title")
                        ->requirePresence("title")
                        ->notEmpty("name")
                        ->requirePresence("name")
                        ->notEmpty("body")
                        ->maxLength("body", 140, "140")
                        ->requirePresence("body");

                return $validator;
        }
}

src/Model/Table/CommentsTable.php

<?php
namespace App\Model\Table;

use Cake\ORM\Table;
use Cake\Validation\Validator;

class CommentsTable extends Table
{
    public function initialize(array $config)
    {
        $this->addBehavior('Timestamp');
        $this->belongsTo("Articles");
    }

    public function validationDefault(Validator $validator)
    {
        $validator
            ->notEmpty('title')
            ->requirePresence('title')
            ->notEmpty('body')
            ->requirePresence('body');

        return $validator;
    }
}

Commentsテーブルの構造も記載いたします。
article_idに外部キーを用いてコメントの属する記事を参照するようにしています。

CREATE TABLE `comments` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `article_id` int(10) unsigned NOT NULL,
  `title` varchar(255) NOT NULL,
  `body` text,
  `created` datetime DEFAULT NULL,
  PRIMARY KEY (`id`),
  KEY `article_key` (`article_id`),
  CONSTRAINT `comments_ibfk_1` FOREIGN KEY (`article_id`) REFERENCES `articles` (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=8 DEFAULT CHARSET=utf8mb4

試したこと

• echo json_encode($res); -> 無事表示できた。開発者ツールでのエラーもなし

• Content-Typeの指定 -> もともとしてあった

• popobotさんにご回答頂いた内容を参考に、CommentsControllerを編集した -> Missing Templateエラーが発生した

Controller/CommentsController.php(コメント取得部分等を抜粋、コメント追加アクション等一部は省略)

<?php
namespace App\Controller;

class CommentsController extends AppController
{
        public $paginate = [
                'limit' => 5,
                'maxLimit' => 10
        ];

        public function __construct($request, $response)
        {
                parent::__construct($request, $response);
        }

        public function initialize()
        {
                parent::initialize();
                $this->loadComponent('Security');
                $this->loadComponent('Paginator');
                $this->loadComponent('RequestHandler');
        }

        public function get()
        {
                $id = $this->request->getQuery("article_id");
                $query = $this->Comments->find()->where(["article_id" => $id]);
                $this->response->charset("UTF-8");
                $this->response->type("json");
                $response = ($this->paginate($query));
                $this->set("response", $response);
                $this->set("_serialize", ["response"]);
        }
}

何かエラーに心当たりのある方がいらっしゃいましたら、教えていただけますと幸いです
よろしくお願いいたします

Answer 1

$this->autoRender = false; がよくない気がします。

この設定をすると、Viewの描画処理がされなくなるので、jsonをシリアライズする機能も動かなくなるのではないかと

Comments

[nnafa]

ご回答頂きありがとうございます！

autoRenderが原因とのことですが、まさしくその通りでした
しかしautoRenderを指定しないと、ブラウザから直接アクセスした際のみ、アクションを終了した後にビューファイルを読み込もうとしてMissing Templateエラーになってしまいます

CommentsControllerにはリクエストのパラメーターからjson形式のデータを返すだけのアクションしかないため、ビューファイルは不要となっています。なので、エラーを抑制するためにビューファイルを作成することは可能な限り控えたいと考えております

上述の問題を解決する方法について、ご存知ありませんか？
よろしくお願いいたします

[nnafa]

質問の 試したこと に編集後のCommentsControllerのソースを記載いたしました。

[popobot]

jsonしか許容したくないのであれば、以下を代わりに設定したらどうでしょうか

$this->request->allowMethod("json");

他の形式でアクセスした場合、405 Method Not Allowed を返すようになるのでこの方法が適切ではないかと

なお、設定する箇所は、__constructよりはinitializeの方が適切だと思います。

[nnafa]

ご返信ありがとうございます。
autoRenderを削除しご回答頂いたソースを書くと、仰る通りの挙動になりました

allowMethod()はHTTPリクエストメソッドしか設定できないものと思っていたので驚きました。コンテンツタイプもチェックできる（？）のですね。今後活用して行こうと思います

･･･ちなみに私の方でも試行錯誤をした所、405は返しませんが、`$this->RequestHandler->renderAs($this, "json");`でも一応やりたいことはできるとわかりました。

設定する箇所の件、initialize()の方が適切なのですね。
なぜなのか考えてみたのですが、initialize()を実装していればコンストラクターを上書きして親を呼び出す必要がなくなるため、コンストラクターをコールするのは無駄で、全部initialize()でできる。という考えが思い浮かびました（とんちんかんでしたらすみません）

[popobot]

うまくいってよかったです。

initialize()が適切である理由は、自分も明確には言えませんが... CakePHPが初期化のために用意しており、コンストラクタの最後に呼び出されるので、慣習的に初期化に関する処理はここにまとめるのがいいと思っています。
https://book.cakephp.org/3.0/ja/controllers.html#appcontroller

[nnafa]

なるほど、initialize()が適切である理由について、納得できました。

この質問を通して知れたことが多く、とても勉強になりました。
このたびはお付き合い頂き、ありがとうございました！