Zend\Console\Adapter\AdapterInterface
Synopsis
interface AdapterInterface
{
- // constants
- const LINE_NONE = 1;
- const LINE_SINGLE = 2;
- const LINE_DOUBLE = 3;
- const LINE_BLOCK = 4;
- const FILL_NONE = 0;
- const FILL_SHADE_LIGHT = 1;
- const FILL_SHADE_MEDIUM = 2;
- const FILL_SHADE_DARK = 3;
- const FILL_BLOCK = 10;
- // methods
- public void write()
- public void writeText()
- public void writeLine()
- public void writeAt()
- public void writeBox()
- public void writeTextBlock()
- public int getWidth()
- public int getHeight()
- public array getSize()
- public bool isUtf8()
- public void setPos()
- public void hideCursor()
- public void showCursor()
- public string getTitle()
- public void colorize()
- public void setColor()
- public void setBgColor()
- public void resetColor()
- public void setCharset()
- public CharsetInterface getCharset()
- public CharsetInterface getDefaultCharset()
- public void clear()
- public void clearLine()
- public void clearScreen()
- public string readLine()
- public string readChar()
Constants
Name | Value |
---|---|
LINE_NONE | 1 |
LINE_SINGLE | 2 |
LINE_DOUBLE | 3 |
LINE_BLOCK | 4 |
FILL_NONE | 0 |
FILL_SHADE_LIGHT | 1 |
FILL_SHADE_MEDIUM | 2 |
FILL_SHADE_DARK | 3 |
FILL_BLOCK | 10 |
Methods
public
- clear() — Clear console screen
- clearLine() — Clear line at cursor position
- clearScreen() — Clear console screen
- colorize() — Prepare a string that will be rendered in color.
- getCharset() — Get charset currently in use by this adapter.
- getDefaultCharset()
- getHeight() — Determine and return current console height.
- getSize() — Determine and return current console width and height.
- getTitle() — Return current console window title.
- getWidth() — Determine and return current console width.
- hideCursor() — Hide console cursor
- isUtf8() — Check if console is UTF-8 compatible
- readChar() — Read a single character from the console input
- readLine() — Read a single line from the console input
- resetColor() — Reset color to console default.
- setBgColor() — Change current drawing background color
- setCharset() — Set Console charset to use.
- setColor() — Change current drawing color.
- setPos() — Set cursor position
- showCursor() — Show console cursor
- write() — Write a chunk of text to console.
- writeAt() — Write a piece of text at the coordinates of $x and $y
- writeBox() — Write a box at the specified coordinates.
- writeLine() — Write a single line of text to console and advance cursor to the next line.
- writeText() — Alias for write()
- writeTextBlock() — Write a block of text at the given coordinates, matching the supplied width and height.