Skip to content

Echo'ing exceptions causes trouble if the exception throws an exception #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 23, 2016
Merged

Echo'ing exceptions causes trouble if the exception throws an exception #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e07bc2f
stop advocating echo'ing the exception as it hides by-effect exceptions
lode Jan 23, 2016
54ad07c
make sure the debug flag is set when using the exception class
lode Jan 23, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions examples/errors_exception_direct.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
* @note previous exceptions will be added as well
* @note exceptions only output file, line, trace if the display_errors directive is true
* you can tune it with that, or by setting jsonapi\base::$debug to false
* @note echo'ing the exception has the same effect as using ->send_response()
*/

try {
Expand All @@ -22,7 +21,6 @@
$about_link = 'www.example.com/search';
throw new jsonapi\exception('unknown user', $http_status, $previous=null, $friendly_message, $about_link);
}
catch (Exception $e) {
echo $e;
exit;
catch (jsonapi\exception $e) {
$e->send_response();
}
12 changes: 11 additions & 1 deletion src/exception.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ class exception extends \Exception {
* i.e. a link to the api documentation
*/
public function __construct($message='', $code=0, $previous=null, $friendly_message=null, $about_link=null) {
// exception is the only class not extending base
new base();

parent::__construct($message, $code, $previous);

if ($friendly_message) {
Expand Down Expand Up @@ -70,16 +73,23 @@ public function set_about_link($about_link) {
public function send_response($content_type=null, $encode_options=null, $response=null) {
$jsonapi = new errors($this, $this->friendly_message, $this->about_link);
$jsonapi->send_response($content_type, $encode_options, $response);
exit;
exit; // sanity check
}

/**
* alias for ->send_response()
*
* @deprecated as this causes hard to debug issues ..
* .. when exceptions are called as a by-effect of this function
*
* @return string empty for sake of correctness
* as ->send_response() already echo's the json and terminates script execution
*/
public function __toString() {
if (base::$debug) {
trigger_error('toString conversion of exception is deprecated, use ->send_response() instead', E_USER_DEPRECATED);
}

$this->send_response();
return '';
}
Expand Down