Interface Symfony\Component\Console\Formatter\OutputFormatterInterface

Implemented bySymfony\Component\Console\Formatter\OutputFormatter

Formatter interface for console output.

Method Details

format() public abstract method

Formats a message according to the given styles.

public abstract string format ( $message )
$message string

The message to style

return string

The styled message

getStyle() public abstract method

Gets style options from style with specified name.

public abstract Symfony\Component\Console\Formatter\OutputFormatterStyleInterface getStyle ( $name )
$name string
hasStyle() public abstract method

Checks if output formatter has style with specified name.

public abstract bool hasStyle ( $name )
$name string
isDecorated() public abstract method

Gets the decorated flag.

public abstract bool isDecorated ( )
return bool

True if the output will decorate messages, false otherwise

setDecorated() public abstract method

Sets the decorated flag.

public abstract void setDecorated ( $decorated )
$decorated bool

Whether to decorate the messages or not

setStyle() public abstract method

Sets a new style.

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

The style name

$style Symfony\Component\Console\Formatter\OutputFormatterStyleInterface

The style instance