1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

// src/Command/CreateUserCommand.php
namespace App\Command;

use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;

// имя команды - это то, что пользователи печатают после "php bin/console"
#[AsCommand(name: 'app:create-user')]
class CreateUserCommand
{
    public function __invoke(): int
    {
        // ... введите здесь код, чтобы создать пользователя

        // этот метод должен вернуть целое число с "кодом завершения"
        // команды. Вы также можете использовать это константы, чтобы сделать код более читаемым

        // вернуть это, если при выполнении команды не было проблем
        // (эквивалентно возвращению int(0))
        return Command::SUCCESS;

        // или вернуть это, если во время выполнения возникла ошибка
        // (эквивалентно возвращению int(1))
        // return Command::FAILURE;

        // или вернуть это, чтобы указать на неправильное использование команды, например, невалидные опции
        // или отсутствующие аргументы (равноценно возвращению int(2))
        // return Command::INVALID
    }
}

1
2
3
4
5
6
7
8
9
10
11
12

#[AsCommand(
    name: 'app:create-user',
    description: 'Creates a new user.', // the command description shown when running "php bin/console list"
    help: 'This command allows you to create a user...', // the command help shown when running the command with the "--help" option
)]
class CreateUserCommand
{
    public function __invoke(): int
    {
        // ...
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

#[AsCommand(name: 'app:create-user')]
class CreateUserCommand extends Command
{
    public function initialize(InputInterface $input, OutputInterface $output): void
    {
        // ...
    }

    public function interact(InputInterface $input, OutputInterface $output): void
    {
        // ...
    }

    public function __invoke(): int
    {
        // ...
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

// ...
public function __invoke(OutputInterface $output): int
{
    // выводит множество строк в консоль (добавляя "\n" в конце каждой строки)
    $output->writeln([
        'User Creator',
        '============',
        '',
    ]);

    // значение возвращённое someMethod() может быть итератором (https://secure.php.net/iterator)
    // которое генерирует и возвращает сообщение с помощью ключевого слова PHP 'yield'
    $output->writeln($this->someMethod());

    // выводит сообщение с последующим "\n"
    $output->writeln('Whoa!');

    // выводит сообщение, не добавляя "\n" в конце строки
    $output->write('You are about to ');
    $output->write('create a user.');

    return Command::SUCCESS;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

use Symfony\Component\Console\Attribute\Argument;

// Атрибут #[Argument] конфигурирует $username как обязательный
// аргумент ввода, и его значение автоматически передается этому параметру
public function __invoke(#[Argument('The username of the user.')] string $username, OutputInterface $output): int
{
    $output->writeln([
        'User Creator',
        '============',
        '',
    ]);

    $output->writeln('Username: '.$username);

    return Command::SUCCESS;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

// ...
use App\Service\UserManager;
use Symfony\Component\Console\Attribute\Argument;
use Symfony\Component\Console\Attribute\AsCommand;

#[AsCommand(name: 'app:create-user')]
class CreateUserCommand
{
    public function __construct(
        private UserManager $userManager
    ) {
    }

    public function __invoke(#[Argument] string $username, OutputInterface $output): int
    {
        // ...

        $this->userManager->create($username);

        $output->writeln('User successfully generated!');

        return Command::SUCCESS;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

// tests/Command/CreateUserCommandTest.php
namespace App\Tests\Command;

use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Symfony\Component\Console\Tester\CommandTester;

class CreateUserCommandTest extends KernelTestCase
{
    public function testExecute(): void
    {
        self::bootKernel();
        $application = new Application(self::$kernel);

        $command = $application->find('app:create-user');
        $commandTester = new CommandTester($command);
        $commandTester->execute([
            // передать аргументы помощнику
            'username' => 'Wouter',

            // добавить к ключу префикс с двумя дефисами при передаче опций,
            // например: '--some-option' => 'option_value',
            // используйте скобки для тестиования значения массива,
            // например: '--some-option' => ['option_value'],
        ]);

        $commandTester->assertCommandIsSuccessful();

        // вывод команды в консоли
        $output = $commandTester->getDisplay();
        $this->assertStringContainsString('Username: Wouter', $output);

        // ...
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

use Symfony\Component\Console\Terminal;

$terminal = new Terminal();

// получает количество доступных строчек
$height = $terminal->getHeight();

// получает количество доступных колонок
$width = $terminal->getWidth();

// получает цветовой режим
$colorMode = $terminal->getColorMode();

// изменяет цветовой режим
$colorMode = $terminal->setColorMode(AnsiColorMode::Ansi24);