Skip to content

[ErrorHandler] Added call() method utility to turns any PHP error into \ErrorException #33155

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 1 commit into from
Aug 18, 2019
Merged

[ErrorHandler] Added call() method utility to turns any PHP error into \ErrorException #33155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions src/Symfony/Component/ErrorHandler/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ CHANGELOG
-----

* added the component
* added `ErrorHandler::call()` method utility to turn any PHP error into `\ErrorException`
26 changes: 26 additions & 0 deletions src/Symfony/Component/ErrorHandler/ErrorHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,32 @@ public static function register(self $handler = null, bool $replace = true): sel
return $handler;
}

/**
* Calls a function and turns any PHP error into \ErrorException.
*
* @return mixed What $function(...$arguments) returns
*
* @throws \ErrorException When $function(...$arguments) triggers a PHP error
*/
public static function call(callable $function, ...$arguments)
{
set_error_handler(static function (int $type, string $message, string $file, int $line) {
if (__FILE__ === $file) {
$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 3);
$file = $trace[2]['file'] ?? $file;
$line = $trace[2]['line'] ?? $line;
}

throw new \ErrorException($message, 0, $type, $file, $line);
});

try {
return $function(...$arguments);
} finally {
restore_error_handler();
}
}

public function __construct(BufferingLogger $bootstrappingLogger = null)
{
if ($bootstrappingLogger) {
Expand Down
53 changes: 52 additions & 1 deletion src/Symfony/Component/ErrorHandler/Tests/ErrorHandlerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,62 @@ public function testNotice()
}

// dummy function to test trace in error handler.
private static function triggerNotice($that)
public static function triggerNotice($that)
{
$that->assertSame('', $foo.$foo.$bar);
}

public function testFailureCall()
{
$this->expectException(\ErrorException::class);
$this->expectExceptionMessage('fopen(unknown.txt): failed to open stream: No such file or directory');

ErrorHandler::call('fopen', 'unknown.txt', 'r');
}

public function testCallRestoreErrorHandler()
{
$prev = set_error_handler('var_dump');
try {
ErrorHandler::call('fopen', 'unknown.txt', 'r');
$this->fail('An \ErrorException should have been raised');
} catch (\ErrorException $e) {
$prev = set_error_handler($prev);
restore_error_handler();
} finally {
restore_error_handler();
}

$this->assertSame('var_dump', $prev);
}

public function testCallErrorExceptionInfo()
{
try {
ErrorHandler::call([self::class, 'triggerNotice'], $this);
$this->fail('An \ErrorException should have been raised');
} catch (\ErrorException $e) {
$trace = $e->getTrace();
$this->assertSame(E_NOTICE, $e->getSeverity());
$this->assertSame(__FILE__, $e->getFile());
$this->assertSame('Undefined variable: foo', $e->getMessage());
$this->assertSame(0, $e->getCode());
$this->assertSame('Symfony\Component\ErrorHandler\{closure}', $trace[0]['function']);
$this->assertSame(ErrorHandler::class, $trace[0]['class']);
$this->assertSame('triggerNotice', $trace[1]['function']);
$this->assertSame(__CLASS__, $trace[1]['class']);
}
}

public function testSuccessCall()
{
touch($filename = tempnam(sys_get_temp_dir(), 'sf_error_handler_'));

self::assertIsResource(ErrorHandler::call('fopen', $filename, 'r'));

unlink($filename);
}

public function testConstruct()
{
try {
Expand Down