Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

[Console] Document theTreeHelper#20786

New issue

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

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
javiereguiluz merged 1 commit intosymfony:7.3fromsmnandre:console-tree-helper
Mar 24, 2025
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletionscomponents/console/helpers/map.rst.inc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,5 +3,6 @@
* :doc:`/components/console/helpers/progressbar`
* :doc:`/components/console/helpers/questionhelper`
* :doc:`/components/console/helpers/table`
* :doc:`/components/console/helpers/tree`
* :doc:`/components/console/helpers/debug_formatter`
* :doc:`/components/console/helpers/cursor`
237 changes: 237 additions & 0 deletionscomponents/console/helpers/tree.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,237 @@
Tree Helper
===========

The Tree Helper allows you to build and display tree structures in the console.

.. versionadded:: 7.3

The ``TreeHelper`` class was introduced in Symfony 7.3.

Rendering a Tree
----------------

The :method:`Symfony\\Component\\Console\\Helper\\TreeHelper::createTree` method creates a tree structure from an array and returns a :class:`Symfony\\Component\\Console\\Helper\\Tree`
object that can be rendered in the console.

Building a Tree from an Array
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can build a tree from an array by passing the array to the :method:`Symfony\\Component\\Console\\Helper\\TreeHelper::createTree`
method::

use Symfony\Component\Console\Helper\TreeHelper;

$tree = TreeHelper::createTree($io, null, [
'src' => [
'Command',
'Controller' => [
'DefaultController.php',
],
'Kernel.php',
],
'templates' => [
'base.html.twig',
],
]);

$tree->render();

The above code will output the following tree:

.. code-block:: text

├── src
│ ├── Command
│ ├── Controller
│ │ └── DefaultController.php
│ └── Kernel.php
└── templates
└── base.html.twig

Manually Creating a Tree
~~~~~~~~~~~~~~~~~~~~~~~~

You can manually create a tree by creating a new instance of the :class:`Symfony\\Component\\Console\\Helper\\Tree` class and adding nodes to it::

use Symfony\Component\Console\Helper\TreeHelper;
use Symfony\Component\Console\Helper\TreeNode;

$node = TreeNode::fromValues([
'Command',
'Controller' => [
'DefaultController.php',
],
'Kernel.php',
]);
$node->addChild('templates');
$node->addChild('tests');

$tree = TreeHelper::createTree($io, $node);
$tree->render();

Customizing the Tree Style
--------------------------

Built-in Tree Styles
~~~~~~~~~~~~~~~~~~~~

The tree helper provides a few built-in styles that you can use to customize the output of the tree.

:method:`Symfony\\Component\\Console\\Helper\\TreeStyle::default`

.. code-block:: text

├── config
│ ├── packages
│ └── routes
│ ├── framework.yaml
│ └── web_profiler.yaml
├── src
│ ├── Command
│ ├── Controller
│ │ └── DefaultController.php
│ └── Kernel.php
└── templates
└── base.html.twig

:method:`Symfony\\Component\\Console\\Helper\\TreeStyle::box`

.. code-block:: text

┃╸ config
┃ ┃╸ packages
┃ ┗╸ routes
┃ ┃╸ framework.yaml
┃ ┗╸ web_profiler.yaml
┃╸ src
┃ ┃╸ Command
┃ ┃╸ Controller
┃ ┃ ┗╸ DefaultController.php
┃ ┗╸ Kernel.php
┗╸ templates
┗╸ base.html.twig

:method:`Symfony\\Component\\Console\\Helper\\TreeStyle::doubleBox`

.. code-block:: text

╠═ config
║ ╠═ packages
║ ╚═ routes
║ ╠═ framework.yaml
║ ╚═ web_profiler.yaml
╠═ src
║ ╠═ Command
║ ╠═ Controller
║ ║ ╚═ DefaultController.php
║ ╚═ Kernel.php
╚═ templates
╚═ base.html.twig

:method:`Symfony\\Component\\Console\\Helper\\TreeStyle::compact`

.. code-block:: text

├ config
│ ├ packages
│ └ routes
│ ├ framework.yaml
│ └ web_profiler.yaml
├ src
│ ├ Command
│ ├ Controller
│ │ └ DefaultController.php
│ └ Kernel.php
└ templates
└ base.html.twig

:method:`Symfony\\Component\\Console\\Helper\\TreeStyle::light`

.. code-block:: text

|-- config
| |-- packages
| `-- routes
| |-- framework.yaml
| `-- web_profiler.yaml
|-- src
| |-- Command
| |-- Controller
| | `-- DefaultController.php
| `-- Kernel.php
`-- templates
`-- base.html.twig

:method:`Symfony\\Component\\Console\\Helper\\TreeStyle::minimal`

.. code-block:: text

. config
. . packages
. . routes
. . framework.yaml
. . web_profiler.yaml
. src
. . Command
. . Controller
. . . DefaultController.php
. . Kernel.php
. templates
. base.html.twig

:method:`Symfony\\Component\\Console\\Helper\\TreeStyle::rounded`

.. code-block:: text

├─ config
│ ├─ packages
│ ╰─ routes
│ ├─ framework.yaml
│ ╰─ web_profiler.yaml
├─ src
│ ├─ Command
│ ├─ Controller
│ │ ╰─ DefaultController.php
│ ╰─ Kernel.php
╰─ templates
╰─ base.html.twig

Making a Custom Tree Style
~~~~~~~~~~~~~~~~~~~~~~~~~~

You can create your own tree style by passing the characters to the constructor
of the :class:`Symfony\\Component\\Console\\Helper\\TreeStyle` class::

use Symfony\Component\Console\Helper\TreeHelper;
use Symfony\Component\Console\Helper\TreeStyle;

$customStyle = new TreeStyle('🟣 ', '🟠 ', '🔵 ', '🟢 ', '🔴 ', '🟡 ');

// Pass the custom style to the createTree method

$tree = TreeHelper::createTree($io, null, [
'src' => [
'Command',
'Controller' => [
'DefaultController.php',
],
'Kernel.php',
],
'templates' => [
'base.html.twig',
],
], $customStyle);

$tree->render();

The above code will output the following tree:

.. code-block:: text

🔵 🟣 🟡 src
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I love this example ❤️

smnandre reacted with hooray emoji
🔵 🟢 🟣 🟡 Command
🔵 🟢 🟣 🟡 Controller
🔵 🟢 🟢 🟠 🟡 DefaultController.php
🔵 🟢 🟠 🟡 Kernel.php
🔵 🟠 🟡 templates
🔵 🔴 🟠 🟡 base.html.twig
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Please add a versionadded directive below, like for other new features, thanks

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

The whole page is about the new tree helper, should i put the versionadded at the very start of the page ?

javiereguiluz reacted with thumbs up emoji
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I think yes, and add it also inconsole/style.rst after the new methods

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Yes please, so that a reader knows, since when this can be used

smnandre reacted with thumbs up emoji
Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Would this work ? (last changes)

26 changes: 26 additions & 0 deletionsconsole/style.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,32 @@ Content Methods
styled according to the Symfony Style Guide, which allows you to use
features such as dynamically appending rows.

:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::tree`
It displays the given nested array as a formatted directory/file tree
structure in the console output::

$io->tree([
'src' => [
'Controller' => [
'DefaultController.php',
],
'Kernel.php',
],
'templates' => [
'base.html.twig',
],
]);

.. versionadded:: 7.3

The ``SymfonyStyle::tree()`` and the ``SymfonyStyle::createTree()`` methods
were introduced in Symfony 7.3.

:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::createTree`
Creates an instance of :class:`Symfony\\Component\\Console\\Helper\\TreeHelper`
styled according to the Symfony Style Guide, which allows you to use
features such as dynamically nesting nodes.

:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::newLine`
It displays a blank line in the command output. Although it may seem useful,
most of the times you won't need it at all. The reason is that every helper
Expand Down
Loading
[8]ページ先頭
©2009-2025 Movatter.jp