class Exception

Base class for all PHPUnit Framework exceptions.

Ensures that exceptions thrown during a test run do not leave stray references behind.

Every Exception contains a stack trace. Each stack frame contains the 'args' of the called function. The function arguments can contain references to instantiated objects. The references prevent the objects from being destructed (until test results are eventually printed), so memory cannot be freed up.

With enabled process isolation, test results are serialized in the child process and unserialized in the parent process. The stack trace of Exceptions may contain objects that cannot be serialized or unserialized (e.g., PDO connections). Unserializing user-space objects from the child process into the parent would break the intended encapsulation of process isolation.

@no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit

@internal This class is not covered by the backward compatibility promise for PHPUnit

Hierarchy

• class \PHPUnit\Framework\Exception extends \RuntimeException implements \PHPUnit\Exception

Expanded class hierarchy of Exception

See also

http://fabien.potencier.org/article/9/php-serialization-stack-traces-an…

File

vendor/phpunit/phpunit/src/Framework/Exception/Exception.php, line 43

Namespace

class Exception extends RuntimeException implements \PHPUnit\Exception {
    protected array $serializableTrace;
    public function __construct(string $message = '', int|string $code = 0, ?Throwable $previous = null) {
        
        /**
         * @see https://github.com/sebastianbergmann/phpunit/issues/5965
         */
        if (!is_int($code)) {
            $message .= sprintf(' (exception code: %s)', $code);
            $code = 0;
        }
        parent::__construct($message, $code, $previous);
        $this->serializableTrace = $this->getTrace();
        foreach (array_keys($this->serializableTrace) as $key) {
            unset($this->serializableTrace[$key]['args']);
        }
    }
    public function __sleep() : array {
        return array_keys(get_object_vars($this));
    }
    
    /**
     * Returns the serializable trace (without 'args').
     */
    public function getSerializableTrace() : array {
        return $this->serializableTrace;
    }

}

Members