\Pop\ConsoleConsole

__construct()

__construct(integer  $width = 80, string  $indent = '    ') 

Instantiate a new console object

Parameters

setWidth()

setWidth(integer  $width) : \Pop\Console\Console

Set the wrap width of the console object

Parameters

Returns

setIndent()

setIndent(string  $indent = null) : \Pop\Console\Console

Set the indentation of the console object

Parameters

Returns

setHeader()

setHeader(string  $header) : \Pop\Console\Console

Set the console header

Parameters

Returns

setFooter()

setFooter(string  $footer) : \Pop\Console\Console

Set the console footer

Parameters

Returns

setHeaderSent()

setHeaderSent(boolean  $headerSent = true) : \Pop\Console\Console

Set the console header sent flag

Parameters

Returns

setHelpColors()

setHelpColors(integer  $color1, integer  $color2 = null, integer  $color3 = null) : \Pop\Console\Console

Set the console help colors

Parameters

Returns

getWidth()

getWidth() : integer

Get the wrap width of the console object

Returns

getIndent()

getIndent() : string

Get the indentation of the console object

Returns

getHeader()

getHeader(boolean  $formatted = false) : string

Get the console header

Parameters

Returns

getFooter()

getFooter(boolean  $formatted = false) : string

Get the console footer

Parameters

Returns

getHeaderSent()

getHeaderSent() : boolean

Get the console header sent flag

Returns

getHelpColors()

getHelpColors() : array

Get the console help colors

Returns

getServer()

getServer(string  $key = null) : string|array

Get a value from $_SERVER, or the whole array

Parameters

Returns

getEnv()

getEnv(string  $key = null) : string|array

Get a value from $_ENV, or the whole array

Parameters

Returns

addCommand()

addCommand(\Pop\Console\Command  $command) : \Pop\Console\Console

Add a command

Parameters

Returns

addCommands()

addCommands(array  $commands) : \Pop\Console\Console

Add commands

Parameters

Returns

getCommands()

getCommands() : array

Get commands

Returns

getCommand()

getCommand(string  $command) : \Pop\Console\Command

Get a command

Parameters

Returns

hasCommand()

hasCommand(string  $command) : boolean

Check if the console object has a command

Parameters

Returns

getCommandsFromRoutes()

getCommandsFromRoutes(\Pop\Router\Match\Cli  $routeMatch, string  $scriptName = null) : array

Get commands from routes

Parameters

Returns

addCommandsFromRoutes()

addCommandsFromRoutes(\Pop\Router\Match\Cli  $routeMatch, string  $scriptName = null) : \Pop\Console\Console

Add commands from routes

Parameters

Returns

help()

help(string  $command = null) : string

Get a help

Parameters

Returns

colorize()

colorize(string  $string, integer  $fg = null, integer  $bg = null) : string

Colorize a string for output

Parameters

Returns

prompt()

prompt(string  $prompt, array  $options = null, boolean  $caseSensitive = false, integer  $length = 500, boolean  $withHeaders = true) : string

Get input from the prompt

Parameters

Returns

append()

append(string  $text = null, boolean  $newline = true) : \Pop\Console\Console

Append a string of text to the response body

Parameters

Returns

write()

write(string  $text = null, boolean  $newline = true, boolean  $withHeaders = true) : \Pop\Console\Console

Write a string of text to the response body and send the response

Parameters

Returns

send()

send(boolean  $withHeaders = true) : \Pop\Console\Console

Send the response

Parameters

Returns

displayHelp()

displayHelp() : void

Display console help

clear()

clear() : void

Clear the console

getColorCode()

getColorCode(integer  $color, string  $type = 'foreground') : mixed

Get the color code from the color map

Parameters

Returns

formatTemplate()

formatTemplate(string  $template) : string

Format header or footer template

Parameters

Returns