Помічник Cursor

Дата оновлення перекладу 2022-11-11

Помічник Cursor

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() у курсорі.