Cursor
in package
Управление положением и видимостью курсора терминала поверх {@see Writer}.
Методы возвращают сам объект — вызовы можно объединять в цепочку. Позволяет строить обновляемый на месте вывод (меню, дашборды, живые индикаторы).
Table of Contents
Methods
- __construct() : mixed
- clearLine() : self
- Очистить текущую строку и вернуть курсор в её начало.
- clearScreen() : self
- Очистить экран и переместить курсор в левый верхний угол.
- hide() : self
- Скрыть курсор.
- moveBack() : self
- Сдвинуть курсор влево.
- moveDown() : self
- Сдвинуть курсор вниз.
- moveForward() : self
- Сдвинуть курсор вправо.
- moveTo() : self
- Переместить курсор в абсолютную позицию (нумерация с 1).
- moveUp() : self
- Сдвинуть курсор вверх.
- show() : self
- Показать курсор.
Methods
__construct()
public
__construct(Writer $output) : mixed
Parameters
- $output : Writer
-
приёмник управляющих последовательностей
clearLine()
Очистить текущую строку и вернуть курсор в её начало.
public
clearLine() : self
Return values
self —этот объект для цепочки вызовов
clearScreen()
Очистить экран и переместить курсор в левый верхний угол.
public
clearScreen() : self
Return values
self —этот объект для цепочки вызовов
hide()
Скрыть курсор.
public
hide() : self
Return values
self —этот объект для цепочки вызовов
moveBack()
Сдвинуть курсор влево.
public
moveBack([int $columns = 1 ]) : self
Parameters
- $columns : int = 1
-
число колонок (> 0)
Tags
Return values
self —этот объект для цепочки вызовов
moveDown()
Сдвинуть курсор вниз.
public
moveDown([int $lines = 1 ]) : self
Parameters
- $lines : int = 1
-
число строк (> 0)
Tags
Return values
self —этот объект для цепочки вызовов
moveForward()
Сдвинуть курсор вправо.
public
moveForward([int $columns = 1 ]) : self
Parameters
- $columns : int = 1
-
число колонок (> 0)
Tags
Return values
self —этот объект для цепочки вызовов
moveTo()
Переместить курсор в абсолютную позицию (нумерация с 1).
public
moveTo(int $column, int $row) : self
Parameters
- $column : int
-
номер колонки (> 0)
- $row : int
-
номер строки (> 0)
Tags
Return values
self —этот объект для цепочки вызовов
moveUp()
Сдвинуть курсор вверх.
public
moveUp([int $lines = 1 ]) : self
Parameters
- $lines : int = 1
-
число строк (> 0)
Tags
Return values
self —этот объект для цепочки вызовов
show()
Показать курсор.
public
show() : self
Return values
self —этот объект для цепочки вызовов