added documentation for the new Debug component #2479
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| .. index:: | ||
| single: Debug | ||
| single: Components; Debug | ||
|
|
||
| The Debug Component | ||
| =================== | ||
|
|
||
| The Debug Component provides tools to ease debugging PHP code. | ||
|
|
||
| .. versionadded:: 2.3 | ||
| The Debug Component is new to Symfony 2.3. Previously, the classes were | ||
| located in the ``HttpKernel`` component. | ||
|
|
||
| Installation | ||
| ------------ | ||
|
|
||
| You can install the component in many different ways: | ||
|
|
||
| * Use the official Git repository (https://github.com/symfony/Debug); | ||
| * :doc:`Install it via Composer </components/using_components>` (``symfony/debug`` on `Packagist`_). | ||
|
|
||
| Usage | ||
| ----- | ||
|
|
||
| The Debug component provides several tools to help you debug PHP code. | ||
| Enabling them all is as easy as it can get:: | ||
|
|
||
| use Symfony\Component\Debug\Debug; | ||
|
|
||
| Debug::enable(); | ||
|
|
||
| The :method:`Symfony\\Component\\Debug\\Debug::enable` method registers an | ||
| error handler and an exception handler. If the :doc:`ClassLoader component | ||
| </components/class_loader>` is available, a special class loader is also | ||
|
There was a problem hiding this comment. I prefer to have rules on 1 line: [...] If the
:doc:`ClassLoader component </components/class_loader>` is available,
a special [...]There was a problem hiding this comment. That's not what we are doing elsewhere. I don't format things by hand but via my text editor. There was a problem hiding this comment. It's something I always say on PRs and it's something that's done in all documents as far as I can see. There was a problem hiding this comment. ok, I will let you reformat what you think is best. |
||
| registered. | ||
|
|
||
| Read the following sections for more information about the different available | ||
| tools. | ||
|
|
||
| .. caution:: | ||
|
|
||
| You should never enable the debug tools in a production environment as | ||
| they might disclose sensitive information to the user. | ||
|
|
||
| Enabling the Error Handler | ||
| -------------------------- | ||
|
|
||
| The :class:`Symfony\\Component\\Debug\\ErrorHandler` class catches PHP errors | ||
| and converts them to exceptions (of class :phpclass:`ErrorException` or | ||
| :class:`Symfony\\Component\\Debug\\Exception\\FatalErrorException` for PHP | ||
| fatal errors):: | ||
|
|
||
| use Symfony\Component\Debug\ErrorHandler; | ||
|
|
||
| ErrorHandler::register(); | ||
|
|
||
| Enabling the Exception Handler | ||
| ------------------------------ | ||
|
|
||
| The :class:`Symfony\\Component\\Debug\\ExceptionHandler` class catches | ||
| uncaught PHP exceptions and converts them to a nice PHP response. It is useful | ||
| in debug mode to replace the default PHP/XDebug output with something prettier | ||
| and more useful:: | ||
|
|
||
| use Symfony\Component\Debug\ExceptionHandler; | ||
|
|
||
| ExceptionHandler::register(); | ||
|
|
||
| .. note:: | ||
|
|
||
| If the :doc:`HttpFoundation component </components/http_foundation>` is | ||
| available, the handler uses a Symfony Response object; if not, it falls | ||
| back to a regular PHP response. | ||
|
|
||
| .. _Packagist: https://packagist.org/packages/symfony/debug | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You should add the note saying it is new in 2.3, extracting code from HttpKernel (see how it is done for PropertyAccess)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed