Documentation

OutputStyle
in package
implements OutputInterface, StyleInterface

Decorates output to add console style guide helpers.

Tags
author

Kevin Bond kevinbond@gmail.com

Interfaces, Classes and Traits

OutputInterface
OutputInterface is the interface implemented by all Output classes.
StyleInterface
Output style helpers.

Table of Contents

$output  : mixed
__construct()  : mixed
createProgressBar()  : ProgressBar
getFormatter()  : OutputFormatterInterface
Returns current output formatter instance.
getVerbosity()  : int
Gets the current verbosity of the output.
isDebug()  : bool
Returns whether verbosity is debug (-vvv).
isDecorated()  : bool
Gets the decorated flag.
isQuiet()  : bool
Returns whether verbosity is quiet (-q).
isVerbose()  : bool
Returns whether verbosity is verbose (-v).
isVeryVerbose()  : bool
Returns whether verbosity is very verbose (-vv).
newLine()  : mixed
Add newline(s).
setDecorated()  : mixed
Sets the decorated flag.
setFormatter()  : mixed
setVerbosity()  : mixed
Sets the verbosity of the output.
write()  : mixed
Writes a message to the output.
writeln()  : mixed
Writes a message to the output and adds a newline at the end.
getErrorOutput()  : mixed

Properties

Methods

getVerbosity()

Gets the current verbosity of the output.

public getVerbosity() : int
Return values
int

The current level of verbosity (one of the VERBOSITY constants)

isDebug()

Returns whether verbosity is debug (-vvv).

public isDebug() : bool
Return values
bool

true if verbosity is set to VERBOSITY_DEBUG, false otherwise

isDecorated()

Gets the decorated flag.

public isDecorated() : bool
Return values
bool

true if the output will decorate messages, false otherwise

isQuiet()

Returns whether verbosity is quiet (-q).

public isQuiet() : bool
Return values
bool

true if verbosity is set to VERBOSITY_QUIET, false otherwise

isVerbose()

Returns whether verbosity is verbose (-v).

public isVerbose() : bool
Return values
bool

true if verbosity is set to VERBOSITY_VERBOSE, false otherwise

isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

public isVeryVerbose() : bool
Return values
bool

true if verbosity is set to VERBOSITY_VERY_VERBOSE, false otherwise

newLine()

Add newline(s).

public newLine([int $count = 1 ]) : mixed
Parameters
$count : int = 1
Return values
mixed

setDecorated()

Sets the decorated flag.

public setDecorated(bool $decorated) : mixed
Parameters
$decorated : bool
Return values
mixed

setVerbosity()

Sets the verbosity of the output.

public setVerbosity(int $level) : mixed
Parameters
$level : int
Return values
mixed

write()

Writes a message to the output.

public write(mixed $messages[, bool $newline = false ][, int $type = self::OUTPUT_NORMAL ]) : mixed
Parameters
$messages : mixed

The message as an iterable of strings or a single string

$newline : bool = false

Whether to add a newline

$type : int = self::OUTPUT_NORMAL
Return values
mixed

writeln()

Writes a message to the output and adds a newline at the end.

public writeln(mixed $messages[, int $type = self::OUTPUT_NORMAL ]) : mixed
Parameters
$messages : mixed

The message as an iterable of strings or a single string

$type : int = self::OUTPUT_NORMAL
Return values
mixed

getErrorOutput()

protected getErrorOutput() : mixed
Return values
mixed

Search results