FormatterHelper Class Reference

Inheritance diagram for FormatterHelper:

Public Member Functions
	formatSection ($section, $message, $style= 'info')
	formatBlock ($messages, $style, $large=false)
	getName ()
Public Member Functions inherited from Helper
	setHelperSet (HelperSet $helperSet=null)
	getHelperSet ()

Additional Inherited Members
Static Public Member Functions inherited from Helper
static	strlen ($string)
static	formatTime ($secs)
static	formatMemory ($memory)
static	strlenWithoutDecoration (OutputFormatterInterface $formatter, $string)
Protected Attributes inherited from Helper
	$helperSet = null

Detailed Description

The Formatter class provides helpers to format messages.

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 21 of file FormatterHelper.php.

Member Function Documentation

formatBlock	(		$messages,
			$style,
			$large = false
	)

Formats a message as a block of text.

Parameters

string | array	$messages	The message to write in the block
string	$style	The style to apply to the whole block
bool	$large	Whether to return a large block

Returns

string The formatter message

Definition at line 46 of file FormatterHelper.php.

References OutputFormatter\escape(), and Helper\strlen().

formatSection	(		$section,
			$message,
			$style = 'info'
	)

Formats a message within a section.

Parameters

string	$section	The section name
string	$message	The message
string	$style	The style to apply to the section

Returns

string The format section

Definition at line 32 of file FormatterHelper.php.

getName

(

)

{Returns the canonical name of this helper.

Returns

string The canonical name

}

Implements HelperInterface.

Definition at line 78 of file FormatterHelper.php.