Archived

forked from https://github.com/symfony/symfony

This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.

Go to file

Fabien Potencier 1b49368617 feature #10640 VarDumper and DebugBundle (jpauli, nicolas-grekas, ruian, moux2003, tony-co, romainneutron, oscherler, lyrixx) This PR was merged into the 2.6-dev branch. Discussion ---------- VarDumper and DebugBundle \| Q \| A \| ------------- \| --- \| Bug fix? \| no \| New feature? \| yes \| BC breaks? \| no \| Deprecations? \| no \| Tests pass? \| yes \| Fixed tickets \| none \| License \| MIT \| Doc PR \| none From a user land point of view, this PR creates a global `dump()` function that is to be used instead of `var_dump()`. The component can be used standalone in any dev workflow. Please see the [provided README](https://github.com/symfony/symfony/pull/10640/files?short_path=52d526f#diff-52d526f19bc9e3825c80e7694755409c) for details. When used with the Framework bundle, variables passed to `dump()` are dumped in a new dedicated panel in the web toolbar. The function is also available in twig templates. Regarding the implementation, I'm pretty sure you'll find a lot to comment. As I'm sure of nothing else, not even the names of things, please do. I tried to organize this PR in several commits, from the most fundamental algorithm to pure Symfony glue. I suggest you follow this order while progressing in the review and the discussion around this PR, so that we can together validate commits one after the other. Don't hesitate to fork the PR and submit PR on it, I'll cherry-pick your patches. TODO: - [x] open a doc PR: https://github.com/symfony/symfony-docs/pull/4243 - [x] open a PR on the Standard edition: https://github.com/symfony/symfony-standard/pull/710 - [x] prefix the CSS classes - [x] tests for the DebugBundle + other Symfony glue classes - [x] inline css and js for compat with e.g. Silex - [x] finish and merge nicolas-grekas/Patchwork-Dumper#5 for better UX - [x] show a dump excerpt on hovering the icon in the toolbar - [x] verify README and comments - [x] validate interfaces/names (Caster / Cloner / Dumper) - [x] validate new VarDumper component + DebugBundle - [x] validate Resource/ext/ vs independent repos. - [x] test and define behavior after KernelEvents::RESPONSE - [x] update dependencies between components/bundles and composer.json files - [x] no hard dep on iconv Not for this PR but might be worth later: - show a light stack trace + timing + memory at debug() calls - create a "theme" concept for custom colors/UX Commits ------- `80fd736` [DebugBundle] Enhance some comments `2e167ba` [TwigBridge] add Twig dump() function + tests and fixes `0f8d30f` [VarDumper] Replace \e with \x1B in CliDumper to support colour in PHP < 5.4 `d43ae82` [VarDumper] Add workaround to https://bugs.php.net/65967 `a8d81e4` [DebugBundle] Inlined assets to avoid installation issues `5f59811` [DebugBundle] Add doc example for Twig usage `e4e00ef` [TwigBridge] DumpNode and Token parser `de05cd9` [DebugBundle] enhance dump excerpts `49f13c6` [HttpKernel] add tests for DumpDataCollector `081363c` [HttpKernel] tests for DumpListener `0d8a942` [VarDumper] add Stub objects for cutting cleanly and dumping consts `c8746a4` [DebugBundle] add tests for twig and for the bundle `8d5d970` [DebugBundle] adjust after review `eb98c81` [DebugBundle] dump() + better Symfony glue `9dea601` [DebugBundle] global dump() function for daily use `297d373` [VarDumper] README, LICENSE and composer.json `a69e962` [VarDumper] tests for HtmlDumper `5eaa187` [VarDumper] tests for CliDumper `e6dde33` [VarDumper] HTML variant of the CLI dumper `fa81544` [VarDumper] CLI dedicated dumper and related abstract `1d5e3f4` [VarDumper] interface for dumping collected variables `0266072` [VarDumper] casters for DOM objects `c426d8b` [VarDumper] casters for Doctrine objects `0a92c08` [VarDumper] casters for PDO related objects `da3e50a` [VarDumper] casters for SPL data structures `c91bc83` [VarDumper] casters for exceptions representation `3ddbf4b` [VarDumper] add casters for per class/resource custom state extraction `5b7ae28` [VarDumper] symfony_debug ext. fast and memory efficient cloning algo `07135a0` [VarDumper] algo to clone any PHP variable to a breadth-first queue `4bf9300` [Debug] a README for the debug extension `eec5c92` [Debug] Symfony debug extension		2014-09-23 18:54:24 +02:00
src/Symfony	feature #10640 VarDumper and DebugBundle (jpauli, nicolas-grekas, ruian, moux2003, tony-co, romainneutron, oscherler, lyrixx)	2014-09-23 18:54:24 +02:00
.editorconfig	Add EditorConfig File	2012-06-16 14:08:15 +02:00
.gitignore	Revert "encourage the running of coverage"	2013-12-04 07:03:18 +01:00
.travis.yml	[2.3] Add missing development dependencies	2014-09-22 17:11:59 +02:00
autoload.php.dist	made the dist autoloader to return the autoloder	2013-05-09 09:12:11 +02:00
CHANGELOG-2.2.md	Merge branch '2.2' into 2.3	2013-12-03 15:51:26 +01:00
CHANGELOG-2.3.md	updated CHANGELOG for 2.3.19	2014-09-03 11:45:01 +02:00
CHANGELOG-2.4.md	updated CHANGELOG for 2.4.9	2014-09-03 11:50:09 +02:00
CHANGELOG-2.5.md	updated CHANGELOG for 2.5.4	2014-09-03 11:51:41 +02:00
composer.json	[TwigBridge] add Twig dump() function + tests and fixes	2014-09-23 16:26:00 +02:00
CONTRIBUTING.md	added the BC docs to the contributing file	2014-03-04 08:26:38 +01:00
CONTRIBUTORS.md	update CONTRIBUTORS for 2.3.19	2014-09-03 11:45:14 +02:00
LICENSE	updated LICENSE year	2014-03-13 07:25:45 +01:00
phpunit.xml.dist	Merge branch '2.3' into 2.4	2014-07-09 11:04:55 +02:00
README.md	Fix typos in README	2013-01-19 11:32:41 +01:00
UPGRADE-2.1.md	[CS Fix] Consistent coding-style of concatenation operator usage	2013-04-02 10:39:57 +01:00
UPGRADE-2.2.md	Merge branch '2.3' into 2.4	2014-04-28 19:43:58 +02:00
UPGRADE-2.3.md	[Upgrade] Fixed markdown syntax	2014-07-09 17:19:57 +02:00
UPGRADE-2.4.md	[Form] Changed (Number\|Integer)ToLocalizedStringTransformer::reverseTransform() to do rounding	2013-08-01 17:19:11 +02:00
UPGRADE-2.5.md	Merge branch '2.5'	2014-08-31 05:28:38 +02:00
UPGRADE-2.6.md	[Validator] fixed: Expressions always valid for null values	2014-08-21 16:49:24 +10:00
UPGRADE-3.0.md	Unexpexted ));"	2014-09-02 15:16:13 +02:00

README.md

README

What is Symfony2?

Symfony2 is a PHP 5.3 full-stack web framework. It is written with speed and flexibility in mind. It allows developers to build better and easy to maintain websites with PHP.

Symfony can be used to develop all kind of websites, from your personal blog to high traffic ones like Dailymotion or Yahoo! Answers.

Requirements

Symfony2 is only supported on PHP 5.3.3 and up.

Be warned that PHP versions before 5.3.8 are known to be buggy and might not work for you:

before PHP 5.3.4, if you get "Notice: Trying to get property of non-object", you've hit a known PHP bug (see https://bugs.php.net/bug.php?id=52083 and https://bugs.php.net/bug.php?id=50027);
before PHP 5.3.8, if you get an error involving annotations, you've hit a known PHP bug (see https://bugs.php.net/bug.php?id=55156).
PHP 5.3.16 has a major bug in the Reflection subsystem and is not suitable to run Symfony2 (https://bugs.php.net/bug.php?id=62715)

Installation

The best way to install Symfony2 is to download the Symfony Standard Edition available at http://symfony.com/download.

Documentation

The "Quick Tour" tutorial gives you a first feeling of the framework. If, like us, you think that Symfony2 can help speed up your development and take the quality of your work to the next level, read the official Symfony2 documentation.

Contributing

Symfony2 is an open source, community-driven project. If you'd like to contribute, please read the Contributing Code part of the documentation. If you're submitting a pull request, please follow the guidelines in the Submitting a Patch section and use Pull Request Template.

Running Symfony2 Tests

Information on how to run the Symfony2 test suite can be found in the Running Symfony2 Tests section.