mirror of
https://github.com/symfony/symfony-docs.git
synced 2026-03-24 00:32:14 +01:00
3849004fcc
Fixes #20371 Both blocks are currently rendered identically. Keeping only one of the two makes it easier to contribute. Some blocks were elevated to danger.
110 lines
3.8 KiB
ReStructuredText
110 lines
3.8 KiB
ReStructuredText
How to Call a Command from a Controller
|
|
=======================================
|
|
|
|
The :doc:`Console component documentation </components/console>` covers how to
|
|
create a console command. This article covers how to use a console command
|
|
directly from your controller.
|
|
|
|
You may have the need to call some function that is only available in a console
|
|
command. Usually, you should refactor the command and move some logic into a
|
|
service that can be reused in the controller. However, when the command is part
|
|
of a third-party library, you don't want to modify or duplicate their code.
|
|
Instead, you can run the command directly from the controller.
|
|
|
|
.. warning::
|
|
|
|
In comparison with a direct call from the console, calling a command from
|
|
a controller has a slight performance impact because of the request stack
|
|
overhead.
|
|
|
|
Imagine you want to run the ``debug:twig`` from inside your controller::
|
|
|
|
// src/Controller/DebugTwigController.php
|
|
namespace App\Controller;
|
|
|
|
use Symfony\Bundle\FrameworkBundle\Console\Application;
|
|
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
|
|
use Symfony\Component\Console\Input\ArrayInput;
|
|
use Symfony\Component\Console\Output\BufferedOutput;
|
|
use Symfony\Component\HttpFoundation\Response;
|
|
use Symfony\Component\HttpKernel\KernelInterface;
|
|
|
|
class DebugTwigController extends AbstractController
|
|
{
|
|
public function debugTwig(KernelInterface $kernel): Response
|
|
{
|
|
$application = new Application($kernel);
|
|
$application->setAutoExit(false);
|
|
|
|
$input = new ArrayInput([
|
|
'command' => 'debug:twig',
|
|
// (optional) define the value of command arguments
|
|
'fooArgument' => 'barValue',
|
|
// (optional) pass options to the command
|
|
'--bar' => 'fooValue',
|
|
// (optional) pass options without value
|
|
'--baz' => true,
|
|
]);
|
|
|
|
// You can use NullOutput() if you don't need the output
|
|
$output = new BufferedOutput();
|
|
$application->run($input, $output);
|
|
|
|
// return the output, don't use if you used NullOutput()
|
|
$content = $output->fetch();
|
|
|
|
// return new Response(""), if you used NullOutput()
|
|
return new Response($content);
|
|
}
|
|
}
|
|
|
|
Showing Colorized Command Output
|
|
--------------------------------
|
|
|
|
By telling the :class:`Symfony\\Component\\Console\\Output\\BufferedOutput`
|
|
it is decorated via the second parameter, it will return the Ansi color-coded
|
|
content. The `SensioLabs AnsiToHtml converter`_ can be used to convert this to
|
|
colorful HTML.
|
|
|
|
First, require the package:
|
|
|
|
.. code-block:: terminal
|
|
|
|
$ composer require sensiolabs/ansi-to-html
|
|
|
|
Now, use it in your controller::
|
|
|
|
// src/Controller/DebugTwigController.php
|
|
namespace App\Controller;
|
|
|
|
use SensioLabs\AnsiConverter\AnsiToHtmlConverter;
|
|
use Symfony\Component\Console\Output\BufferedOutput;
|
|
use Symfony\Component\Console\Output\OutputInterface;
|
|
use Symfony\Component\HttpFoundation\Response;
|
|
// ...
|
|
|
|
class DebugTwigController extends AbstractController
|
|
{
|
|
public function sendSpool(int $messages = 10): Response
|
|
{
|
|
// ...
|
|
$output = new BufferedOutput(
|
|
OutputInterface::VERBOSITY_NORMAL,
|
|
true // true for decorated
|
|
);
|
|
// ...
|
|
|
|
// return the output
|
|
$converter = new AnsiToHtmlConverter();
|
|
$content = $output->fetch();
|
|
|
|
return new Response($converter->convert($content));
|
|
}
|
|
}
|
|
|
|
The ``AnsiToHtmlConverter`` can also be registered `as a Twig Extension`_,
|
|
and supports optional themes.
|
|
|
|
.. _`SensioLabs AnsiToHtml converter`: https://github.com/sensiolabs/ansi-to-html
|
|
.. _`as a Twig Extension`: https://github.com/sensiolabs/ansi-to-html#twig-integration
|