Summary

Fully Qualified Name:	Laminas\Console\Adapter\Windows
Extends:	Virtual

Description

Methods

Name	Description	Defined By
clear()	Clear console screen	Windows
clearLine()	Clear line at cursor position	Windows
clearScreen()	Clear console screen	AbstractAdapter
colorize()	Prepare a string that will be rendered in color.	AbstractAdapter
encodeText()	Encode a text to match console encoding	AbstractAdapter
getCharset()	Get charset currently in use by this adapter.	Windows
getDefaultCharset()		Windows
getHeight()	Determine and return current console height.	Windows
getSize()	Determine and return current console width and height.	AbstractAdapter
getTitle()	Return current console window title.	Windows
getWidth()	Determine and return current console width.	Windows
hideCursor()	Hide console cursor	AbstractAdapter
isUtf8()	Check if console is UTF-8 compatible	Windows
readChar()	Read a single character from the console input	Windows
readLine()	Read a single line from the console input.	Windows
resetColor()	Reset color to console default.	AbstractAdapter
setBgColor()	Change current drawing background color	AbstractAdapter
setCharset()	Set Console charset to use.	Windows
setColor()	Change current drawing color.	AbstractAdapter
setPos()	Set cursor position	AbstractAdapter
showCursor()	Show console cursor	AbstractAdapter
write()	Write a chunk of text to console.	AbstractAdapter
writeAt()	Write a piece of text at the coordinates of $x and $y	AbstractAdapter
writeBox()	Write a box at the specified coordinates.	AbstractAdapter
writeLine()	Write a single line of text to console and advance cursor to the next line.	AbstractAdapter
writeText()	Alias for write()	AbstractAdapter
writeTextBlock()	Write a block of text at the given coordinates, matching the supplied width and height.	AbstractAdapter

Method Details

clear()

Clear console screen

Returns:

clearLine()

Clear line at cursor position

Returns:

clearScreen()

Clear console screen

Returns:

colorize()

Prepare a string that will be rendered in color.

Parameter Name	Type	Description
$string	string
$color	int
$bgColor	null|int

Returns: string

encodeText()

Encode a text to match console encoding

Parameter Name	Type	Description
$text	string

Returns: string the encoding text

getCharset()

Get charset currently in use by this adapter.

Returns: \Charset\CharsetInterface $charset

getDefaultCharset()

Returns: \Charset\AsciiExtended

getHeight()

Determine and return current console height.

Returns: int

getSize()

Determine and return current console width and height.

Returns: int[] array($width, $height)

getTitle()

Return current console window title.

Returns: string

getWidth()

Determine and return current console width.

Returns: int

hideCursor()

Hide console cursor

Returns:

isUtf8()

Check if console is UTF-8 compatible

Returns: bool

readChar()

Read a single character from the console input

Parameter Name	Type	Description
$mask	string|null	A

Returns: string

readLine()

Read a single line from the console input.

Parameter Name	Type	Description
$maxLength	int	Maximum

Returns: string

resetColor()

Reset color to console default.

Returns:

setBgColor()

Change current drawing background color

Parameter Name	Type	Description
$color	int

Returns:

setCharset()

Set Console charset to use.

Parameter Name	Type	Description
$charset	\Charset\CharsetInterface

Returns:

setColor()

Change current drawing color.

Parameter Name	Type	Description
$color	int

Returns:

setPos()

Set cursor position

Parameter Name	Type	Description
$x	int
$y	int

Returns:

showCursor()

Show console cursor

Returns:

write()

Write a chunk of text to console.

Parameter Name	Type	Description
$text	string
$color	null|int
$bgColor	null|int

Returns:

writeAt()

Write a piece of text at the coordinates of $x and $y

Parameter Name	Type	Description
$text	string	Text
$x	int	Console
$y	int	Console
$color	null|int
$bgColor	null|int

Returns:

writeBox()

Write a box at the specified coordinates.

If X or Y coordinate value is negative, it will be calculated as the distance from far right or bottom edge of the console (respectively).

Parameter Name	Type	Description
$x1	int	Top-left
$y1	int	Top-left
$x2	int	Bottom-right
$y2	int	Bottom-right
$lineStyle	int	(optional)
$fillStyle	int	(optional)
$color	int	(optional)
$bgColor	int	(optional)
$fillColor	null|int	(optional)
$fillBgColor	null|int	(optional)

Returns:

writeLine()

Write a single line of text to console and advance cursor to the next line.

Parameter Name	Type	Description
$text	string
$color	null|int
$bgColor	null|int

Returns:

writeText()

Alias for write()

Parameter Name	Type	Description
$text	string
$color	null|int
$bgColor	null|int

Returns:

writeTextBlock()

Write a block of text at the given coordinates, matching the supplied width and height.

In case a line of text does not fit desired width, it will be wrapped to the next line. In case the whole text does not fit in desired height, it will be truncated.

Parameter Name	Type	Description
$text	string	Text
$width	int	Maximum
$height	int|null	Maximum
$x	int	Block
$y	int	Block
$color	null|int	(optional)
$bgColor	null|int	(optional)

Returns: