Cursor
in package
FinalYes
Tags
Table of Contents
Properties
- $input : resource
- $output : OutputInterface
Methods
- __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
resource
$input
$output
private
OutputInterface
$output
Methods
__construct()
public
__construct(OutputInterface $output[, resource|null $input = null ]) : mixed
Parameters
- $output : OutputInterface
- $input : resource|null = null
clearLine()
Clears all the output from the current line.
public
clearLine() : $this
Return values
$thisclearLineAfter()
Clears all the output from the current line after the current position.
public
clearLineAfter() : self
Return values
selfclearOutput()
Clears all the output from the cursors' current position to the end of the screen.
public
clearOutput() : $this
Return values
$thisclearScreen()
Clears the entire screen.
public
clearScreen() : $this
Return values
$thisgetCurrentPosition()
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
$thismoveDown()
public
moveDown([int $lines = 1 ]) : $this
Parameters
- $lines : int = 1
Return values
$thismoveLeft()
public
moveLeft([int $columns = 1 ]) : $this
Parameters
- $columns : int = 1
Return values
$thismoveRight()
public
moveRight([int $columns = 1 ]) : $this
Parameters
- $columns : int = 1
Return values
$thismoveToColumn()
public
moveToColumn(int $column) : $this
Parameters
- $column : int
Return values
$thismoveToPosition()
public
moveToPosition(int $column, int $row) : $this
Parameters
- $column : int
- $row : int
Return values
$thismoveUp()
public
moveUp([int $lines = 1 ]) : $this
Parameters
- $lines : int = 1
Return values
$thisrestorePosition()
public
restorePosition() : $this
Return values
$thissavePosition()
public
savePosition() : $this
Return values
$thisshow()
public
show() : $this