\Symfony\Component\Console\FormatterOutputFormatterInterface

Formatter interface for console output.

Summary

Methods

Constants

setDecorated()
isDecorated()
setStyle()
hasStyle()
getStyle()
format()

No constants found

No protected methods found

N/A

No private methods found

N/A

File: vendor/symfony/console/Formatter/OutputFormatterInterface.php
Package: \Default

Methods

setDecorated()

setDecorated(boolean  $decorated)

Sets the decorated flag.

Parameters

boolean

$decorated

Whether to decorate the messages or not

isDecorated()

isDecorated() : boolean

Gets the decorated flag.

Returns

boolean —

true if the output will decorate messages, false otherwise

setStyle()

setStyle(string  $name, \Symfony\Component\Console\Formatter\OutputFormatterStyleInterface  $style)

Sets a new style.

Parameters

string	$name	The style name
\Symfony\Component\Console\Formatter\OutputFormatterStyleInterface	$style	The style instance

hasStyle()

hasStyle(string  $name) : boolean

Checks if output formatter has style with specified name.

Parameters

string

$name

Returns

boolean

getStyle()

getStyle(string  $name) : \Symfony\Component\Console\Formatter\OutputFormatterStyleInterface

Gets style options from style with specified name.

Parameters

string

$name

Throws

\InvalidArgumentException: When style isn't defined

Returns

\Symfony\Component\Console\Formatter\OutputFormatterStyleInterface

format()

format(string  $message) : string

Formats a message according to the given styles.

Parameters

string

$message

The message to style

Returns

string —

The styled message