From 7fef91afd28290ce268f671eb525dedf5ade944d Mon Sep 17 00:00:00 2001 From: Tristan Darricau Date: Tue, 20 Jan 2015 23:08:30 +0100 Subject: [ticket/13361] Rename exception to runtime_exception PHPBB3-13361 --- phpBB/phpbb/exception/exception.php | 52 --------------- phpBB/phpbb/exception/http_exception.php | 2 +- phpBB/phpbb/exception/runtime_exception.php | 52 +++++++++++++++ tests/event/exception_listener.php | 100 ---------------------------- tests/event/exception_listener_test.php | 100 ++++++++++++++++++++++++++++ 5 files changed, 153 insertions(+), 153 deletions(-) delete mode 100644 phpBB/phpbb/exception/exception.php create mode 100644 phpBB/phpbb/exception/runtime_exception.php delete mode 100644 tests/event/exception_listener.php create mode 100644 tests/event/exception_listener_test.php diff --git a/phpBB/phpbb/exception/exception.php b/phpBB/phpbb/exception/exception.php deleted file mode 100644 index 077d0d258a..0000000000 --- a/phpBB/phpbb/exception/exception.php +++ /dev/null @@ -1,52 +0,0 @@ - -* @license GNU General Public License, version 2 (GPL-2.0) -* -* For full copyright and license information, please see -* the docs/CREDITS.txt file. -* -*/ - -namespace phpbb\exception; - -/** - * Class exception - * - * Define an exception which support a language var as message. - */ -class exception extends \RuntimeException implements exception_interface -{ - /** - * Parameters to use with the language var. - * - * @var array - */ - private $parameters; - - /** - * Constructor - * - * @param string $message The Exception message to throw (must be a language variable). - * @param array $parameters The parameters to use with the language var. - * @param \Exception $previous The previous exception used for the exception chaining. - * @param integer $code The Exception code. - */ - public function __construct($message = "", array $parameters = array(), \Exception $previous = null, $code = 0) - { - $this->parameters = $parameters; - - parent::__construct($message, $code, $previous); - } - - /** - * {@inheritdoc} - */ - public function get_parameters() - { - return $this->parameters; - } -} diff --git a/phpBB/phpbb/exception/http_exception.php b/phpBB/phpbb/exception/http_exception.php index f733462a05..0e6ffe4f59 100644 --- a/phpBB/phpbb/exception/http_exception.php +++ b/phpBB/phpbb/exception/http_exception.php @@ -18,7 +18,7 @@ use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface; /** * Class http_exception */ -class http_exception extends exception implements HttpExceptionInterface +class http_exception extends runtime_exception implements HttpExceptionInterface { /** * Http status code. diff --git a/phpBB/phpbb/exception/runtime_exception.php b/phpBB/phpbb/exception/runtime_exception.php new file mode 100644 index 0000000000..6568bbf86f --- /dev/null +++ b/phpBB/phpbb/exception/runtime_exception.php @@ -0,0 +1,52 @@ + +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\exception; + +/** + * Class runtime_exception + * + * Define an exception which support a language var as message. + */ +class runtime_exception extends \RuntimeException implements exception_interface +{ + /** + * Parameters to use with the language var. + * + * @var array + */ + private $parameters; + + /** + * Constructor + * + * @param string $message The Exception message to throw (must be a language variable). + * @param array $parameters The parameters to use with the language var. + * @param \Exception $previous The previous runtime_exception used for the runtime_exception chaining. + * @param integer $code The Exception code. + */ + public function __construct($message = "", array $parameters = array(), \Exception $previous = null, $code = 0) + { + $this->parameters = $parameters; + + parent::__construct($message, $code, $previous); + } + + /** + * {@inheritdoc} + */ + public function get_parameters() + { + return $this->parameters; + } +} diff --git a/tests/event/exception_listener.php b/tests/event/exception_listener.php deleted file mode 100644 index 9d6b70e2d3..0000000000 --- a/tests/event/exception_listener.php +++ /dev/null @@ -1,100 +0,0 @@ - -* @license GNU General Public License, version 2 (GPL-2.0) -* -* For full copyright and license information, please see -* the docs/CREDITS.txt file. -* -*/ - -require_once dirname(__FILE__) . '/../../phpBB/includes/functions.php'; - -class exception_listener extends phpbb_test_case -{ - public function phpbb_exception_data() - { - return array( - array( - true, - new \Exception(), - array( - 'status_code' => 500, - ), - ), - array( - true, - new \Exception('AJAX_ERROR_TEXT'), - array( - 'status_code' => 500, - 'content' => 'AJAX_ERROR_TEXT', - ), - ), - array( - true, - new \phpbb\exception\exception('AJAX_ERROR_TEXT'), - array( - 'status_code' => 500, - 'content' => 'Something went wrong when processing your request.', - ), - ), - array( - true, - new \Symfony\Component\HttpKernel\Exception\HttpException(404, 'AJAX_ERROR_TEXT'), - array( - 'status_code' => 404, - 'content' => 'AJAX_ERROR_TEXT', - ), - ), - array( - true, - new \phpbb\exception\http_exception(404, 'AJAX_ERROR_TEXT'), - array( - 'status_code' => 404, - 'content' => 'Something went wrong when processing your request.', - ), - ), - array( - true, - new \phpbb\exception\http_exception(404, 'CURRENT_TIME', array('today')), - array( - 'status_code' => 404, - 'content' => 'It is currently today', - ), - ), - ); - } - - /** - * @dataProvider phpbb_exception_data - */ - public function test_phpbb_exception($is_ajax, $exception, $expected) - { - $request = \Symfony\Component\HttpFoundation\Request::create('test.php', 'GET', array(), array(), array(), $is_ajax ? array('HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest') : array()); - - $template = $this->getMockBuilder('\phpbb\template\twig\twig') - ->disableOriginalConstructor() - ->getMock(); - - $user = new \phpbb\user('\phpbb\datetime'); - $user->add_lang('common'); - - $exception_listener = new \phpbb\event\kernel_exception_subscriber($template, $user); - - $event = new \Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent(new \phpbb\kernel('test'), $request, \Symfony\Component\HttpKernel\HttpKernelInterface::MASTER_REQUEST, $exception); - $exception_listener->on_kernel_exception($event); - - $response = $event->getResponse(); - - $this->assertEquals($expected['status_code'], $response->getStatusCode()); - $this->assertEquals($is_ajax, $response instanceof \Symfony\Component\HttpFoundation\JsonResponse); - - if (isset($expected['content'])) - { - $this->assertContains($expected['content'], $response->getContent()); - } - } -} diff --git a/tests/event/exception_listener_test.php b/tests/event/exception_listener_test.php new file mode 100644 index 0000000000..4d3453cd83 --- /dev/null +++ b/tests/event/exception_listener_test.php @@ -0,0 +1,100 @@ + +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +require_once dirname(__FILE__) . '/../../phpBB/includes/functions.php'; + +class exception_listener extends phpbb_test_case +{ + public function phpbb_exception_data() + { + return array( + array( + true, + new \Exception(), + array( + 'status_code' => 500, + ), + ), + array( + true, + new \Exception('AJAX_ERROR_TEXT'), + array( + 'status_code' => 500, + 'content' => 'AJAX_ERROR_TEXT', + ), + ), + array( + true, + new \phpbb\exception\runtime_exception('AJAX_ERROR_TEXT'), + array( + 'status_code' => 500, + 'content' => 'Something went wrong when processing your request.', + ), + ), + array( + true, + new \Symfony\Component\HttpKernel\Exception\HttpException(404, 'AJAX_ERROR_TEXT'), + array( + 'status_code' => 404, + 'content' => 'AJAX_ERROR_TEXT', + ), + ), + array( + true, + new \phpbb\exception\http_exception(404, 'AJAX_ERROR_TEXT'), + array( + 'status_code' => 404, + 'content' => 'Something went wrong when processing your request.', + ), + ), + array( + true, + new \phpbb\exception\http_exception(404, 'CURRENT_TIME', array('today')), + array( + 'status_code' => 404, + 'content' => 'It is currently today', + ), + ), + ); + } + + /** + * @dataProvider phpbb_exception_data + */ + public function test_phpbb_exception($is_ajax, $exception, $expected) + { + $request = \Symfony\Component\HttpFoundation\Request::create('test.php', 'GET', array(), array(), array(), $is_ajax ? array('HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest') : array()); + + $template = $this->getMockBuilder('\phpbb\template\twig\twig') + ->disableOriginalConstructor() + ->getMock(); + + $user = new \phpbb\user('\phpbb\datetime'); + $user->add_lang('common'); + + $exception_listener = new \phpbb\event\kernel_exception_subscriber($template, $user); + + $event = new \Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent($this->getMock('Symfony\Component\HttpKernel\HttpKernelInterface'), $request, \Symfony\Component\HttpKernel\HttpKernelInterface::MASTER_REQUEST, $exception); + $exception_listener->on_kernel_exception($event); + + $response = $event->getResponse(); + + $this->assertEquals($expected['status_code'], $response->getStatusCode()); + $this->assertEquals($is_ajax, $response instanceof \Symfony\Component\HttpFoundation\JsonResponse); + + if (isset($expected['content'])) + { + $this->assertContains($expected['content'], $response->getContent()); + } + } +} -- cgit v1.2.1