Documentation

OutputFormatter
in package
implements WrappableOutputFormatterInterface

Formatter class for console output.

Tags
author

Konstantin Kudryashov ever.zet@gmail.com

author

Roland Franssen franssen.roland@gmail.com

Interfaces, Classes and Traits

WrappableOutputFormatterInterface
Formatter interface for console output that supports word wrapping.

Table of Contents

$decorated  : mixed
$styles  : mixed
$styleStack  : mixed
__clone()  : mixed
__construct()  : mixed
Initializes console output formatter.
escape()  : string
Escapes "<" special char in given text.
format()  : mixed
{@inheritdoc}
formatAndWrap()  : mixed
Formats a message according to the given styles, wrapping at `$width` (0 means no wrapping).
getStyle()  : mixed
{@inheritdoc}
getStyleStack()  : OutputFormatterStyleStack
hasStyle()  : mixed
{@inheritdoc}
isDecorated()  : mixed
{@inheritdoc}
setDecorated()  : mixed
{@inheritdoc}
setStyle()  : mixed
{@inheritdoc}
applyCurrentStyle()  : string
Applies current style from stack to text, if must be applied.
createStyleFromString()  : OutputFormatterStyleInterface|null
Tries to create new style instance from string.

Properties

Methods

escape()

Escapes "<" special char in given text.

public static escape(string $text) : string
Parameters
$text : string
Return values
string

Escaped text

format()

{@inheritdoc}

public format(string|null $message) : mixed
Parameters
$message : string|null
Return values
mixed

formatAndWrap()

Formats a message according to the given styles, wrapping at `$width` (0 means no wrapping).

public formatAndWrap(string|null $message, int $width) : mixed
Parameters
$message : string|null
$width : int
Return values
mixed

getStyle()

{@inheritdoc}

public getStyle(string $name) : mixed
Parameters
$name : string
Return values
mixed

hasStyle()

{@inheritdoc}

public hasStyle(string $name) : mixed
Parameters
$name : string
Return values
mixed

isDecorated()

{@inheritdoc}

public isDecorated() : mixed
Return values
mixed

setDecorated()

{@inheritdoc}

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

applyCurrentStyle()

Applies current style from stack to text, if must be applied.

private applyCurrentStyle(string $text, string $current, int $width, int &$currentLineLength) : string
Parameters
$text : string
$current : string
$width : int
$currentLineLength : int
Return values
string

Search results