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

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

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

// імʼя команди - це те, що користувачі друкують після "php bin/console"
#[AsCommand(name: 'app:create-user')]
class CreateUserCommand extends Command
{
    protected function execute(InputInterface $input, OutputInterface $output): 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
13
14
15
16
17

// src/Command/CreateUserCommand.php

// ...
class CreateUserCommand extends Command
{
    // опис команди, що відображається при запуску "php bin/console list"
    protected static $defaultDescription = 'Creates a new user.';

    // ...
    protected function configure(): void
    {
        $this
            // допомога команди, відображена при запуску команди з опцією "--help"
            ->setHelp('This command allows you to create a user...')
        ;
    }
}

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

// ...
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;

class CreateUserCommand extends Command
{
    // ...

    public function __construct(bool $requirePassword = false)
    {
        // гарною практикою вважається викликати спочатку батьківський конструктор, а
        // потім встановлювати нові властивості. Це не спрацює у даному випадку, тому
        // що configure() потребує встановлених властивостей в конструкторі
        $this->requirePassword = $requirePassword;

        parent::__construct();
    }

    protected function configure(): void
    {
        $this
            // ...
            ->addArgument('password', $this->requirePassword ? InputArgument::REQUIRED : InputArgument::OPTIONAL, 'User password')
        ;
    }
}

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

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

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

// аргументи "name" і "description" AsCommand заміняють статичні
// властивості $defaultName та $defaultDescription
#[AsCommand(
    name: 'app:create-user',
    description: 'Creates a new user.',
    hidden: false,
    aliases: ['app:add-user']
)]
class CreateUserCommand extends Command
{
    // ...
}

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

// ...
protected function execute(InputInterface $input, OutputInterface $output)
{
    // виводить багато рядків в консоль (додаючи "\n" наприкінці кожного рядку)
    $output->writeln([
        'User Creator',
        '============',
        '',
    ]);

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

    // виводить повідомлення з наступним "\n"
    $output->writeln('Ух ти!');

    // виводить повідомлення, не додаючи "\n" наприкінці рядку
    $output->write('Ви вже майже');
    $output->write('створили користувача.');
}

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

use Symfony\Component\Console\Input\InputArgument;

// ...
protected function configure()
{
    $this
        // створити аргумент
        ->addArgument('username', InputArgument::REQUIRED, 'The username of the user.')
        // ...
    ;
}

// ...
public function execute(InputInterface $input, OutputInterface $output)
{
    $output->writeln([
        'User Creator',
        '============',
        '',
    ]);

    // отримати значення аргументу, використовуючи getArgument()
    $output->writeln('Username: '.$input->getArgument('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
25
26
27
28

// ...
use App\Service\UserManager;
use Symfony\Component\Console\Command\Command;

class CreateUserCommand extends Command
{
    private $userManager;

    public function __construct(UserManager $userManager)
    {
        $this->userManager = $userManager;

        parent::__construct();
    }

    // ...

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        // ...

        $this->userManager->create($input->getArgument('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()
    {
        $kernel = self::bootKernel();
        $application = new Application($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);

        // ...
    }
}