php - How to change exception message of Exception object?

Solution:

For almost every single case under the sun, you should throw a new Exception with the old Exception attached.

try {
    dodgyCode();
}
catch(\Exception $oldException) {
    throw new MyException('My extra information', 0, $oldException);
}
Copy code

Every once in a while though, you do actually need to manipulate an Exception in place, because throwing another Exception isn't actually what you want to do.

A good example of this is in BehatFeatureContext when you want to append additional information in an@AfterStep method. After a step has failed, you may wish to take a screenshot, and then add a message to the output as to where that screenshot can be seen.

So in order to change the message of an Exception where you can just replace it, and you can't throw a new Exception, you can use reflection to brute force the parameters value:

$message = " - My appended message";

$reflectionObject = new \ReflectionObject($exception);
$reflectionObjectProp = $reflectionObject->getProperty('message');
$reflectionObjectProp->setAccessible(true);
$reflectionObjectProp->setValue($exception, $exception->getMessage() . $message);
Copy code

Here's that example the Behat in context:

    /**
     * Save screen shot on failure
     * @AfterStep
     * @param AfterStepScope $scope
     */
    public function saveScreenShot(AfterStepScope $scope) {
        if (!$scope->getTestResult()->isPassed()) {
            try {
                $screenshot = $this->getSession()->getScreenshot();
                if($screenshot) {
                    $filename = $this->makeFilenameSafe(
                        date('YmdHis')."_{$scope->getStep()->getText()}"
                    );
                    $filename = "{$filename}.png";
                    $this->saveReport(
                        $filename,
                        $screenshot
                    );
                    $result = $scope->getTestResult();
                    if($result instanceof ExceptionResult && $result->hasException()) {
                        $exception = $result->getException();

                        $message = "\nScreenshot saved to {$this->getReportLocation($filename)}";

                        $reflectionObject = new \ReflectionObject($exception);
                        $reflectionObjectProp = $reflectionObject->getProperty('message');
                        $reflectionObjectProp->setAccessible(true);
                        $reflectionObjectProp->setValue($exception, $exception->getMessage() . $message);
                    }
                }
            }
            catch(UnsupportedDriverActionException $e) {
                // Overly specific catch
                // Do nothing
            }
        }
    }
Copy code

Again, you should never do this if you can avoid it.

Source: My old boss

Solution:

Just do this, it works I tested it.

<?php

class Exception2 extends Exception{

    public function setMessage($message){
        $this->message = $message;
    }
    
}

$error = new Exception2('blah');

$error->setMessage('changed');

throw $error;
Copy code

Solution:

You can't change Exception message.

You can however determine it's class name and code, and throw a new one, of the same class, with same code, but with different message.

Solution:

You can extend Exception and use the parent::__construct to set your message. This gets around the fact that you cannot override getMessage().

class MyException extends Exception {
    function __construct() {
        parent::__construct("something failed or malfunctioned.");
    }
}
Copy code

Solution:

here a generified snippet i'm using.

    foreach ($loop as $key => $value) 
    {
        // foo($value);
        thow new Special_Exception('error found')
    }
    catch (Exception $e)
    {
        $exception_type = get_class($e);
        throw new $exception_type("error in $key :: " . $e->getMessage());
    }
Copy code

Solution:

An ugly hack if you don't know which kind of exception you're handling (that can have its own properties) is to use reflection.

    try {
        // business code
    } catch (\Exception $exception) {
        $reflectedObject = new \ReflectionClass(get_class($exception));
        $property = $reflectedObject->getProperty('message');
        $property->setAccessible(true);
        $property->setValue($exception, "new message");
        $property->setAccessible(false);
        throw $exception;
    }
Copy code

You should use this crap wisely in very specific case when you don't have any other choice.

Solution:

You can't change the message given by the Exception class. If you wanted a custom message, you would need to check the error code using $e->getCode() and create your own message.

Solution:

If you really wanted to do this (in the only situation I can think that you might want to do it), you could re-throw the exception:

function throwException() {
    throw new Exception( 'Original' );
}

function rethrowException() {
    try {
        throwException();
    } catch( Exception $e ) {
        throw new Exception( 'Rethrow - ' . $e->getMessage() );
    }
}

try {
    rethrowException();
} catch( Exception $e ) {
    echo $e->getMessage();
}
Copy code

Solution:

You can extend Exception with your own, and put a setter in it

class MyException extends Exception
{
  private $myMessage = '';
  public function getMessage()
  {
    if ($this->myMessage === '') {
    return parent::getMessage();
  } else {
    return $this->myMessage;
  }

  public function setMessage($msg)
  {
    $this->myMessage = $msg;
  }
}
Copy code

Solution:

The php Exception class has a__toString() method which is the only method within the Exception class that is notfinal, meaning it can be customised.

class HelloMessage extends Exception {
    function __toString() {
        return $this->getMessage()." you have an error with code: ".$this->getCode();
    }
}
Copy code

You use it as follows withintry-catch block:

try {
    if (2 > 0) {
        throw new HelloMessage("Hello", 10);
    }
} catch (HelloMessage $e) {
    echo $e;
}
Copy code

Output would be:

Hello you have an error with code: 10
Copy code

Solution:

This is an improved version of David Chan's answer. It's a re-throw solution which usesget_class to rethrow the same exception type, and it passes all parameters to the constructor, even in the case of , which has six rather than three constructor parameters.

foreach ($loopvar as $key => $value) 
{
    doSomethingThatMightThrow($value);
}
catch (\Exception $e)
{
    $exception_type = get_class($e);
    $new_message = "[key '" . $key . "'] " . $e->getMessage();
    if ($e instanceof \ErrorException) {
        throw new $exception_type($new_message, $e->getCode(), $e->getSeverity(), $e->getFile(), $e->getLine(), $e);
    }
    throw new $exception_type($new_message, $e->getCode(), $e);
}
Copy code