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