Cursor
in package
Tags
Table of Contents
- $input : mixed
- $output : mixed
- __construct() : mixed
- clearLine() : $this
- Clears all the output from the current line.
- clearLineAfter() : self
- Clears all the output from the current line after the current position.
- clearOutput() : $this
- Clears all the output from the cursors' current position to the end of the screen.
- clearScreen() : $this
- Clears the entire screen.
- getCurrentPosition() : array<string|int, mixed>
- Returns the current cursor position as x,y coordinates.
- hide() : $this
- moveDown() : $this
- moveLeft() : $this
- moveRight() : $this
- moveToColumn() : $this
- moveToPosition() : $this
- moveUp() : $this
- restorePosition() : $this
- savePosition() : $this
- show() : $this
Properties
$input
private
mixed
$input
$output
private
mixed
$output
Methods
__construct()
public
__construct(OutputInterface $output[, resource|null $input = null ]) : mixed
Parameters
- $output : OutputInterface
- $input : resource|null = null
Return values
mixed —clearLine()
Clears all the output from the current line.
public
clearLine() : $this
Return values
$this —clearLineAfter()
Clears all the output from the current line after the current position.
public
clearLineAfter() : self
Return values
self —clearOutput()
Clears all the output from the cursors' current position to the end of the screen.
public
clearOutput() : $this
Return values
$this —clearScreen()
Clears the entire screen.
public
clearScreen() : $this
Return values
$this —getCurrentPosition()
Returns the current cursor position as x,y coordinates.
public
getCurrentPosition() : array<string|int, mixed>
Return values
array<string|int, mixed> —hide()
public
hide() : $this
Return values
$this —moveDown()
public
moveDown([int $lines = 1 ]) : $this
Parameters
- $lines : int = 1
Return values
$this —moveLeft()
public
moveLeft([int $columns = 1 ]) : $this
Parameters
- $columns : int = 1
Return values
$this —moveRight()
public
moveRight([int $columns = 1 ]) : $this
Parameters
- $columns : int = 1
Return values
$this —moveToColumn()
public
moveToColumn(int $column) : $this
Parameters
- $column : int
Return values
$this —moveToPosition()
public
moveToPosition(int $column, int $row) : $this
Parameters
- $column : int
- $row : int
Return values
$this —moveUp()
public
moveUp([int $lines = 1 ]) : $this
Parameters
- $lines : int = 1
Return values
$this —restorePosition()
public
restorePosition() : $this
Return values
$this —savePosition()
public
savePosition() : $this
Return values
$this —show()
public
show() : $this