Помощник Cursor

Дата обновления перевода 2021-12-25

Помощник Cursor

5.1

Класс Cursor был представлен в Symfony 5.1.

Cursor позволяет вам изменять положение курсора в команде консоли. Это позволяет вам писать в любом месте вывода:

        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
        // src/Command/MyCommand.php
namespace App\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Cursor;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class MyCommand extends Command
{
    // ...

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

        $cursor = new Cursor($output);

        // передвинуть курсор в указанный столбец (1ый аргумент) и
        // строку (2ой аргумент)
        $cursor->moveToPosition(7, 11);

        // и написать текст в его местоположении, используя вывод
        $output->write('My text');

        // ...
    }
}
    

Использование курсора

Передвижение курсора

Существует несколько методов контроля передвижения курсора команды:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
        // передвинуть курсор на 1 строку выше текущего положения
$cursor->moveUp();

// передвинуть курсор на 3 строкм выше текущего положения
$cursor->moveUp(3);

// то же самое, но вниз
$cursor->moveDown();

// передвинуть курсор на 1 столбец правее текущего положения
$cursor->moveRight();

// передвинуть курсор на 3 столбца правее текущего положения
$cursor->moveRight(3);

// то же самое, но влево
$cursor->moveLeft();

// передвинуть курсор в указанное местоположение (столбец, ряд), отсчитывая от наивысшей
// левой позиции в терминале
$cursor->moveToPosition(7, 11);
    

Вы можете получить текущее положение курсора команды, используя:

        1
2
3
        $position = $cursor->getCurrentPosition();
// $position[0] // columns (aka x coordinate)
// $position[1] // rows (aka y coordinate)
    

Очистка вывода

Курсор также может очистить некоторый вывод на экране:

        1
2
3
4
5
6
7
8
9
10
11
        // очищает весь вывод с текущей строки
$cursor->clearLine();

// очищает весь вывод через одну строку от текущего местоположения
$cursor->clearLineAfter();

// очищает весь вывод от текущего местоположения курсора до конца экрана
$cursor->clearOutput();

// очищает весь экран
$cursor->clearScreen();
    

Вы также можете использовать преимущества методов show() и hide() в курсоре.