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

Already on GitHub? Sign in to your account

[Debug] added the component (closes #6828, closes #6834, closes #7330) #7441

Merged
merged 7 commits into from Apr 7, 2013
View
@@ -3,8 +3,8 @@ UPGRADE FROM 2.x to 3.0
### ClassLoader
- * The `UniversalClassLoader` class has been removed in favor of `ClassLoader`. The only difference is that some method
- names are different:
+ * The `UniversalClassLoader` class has been removed in favor of
+ `ClassLoader`. The only difference is that some method names are different:
* `registerNamespaces()` -> `addPrefixes()`
* `registerPrefixes()` -> `addPrefixes()`
@@ -34,6 +34,16 @@ UPGRADE FROM 2.x to 3.0
* `Symfony\Bridge\Monolog\Logger`
* `Symfony\Component\HttpKernel\Log\NullLogger`
+ * The `Symfony\Component\HttpKernel\Kernel::init()` method has been removed.
@bamarni

bamarni Mar 20, 2013

Contributor

Could this be reconsidered (or at least rediscussed)? maybe in a separate PR (as this is not a blocking step for creating this standalone component)?

+
+ * The following classes have been renamed as they have been moved to the
+ Debug component:
+
+ * `Symfony\Component\HttpKernel\Debug\ErrorHandler` -> `Symfony\Component\Debug\ErrorHandler`
+ * `Symfony\Component\HttpKernel\Debug\ExceptionHandler` -> `Symfony\Component\Debug\ExceptionHandler`
+ * `Symfony\Component\HttpKernel\Exception\FatalErrorException` -> `Symfony\Component\Debug\Exception\FatalErrorException`
+ * `Symfony\Component\HttpKernel\Exception\FlattenException` -> `Symfony\Component\Debug\Exception\FlattenException`
+
### Routing
* Some route settings have been renamed:
@@ -0,0 +1,3 @@
+vendor/
+composer.lock
+phpunit.xml
@@ -0,0 +1,7 @@
+CHANGELOG
+=========
+
+2.3.0
+-----
+
+ * added the component
@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Debug;
+
+use Symfony\Component\ClassLoader\DebugClassLoader;
+
+/**
+ * Registers all the debug tools.
+ *
+ * @author Fabien Potencier <fabien@symfony.com>
+ */
+class Debug
+{
+ private static $enabled = false;
+
+ /**
+ * Enables the debug tools.
+ *
+ * This method registers an error handler and an exception handler.
+ *
+ * If the Symfony ClassLoader component is available, a special
+ * class loader is also registered.
+ *
+ * @param integer $errorReportingLevel The level of error reporting you want
@bamarni

bamarni Mar 23, 2013

Contributor

want

+ */
+ public static function enable($errorReportingLevel = null)
+ {
+ if (static::$enabled) {
+ return;
+ }
+
+ static::$enabled = true;
+
+ error_reporting(-1);
+
+ ErrorHandler::register($errorReportingLevel);
+ if ('cli' !== php_sapi_name()) {
+ ExceptionHandler::register();
+ } elseif (!ini_get('log_errors') || ini_get('error_log')) {
+ ini_set('display_errors', 1);
+ }
+
+ if (class_exists('Symfony\Component\ClassLoader\DebugClassLoader')) {
+ DebugClassLoader::enable();
+ }
+ }
+}
@@ -0,0 +1,128 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Debug;
+
+use Symfony\Component\Debug\Exception\FatalErrorException;
+use Psr\Log\LoggerInterface;
+
+/**
+ * ErrorHandler.
+ *
+ * @author Fabien Potencier <fabien@symfony.com>
+ */
+class ErrorHandler
+{
+ const TYPE_DEPRECATION = -100;
+
+ private $levels = array(
+ E_WARNING => 'Warning',
+ E_NOTICE => 'Notice',
+ E_USER_ERROR => 'User Error',
+ E_USER_WARNING => 'User Warning',
+ E_USER_NOTICE => 'User Notice',
+ E_STRICT => 'Runtime Notice',
+ E_RECOVERABLE_ERROR => 'Catchable Fatal Error',
+ E_DEPRECATED => 'Deprecated',
+ E_USER_DEPRECATED => 'User Deprecated',
+ E_ERROR => 'Error',
+ E_CORE_ERROR => 'Core Error',
+ E_COMPILE_ERROR => 'Compile Error',
+ E_PARSE => 'Parse',
+ );
+
+ private $level;
+
+ private $reservedMemory;
+
+ /** @var LoggerInterface */
+ private static $logger;
+
+ /**
+ * Registers the error handler.
+ *
+ * @param integer $level The level at which the conversion to Exception is done (null to use the error_reporting() value and 0 to disable)
+ *
+ * @return The registered error handler
+ */
+ public static function register($level = null)
+ {
+ $handler = new static();
+ $handler->setLevel($level);
+
+ ini_set('display_errors', 0);
+ set_error_handler(array($handler, 'handle'));
+ register_shutdown_function(array($handler, 'handleFatal'));
+ $handler->reservedMemory = str_repeat('x', 10240);
+
+ return $handler;
+ }
+
+ public function setLevel($level)
+ {
+ $this->level = null === $level ? error_reporting() : $level;
+ }
+
+ public static function setLogger(LoggerInterface $logger)
+ {
+ self::$logger = $logger;
+ }
+
+ /**
+ * @throws \ErrorException When error_reporting returns error
+ */
+ public function handle($level, $message, $file, $line, $context)
+ {
+ if (0 === $this->level) {
+ return false;
+ }
+
+ if ($level & (E_USER_DEPRECATED | E_DEPRECATED)) {
+ if (null !== self::$logger) {
+ $stack = version_compare(PHP_VERSION, '5.4', '<') ? array_slice(debug_backtrace(false), 0, 10) : debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 10);
+
+ self::$logger->warning($message, array('type' => self::TYPE_DEPRECATION, 'stack' => $stack));
+ }
+
+ return true;
+ }
+
+ if (error_reporting() & $level && $this->level & $level) {
+ throw new \ErrorException(sprintf('%s: %s in %s line %d', isset($this->levels[$level]) ? $this->levels[$level] : $level, $message, $file, $line), 0, $level, $file, $line);
+ }
+
+ return false;
+ }
+
+ public function handleFatal()
+ {
+ if (null === $error = error_get_last()) {
+ return;
+ }
+
+ unset($this->reservedMemory);
+ $type = $error['type'];
+ if (0 === $this->level || !in_array($type, array(E_ERROR, E_CORE_ERROR, E_COMPILE_ERROR, E_PARSE))) {
+ return;
+ }
+
+ // get current exception handler
+ $exceptionHandler = set_exception_handler(function() {});
+ restore_exception_handler();
+
+ if (is_array($exceptionHandler) && $exceptionHandler[0] instanceof ExceptionHandler) {
+ $level = isset($this->levels[$type]) ? $this->levels[$type] : $type;
+ $message = sprintf('%s: %s in %s line %d', $level, $error['message'], $error['file'], $error['line']);
+ $exception = new FatalErrorException($message, 0, $type, $error['file'], $error['line']);
+ $exceptionHandler[0]->handle($exception);
+ }
+ }
+}
@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Debug\Exception;
+
+/**
+ * Fatal Error Exception.
+ *
+ * @author Konstanton Myakshin <koc-dp@yandex.ru>
+ */
+class FatalErrorException extends \ErrorException
+{
+}
Oops, something went wrong.