OutputFormatterInterface Interface Reference

Inheritance diagram for OutputFormatterInterface:

Public Member Functions
	setDecorated ($decorated)
	isDecorated ()
	setStyle ($name, OutputFormatterStyleInterface $style)
	hasStyle ($name)
	getStyle ($name)
	format ($message)

Detailed Description

Formatter interface for console output.

Author

Konstantin Kudryashov ever..nosp@m.zet@.nosp@m.gmail.nosp@m..com

Definition at line 21 of file OutputFormatterInterface.php.

Member Function Documentation

format

(

$message

)

Formats a message according to the given styles.

Parameters

string

$message

The message to style

Returns

string The styled message

Implemented in OutputFormatter.

Referenced by Helper\strlenWithoutDecoration().

getStyle

(

$name

)

Gets style options from style with specified name.

Parameters

string

$name

Returns

OutputFormatterStyleInterface

Implemented in OutputFormatter.

hasStyle

(

$name

)

Checks if output formatter has style with specified name.

Parameters

string

$name

Returns

bool

Implemented in OutputFormatter.

isDecorated

(

)

Gets the decorated flag.

Returns

bool true if the output will decorate messages, false otherwise

Implemented in OutputFormatter.

Referenced by Helper\strlenWithoutDecoration().

setDecorated

(

$decorated

)

Sets the decorated flag.

Parameters

bool

$decorated

Whether to decorate the messages or not

Implemented in OutputFormatter.

Referenced by Helper\strlenWithoutDecoration().

setStyle	(		$name,
		OutputFormatterStyleInterface	$style
	)

Sets a new style.

Parameters

string	$name	The style name
OutputFormatterStyleInterface	$style	The style instance

Implemented in OutputFormatter.