clear()
clearLine()
clearScreen()
colorize()
getCharset()
getDefaultCharset()
getHeight()
getSize()
getTitle()
getWidth()
hideCursor()
isUtf8()
readChar()
readLine()
resetColor()
setBgColor()
setCharset()
setColor()
setPos()
showCursor()
write()
writeAt()
writeBox()
writeLine()
writeText()
writeTextBlock()
getColorCode()
restoreTTYMode()
runModeCommand()
setTTYMode()
$ansiColorMap
$charset
$hasMBString
$lastTTYMode
$posX
$posY
FILL_BLOCK
FILL_NONE
FILL_SHADE_DARK
FILL_SHADE_LIGHT
FILL_SHADE_MEDIUM
LINE_BLOCK
LINE_DOUBLE
LINE_NONE
LINE_SINGLE
Common console adapter codebase
todo | Add GNU readline support |
---|---|
link | http://en.wikipedia.org/wiki/ANSI_escape_code |
clear()
clearLine()
inherited_from | \Zend\Console\Adapter\AbstractAdapter::clearLine() |
---|
clearScreen()
inherited_from | \Zend\Console\Adapter\AbstractAdapter::clearScreen() |
---|
colorize(string $string, int $color, null | int $bgColor) : string
string
int
nullint
\Zend\Console\Exception\BadMethodCallException |
---|
string
getCharset() : \Zend\Console\Charset\CharsetInterface
getDefaultCharset() : \Zend\Console\Charset\CharsetInterface
getHeight() : false | int
false
int
getSize() : array
inherited_from | \Zend\Console\Adapter\AbstractAdapter::getSize() |
---|
array
array($width, $height)getTitle() : string
inherited_from | \Zend\Console\Adapter\AbstractAdapter::getTitle() |
---|
string
getWidth() : int
int
isUtf8() : bool
bool
readChar(string | null $mask) : string
stringnull
A list of allowed chars
string
readLine(int $maxLength) : string
inherited_from | \Zend\Console\Adapter\AbstractAdapter::readLine() |
---|
int
Maximum response length
string
resetColor()
setBgColor(int $bgColor)
setCharset(\Zend\Console\Charset\CharsetInterface $charset)
setColor(int $color)
setPos(int $x, int $y)
int
int
showCursor()
write(string $text, null | int $color, null | int $bgColor)
inherited_from | \Zend\Console\Adapter\AbstractAdapter::write() |
---|
string
nullint
nullint
writeAt(string $text, int $x, int $y, null | int $color, null | int $bgColor)
inherited_from | \Zend\Console\Adapter\AbstractAdapter::writeAt() |
---|
string
Text to write
int
Console X coordinate (column)
int
Console Y coordinate (row)
nullint
nullint
writeBox(int $x1, int $y1, int $x2, int $y2, int $lineStyle, int $fillStyle, int $color, int $bgColor, null | int $fillColor, null | int $fillBgColor)
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).
inherited_from | \Zend\Console\Adapter\AbstractAdapter::writeBox() |
---|
int
Top-left corner X coordinate (column)
int
Top-left corner Y coordinate (row)
int
Bottom-right corner X coordinate (column)
int
Bottom-right corner Y coordinate (row)
int
(optional) Box border style.
int
(optional) Box fill style or a single character to fill it with.
int
(optional) Foreground color
int
(optional) Background color
nullint
(optional) Foreground color of box fill
nullint
(optional) Background color of box fill
\Zend\Console\Exception\BadMethodCallException |
if coordinates are invalid |
---|
writeLine(string $text, null | int $color, null | int $bgColor)
This override works around a bug in some terminals that cause the background color to fill the next line after EOL. To remedy this, we are sending the colored string with appropriate color reset sequences before sending EOL character.
link | https://github.com/zendframework/zf2/issues/4167 |
---|
string
nullint
nullint
writeText(string $text, null | int $color, null | int $bgColor)
inherited_from | \Zend\Console\Adapter\AbstractAdapter::writeText() |
---|
string
nullint
nullint
writeTextBlock(string $text, int $width, int | null $height, int $x, int $y, null | int $color, null | int $bgColor)
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.
inherited_from | \Zend\Console\Adapter\AbstractAdapter::writeTextBlock() |
---|
string
Text to write
int
Maximum block width. Negative value means distance from right edge.
intnull
Maximum block height. Negative value means distance from bottom edge.
int
Block X coordinate (column)
int
Block Y coordinate (row)
nullint
(optional) Text color
nullint
(optional) Text background color
getColorCode(null | int | \Zend\Console\Color\Xterm256 $color, $type) : string
nullint\Zend\Console\Color\Xterm256
\Zend\Console\Exception\BadMethodCallException |
---|
string
restoreTTYMode() : void
runModeCommand() : void
$ansiColorMap : array
$hasMBString : null | bool
$lastTTYMode : string | null
$posX : int
inherited_from | \Zend\Console\Adapter\AbstractAdapter::$$posX |
---|
$posY : int
inherited_from | \Zend\Console\Adapter\AbstractAdapter::$$posY |
---|
FILL_BLOCK
inherited_from | \Zend\Console\Adapter\AdapterInterface::FILL_BLOCK |
---|---|
inherited_from | \Zend\Console\Adapter\AbstractAdapter::FILL_BLOCK |
FILL_NONE
inherited_from | \Zend\Console\Adapter\AdapterInterface::FILL_NONE |
---|---|
inherited_from | \Zend\Console\Adapter\AbstractAdapter::FILL_NONE |
FILL_SHADE_DARK
inherited_from | \Zend\Console\Adapter\AdapterInterface::FILL_SHADE_DARK |
---|---|
inherited_from | \Zend\Console\Adapter\AbstractAdapter::FILL_SHADE_DARK |
FILL_SHADE_LIGHT
inherited_from | \Zend\Console\Adapter\AdapterInterface::FILL_SHADE_LIGHT |
---|---|
inherited_from | \Zend\Console\Adapter\AbstractAdapter::FILL_SHADE_LIGHT |
FILL_SHADE_MEDIUM
inherited_from | \Zend\Console\Adapter\AdapterInterface::FILL_SHADE_MEDIUM |
---|---|
inherited_from | \Zend\Console\Adapter\AbstractAdapter::FILL_SHADE_MEDIUM |
LINE_BLOCK
inherited_from | \Zend\Console\Adapter\AdapterInterface::LINE_BLOCK |
---|---|
inherited_from | \Zend\Console\Adapter\AbstractAdapter::LINE_BLOCK |
LINE_DOUBLE
inherited_from | \Zend\Console\Adapter\AdapterInterface::LINE_DOUBLE |
---|---|
inherited_from | \Zend\Console\Adapter\AbstractAdapter::LINE_DOUBLE |
LINE_NONE
inherited_from | \Zend\Console\Adapter\AdapterInterface::LINE_NONE |
---|---|
inherited_from | \Zend\Console\Adapter\AbstractAdapter::LINE_NONE |
LINE_SINGLE
inherited_from | \Zend\Console\Adapter\AdapterInterface::LINE_SINGLE |
---|---|
inherited_from | \Zend\Console\Adapter\AbstractAdapter::LINE_SINGLE |