CakePHP3の例外発生時にJSON出力させたい

Question

CakePHP3のHTTP例外「BadRequestException」の発生時にJSON形式で出力させたい場合はどうすれば良いのでしょうか。
ApisControllerからは下記のようなJSON出力、それ以外のコントローラーからはHTMLでエラーを出力させたいと思っています。

{
   "status": "error",
   "message": "Bad Request"
}

公式のCookBookを見たのですが、どのように実装するのか分からず...。
実装方法のヒントなどをご教示ください。

http://book.cakephp.org/3.0/ja/development/errors.html

Answer 1

try{}catch{}で例外を捕まえて、処理をすればよいかと思います

//TestComponent.php

use Cake\Controller\Component;
use Cake\Network\Exception\BadRequestException;

class TestComponent extends Component {


	public function BadRequestError() {
		throw new BadRequestException("TEST");
	}
}

// TestController.php
   public function AjaxTest() {
    	try {

	    	$this->dummy = $this->loadComponent('Test');

	    	$ret = $this->dummy->BadRequestError();

	    	$returnData = array('test'=>'test');

	    	$this->set('data',$returnData);
	    	$this->set('_serialize', ['data']);
    	}
    	catch (\Exception $e) {
    		$exception_name = get_class($e);

    		if ($exception_name == 'Cake\Network\Exception\BadRequestException') {
    			$returnData = array('test'=>'exception!');

    			$this->set('data',$returnData);
    			$this->set('_serialize', ['data']);
    		}
    	}
    }

これで、Ajax経由でjsonのデータが受信できるところまでは、確認しています
課題：
例外をCatchしてBadRequestだけ処理をしているので、それ以外の例外が発生した場合に何も返さず、タイムアウトとなりますので、そこを対処する必要があります

Answer 2

参考程度の情報ですが、別解として... ExceptionRendererを使ってうまく実装できるかもしれません。

ExceptionRendererは処理(catch)されなかったExceptionをエラー画面等で描画していますが、ここをうまく制御すればjsonを返すことができると思います。
http://book.cakephp.org/3.0/ja/development/errors.html#exceptionrenderer

---

追記

Cakephp3は内部でExcptionが発生した場合、リクエスト時のレスポンスのタイプ(jQueryのajaxのdataType等）に従って、レスポンスを返すようです。なので、レスポンスタイプに明示的にjsonを指定しておけば、exceptionの情報もjsonで受け取ることができます。