[Console] Add title table #26933

maidmaid · 2018-04-15T10:17:58Z

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

Why not just add a title to console tables? Inspired by the famous file manager Midnight Commander.

ro0NL · 2018-04-15T10:38:11Z

src/Symfony/Component/Console/Tests/Helper/TableTest.php

+TABLE
+            ),
+            array(
+                'Boooooooooooooooooooooooooooooooooooooooooooooooooooooooooks',


what about truncating instead of ignoring?

Indeed, it's better. Done.

ro0NL · 2018-04-15T10:38:30Z

src/Symfony/Component/Console/Helper/Table.php

@@ -350,7 +361,7 @@ public function render()
     *
     * Example: <code>+-----+-----------+-------+</code>
     */
-    private function renderRowSeparator(int $type = self::SEPARATOR_MID)
+    private function renderRowSeparator(int $type = self::SEPARATOR_MID, $title = null)


string $title = null

ro0NL · 2018-04-15T10:38:53Z

src/Symfony/Component/Console/Helper/Table.php

@@ -290,6 +292,13 @@ public function setRow($column, array $row)
        return $this;
    }

+    public function setTitle($title): self


?string $title?

javiereguiluz · 2018-04-16T06:33:46Z

src/Symfony/Component/Console/Tests/Helper/TableTest.php

+                'Boooooooooooooooooooooooooooooooooooooooooooooooooooooooooks',
+                'default',
+                <<<'TABLE'
+ Booooooooooooooooooooooooooooooooooooooooooooooooooooooo... +


Done. That looks much better!

javiereguiluz · 2018-04-16T06:34:34Z

src/Symfony/Component/Console/Helper/Helper.php

@@ -72,6 +72,18 @@ public static function substr($string, $from, $length = null)
        return mb_substr($string, $from, $length, $encoding);
    }

+    /**
+     * Returns the text within a portion of a string, using mb_substr if it is available.


We could remove ... using mb_substr if it is available from the description because it's an internal detail and in the PHPdoc we usually only explain what we do but not how we do that.

Also, the description is a bit confusing Returns the text within a portion of a string ... because the function name means Replace a part of the given string...

I had put the mb_substr detail to be consistent with the others methods of this helper, but effectively, that isn't really useful, so it's deleted now.

About the description, I reworded to Replaces text within a portion of a string (the same description than in the PHP doc)

javiereguiluz · 2018-04-16T06:37:19Z

src/Symfony/Component/Console/Helper/Table.php

@@ -378,6 +389,17 @@ private function renderRowSeparator(int $type = self::SEPARATOR_MID)
            $markup .= $column === $count - 1 ? $rightChar : $midChar;
        }

+        if (null !== $title) {
+            $lenT = Helper::strlenWithoutDecoration($formatter = $this->output->getFormatter(), $formattedTitle = sprintf($format = $this->style->getTitleFormat(), $title));


Let's use better variable names here to ease future maintenance. For example:

$lenT -> $titleTextLength $lenM -> $titleMarkupLength

fabpot · 2018-04-16T14:19:18Z

Would it make sense to allow the title to be at the bottom as well?

maidmaid · 2018-04-16T14:34:08Z

@fabpot What do you mean by "at the bottom"? The second line of the header or the very last line of the table?

fabpot · 2018-04-16T15:17:26Z

I was thinking about the last line of the table.

maidmaid · 2018-04-18T03:21:45Z

IMO, shown the title only in the first line is enough.

fabpot · 2018-04-19T05:33:13Z

Not sure I understand the "enough" part. I was thinking about letting the user choose between displaying the title at the top or at the bottom (depending on what you want to achieve, doing one or the other might make more sense).

ro0NL · 2018-04-19T17:44:25Z

What about setHeaderTitle + setFooterTitle? Agree a title at the bottom might be useful, e.g. pagination info or some resultset status text.

yceruto · 2018-04-19T19:42:43Z

Also sometimes the table is too big, showing the title in both places (top/bottom) would be nice, avoids scrolling.

maidmaid · 2018-04-24T09:11:45Z

As suggested, I added setHeaderTitle() and setFooterTitle() methods:

ro0NL · 2018-07-03T07:35:25Z

src/Symfony/Component/Console/Helper/Table.php

+        return $this;
+    }
+
+    public function setfooterTitle(?string $title): self


s/footer/Footer/

azjezz · 2018-07-03T08:08:38Z

src/Symfony/Component/Console/Helper/Table.php

+        return $this;
+    }
+
+    public function setfooterTitle(?string $title): self


method should be renamed to setFooterTitle

ro0NL · 2018-07-03T16:48:28Z

src/Symfony/Component/Console/Helper/Helper.php

+    /**
+     * Replaces text within a portion of a string.
+     */
+    public static function substr_replace(string $string, string $replacement, int $start, int $length = null): string


I'm not sure this actually complies with CS ... should we prefer substrReplace() (given strlenWithoutDecoration also)

but i understand the reasoning.. i don't mind really :)

Maybe, someone like @nicolas-grekas could help us here ?

the logic is used once: let's inline it instead of creating a new public method

ro0NL · 2018-07-03T16:52:33Z

src/Symfony/Component/Console/Helper/Helper.php

+            return substr_replace($string, $replacement, $start, $length);
+        }
+
+        return mb_substr($string, 0, $start).$replacement.mb_substr($string, $start + $length);


from http://php.net/manual/en/function.substr-replace.php

i think we should default $length = strlen($string); here as well

That looks working as expected https://3v4l.org/C5Nhs, do I miss something ?

Seems like PHP treats null as int(0) 🤔

https://3v4l.org/f02sM

nicolas-grekas · 2018-07-11T09:10:13Z

src/Symfony/Component/Console/Helper/Helper.php

@@ -17,6 +17,7 @@
 * Helper is the base class for all helper classes.
 *
 * @author Fabien Potencier <[email protected]>
+ * @author Dany Maillard <[email protected]>


can be removed now

Oops, I just removed it.

fabpot · 2018-07-11T09:59:01Z

Thank you @maidmaid.

This PR was merged into the 4.2-dev branch. Discussion ---------- [Console] Add title table | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | / | License | MIT | Doc PR | / Why not just add a title to console tables? Inspired by the famous file manager [Midnight Commander](https://en.wikipedia.org/wiki/Midnight_Commander). ![screenshot from 2018-04-15 20-16-26](https://user-images.githubusercontent.com/4578773/38777361-eb6aaa72-40e9-11e8-8ae4-055fe80272c3.png) Commits ------- 6bf9eeb Add title table

javiereguiluz · 2018-09-07T15:08:22Z

I've created symfony/symfony-docs#10294 to not forget about adding the docs for this feature. @maidmaid it'd be great if you could help us with the docs for this feature. Thanks!

carsonbot added Status: Needs Review Console Feature labels Apr 15, 2018

maidmaid force-pushed the console-table-title branch from 4aa5d6f to 6d1bbfb Compare April 15, 2018 10:19

ro0NL reviewed Apr 15, 2018

View reviewed changes

maidmaid force-pushed the console-table-title branch from 6d1bbfb to 706bab2 Compare April 15, 2018 14:25

nicolas-grekas added this to the 4.2 milestone Apr 15, 2018

javiereguiluz reviewed Apr 16, 2018

View reviewed changes

maidmaid force-pushed the console-table-title branch 2 times, most recently from 30a72f8 to 47183ed Compare April 16, 2018 13:46

maidmaid force-pushed the console-table-title branch from 47183ed to 57da8ae Compare April 24, 2018 08:19

maidmaid force-pushed the console-table-title branch from 57da8ae to 8a6396f Compare April 25, 2018 04:12

javiereguiluz approved these changes Jul 3, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review Status: Reviewed labels Jul 3, 2018

ro0NL suggested changes Jul 3, 2018

View reviewed changes

carsonbot added the Status: Needs Work label Jul 3, 2018

azjezz suggested changes Jul 3, 2018

View reviewed changes

maidmaid force-pushed the console-table-title branch from 8a6396f to 63f973f Compare July 3, 2018 16:42

ro0NL reviewed Jul 3, 2018

View reviewed changes

azjezz approved these changes Jul 3, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Jul 3, 2018

azjezz approved these changes Jul 10, 2018

View reviewed changes

maidmaid force-pushed the console-table-title branch from 63f973f to 957568f Compare July 11, 2018 08:47

nicolas-grekas reviewed Jul 11, 2018

View reviewed changes

Add title table

6bf9eeb

maidmaid force-pushed the console-table-title branch from 957568f to 6bf9eeb Compare July 11, 2018 09:51

fabpot approved these changes Jul 11, 2018

View reviewed changes

fabpot merged commit 6bf9eeb into symfony:master Jul 11, 2018

maidmaid deleted the console-table-title branch July 11, 2018 10:00

javiereguiluz mentioned this pull request Sep 7, 2018

[Console] Allow to configure the title of the table symfony/symfony-docs#10294

Closed

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

This was referenced Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

Release v4.2.0-BETA1 #29073

Merged

[Console] Add title table #26933

[Console] Add title table #26933

Conversation

maidmaid commented Apr 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Apr 16, 2018

maidmaid commented Apr 16, 2018

fabpot commented Apr 16, 2018

maidmaid commented Apr 18, 2018

fabpot commented Apr 19, 2018

ro0NL commented Apr 19, 2018

yceruto commented Apr 19, 2018

maidmaid commented Apr 24, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Jul 11, 2018

javiereguiluz commented Sep 7, 2018