[VarDumper] Allow to use a light theme out of the box #27261

ogizanagi · 2018-05-14T14:56:09Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	N/A
License	MIT
Doc PR	N/A

Wouldn't it be nice to provide this light theme out of the box? (the one we use in the profiler)

linaori · 2018-05-15T07:14:09Z

Depends on where it's used I guess. When it's in the WDT, I'd prefer to keep it dark, but it doesn't seem possible like this (or am I wrong?).

ogizanagi · 2018-05-15T07:24:46Z

@iltar : It'll not be used anywhere in core (appart perhaps if we want to use it for the html output of the server:dump command). It's up to you to use it or let the default theme.
Or perhaps you meant you cannot use both dark and light theme in the same page through this feature?
That's true, but it's the same for any style set with HtmlDumper::setStyles. For such needs, you'll still have to use css.

Point of this is to expose the light theme if you want to exclusively use it instead of the dark theme for your own html dumper usages and also reference this color scheme directly in it rather than having to search it in the profiler css.

stof · 2018-05-15T07:46:49Z

src/Symfony/Component/VarDumper/Dumper/HtmlDumper.php

@@ -61,6 +80,7 @@ public function __construct($output = null, string $charset = null, int $flags =
        AbstractDumper::__construct($output, $charset, $flags);
        $this->dumpId = 'sf-dump-'.mt_rand();
        $this->displayOptions['fileLinkFormat'] = ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');
+        $this->styles = static::$themes['dark'] ?? self::$themes['dark'];


this will break the CliDumper, which was overriding the styles property, as you now have the HTML styles overriding the CLI ones here

The HtmlDumper extends the CliDumper, not the inverse. So I'm not sure how this could break the CliDumper? HtmlDumper was already overriding the CliDumper::$styles before these changes.

stof · 2018-05-15T07:47:21Z

btw, the fact that tests are passing tells me we are missing tests for the color support of the CliDumper

javiereguiluz · 2018-05-17T11:38:26Z

I love this! Also, we need it. In the profiler, we apply special styles to all profiler_dump() calls to avoid displaying them with a dark background. So if this gets merged, we can remove all these special styles defined here:

https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Profiler/profiler.css.twig#L937-L950

ro0NL · 2018-05-19T11:21:19Z

src/Symfony/Component/VarDumper/Dumper/HtmlDumper.php

@@ -23,28 +23,47 @@ class HtmlDumper extends CliDumper
 {
    public static $defaultOutput = 'php://output';

+    protected static $themes = array(


tend to believe a public registerTheme($name, $styles, $extends = 'light') is more useful then static overriding =/

edit: or declare on CliDumper along with setTheme, enabling the feat. there as well.

Not sure we want to allow people to register new themes.

nicolas-grekas · 2018-05-21T18:12:25Z

I'm wondering: should we move this to another class, following SRP? This is a helper around "setStyles", so could be decoupled. WDYT?

ogizanagi · 2018-05-22T07:23:56Z

@nicolas-grekas : Something like a StyleBuilder/StyleHelper::setTheme(string $theme)|addStyle(string $name, string $value)|apply(CliDumper $dumper)?
Or something more like Symfony\Component\Console\Helper\TableStyle?
Is it really worth it?

fabpot

with minor comments

fabpot · 2018-09-04T10:19:56Z

src/Symfony/Component/VarDumper/Dumper/HtmlDumper.php

+    public function setTheme(string $themeName)
+    {
+        if (!isset(static::$themes[$themeName])) {
+            throw new \InvalidArgumentException(sprintf('Theme "%s" does not exist in class "%s"', $themeName, static::class));


missing dot at the end of the exception message.

fabpot · 2018-09-04T10:20:51Z

src/Symfony/Component/VarDumper/Dumper/HtmlDumper.php

@@ -23,28 +23,47 @@ class HtmlDumper extends CliDumper
 {
    public static $defaultOutput = 'php://output';

+    protected static $themes = array(


Not sure we want to allow people to register new themes.

fabpot · 2018-10-08T09:00:27Z

@ogizanagi Can we finish this one so that we can merge it for 4.2?

ogizanagi · 2018-10-08T10:45:32Z

@fabpot : Sure, sorry for the lack of answer. But do we agree to keep HtmlDumper::setTheme() as is considering @nicolas-grekas 's #27261 (comment) ? Should we also add it in CliDumper (can still do it later anyway)?

ogizanagi · 2018-10-08T10:58:25Z

(Rebased and fixed the exception message)

fabpot · 2018-10-10T11:10:33Z

Thank you @ogizanagi.

…(ogizanagi) This PR was merged into the 4.2-dev branch. Discussion ---------- [VarDumper] Allow to use a light theme out of the box | Q | A | ------------- | --- | Branch? | master  | Bug fix? | no | New feature? | yes  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | N/A  | License | MIT | Doc PR | N/A Wouldn't it be nice to provide this light theme out of the box? (the one we use in the profiler) ![capture d ecran 2018-05-14 a 16 50 55](https://user-images.githubusercontent.com/2211145/40004942-23b4138c-5797-11e8-8c57-0b38744ffdc2.png) Commits ------- c705b82 [VarDumper] Allow to use a light theme out of the box

…n (derrabus) This PR was merged into the 6.4 branch. Discussion ---------- [DebugBundle] Remove obsolete VarDumper feature detection | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | N/A This PR removes detection for features introduced with #30301 (Symfony 4.3) and #27261 (Symfony 4.2). Commits ------- 9f9747c [DebugBundle] Remove obsolete VarDumper feature detection

ogizanagi added this to the next milestone May 14, 2018

carsonbot added Status: Needs Review VarDumper Feature labels May 14, 2018

carsonbot added Status: Needs Work and removed Status: Needs Review labels May 15, 2018

stof requested changes May 15, 2018

View reviewed changes

ro0NL reviewed May 19, 2018

View reviewed changes

fabpot approved these changes Sep 4, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Sep 4, 2018

[VarDumper] Allow to use a light theme out of the box

c705b82

fabpot approved these changes Oct 8, 2018

View reviewed changes

fabpot merged commit c705b82 into symfony:master Oct 10, 2018

ogizanagi deleted the html_dumper_light_theme branch October 10, 2018 12:07

javiereguiluz mentioned this pull request Oct 25, 2018

[VarDumper] Allow to use a light theme out of the box symfony/symfony-docs#10576

Closed

nicolas-grekas modified the milestones: next, 4.2 Nov 1, 2018

fabpot mentioned this pull request Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

fabpot mentioned this pull request Nov 3, 2018

Release v4.2.0-BETA1 #29073

Merged

PReimers mentioned this pull request Dec 8, 2018

[VarDumper] Add documentation for light theme symfony/symfony-docs#10746

Merged

derrabus mentioned this pull request Sep 10, 2023

[DebugBundle] Remove obsolete VarDumper feature detection #51616

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[VarDumper] Allow to use a light theme out of the box #27261

[VarDumper] Allow to use a light theme out of the box #27261

ogizanagi commented May 14, 2018

linaori commented May 15, 2018

ogizanagi commented May 15, 2018

stof May 15, 2018

ogizanagi May 15, 2018

stof commented May 15, 2018

javiereguiluz commented May 17, 2018

ro0NL May 19, 2018 •

edited

Loading

fabpot Sep 4, 2018

nicolas-grekas commented May 21, 2018

ogizanagi commented May 22, 2018

fabpot left a comment

fabpot Sep 4, 2018

fabpot Sep 4, 2018

fabpot commented Oct 8, 2018

ogizanagi commented Oct 8, 2018

ogizanagi commented Oct 8, 2018

fabpot commented Oct 10, 2018

[VarDumper] Allow to use a light theme out of the box #27261

[VarDumper] Allow to use a light theme out of the box #27261

Conversation

ogizanagi commented May 14, 2018

linaori commented May 15, 2018

ogizanagi commented May 15, 2018

stof May 15, 2018

Choose a reason for hiding this comment

ogizanagi May 15, 2018

Choose a reason for hiding this comment

stof commented May 15, 2018

javiereguiluz commented May 17, 2018

ro0NL May 19, 2018 • edited Loading

Choose a reason for hiding this comment

fabpot Sep 4, 2018

Choose a reason for hiding this comment

nicolas-grekas commented May 21, 2018

ogizanagi commented May 22, 2018

fabpot left a comment

Choose a reason for hiding this comment

fabpot Sep 4, 2018

Choose a reason for hiding this comment

fabpot Sep 4, 2018

Choose a reason for hiding this comment

fabpot commented Oct 8, 2018

ogizanagi commented Oct 8, 2018

ogizanagi commented Oct 8, 2018

fabpot commented Oct 10, 2018

ro0NL May 19, 2018 •

edited

Loading