DebugFormatterHelper Class Reference

Inheritance diagram for DebugFormatterHelper:

Public Member Functions
	start ($id, $message, $prefix= 'RUN')
	progress ($id, $buffer, $error=false, $prefix= 'OUT', $errorPrefix= 'ERR')
	stop ($id, $message, $successful, $prefix= 'RES')
	getName ()
Public Member Functions inherited from Helper
	setHelperSet (HelperSet $helperSet=null)
	getHelperSet ()

Private Member Functions
	getBorder ($id)

Private Attributes
	$colors = array('black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white', 'default')
	$started = array()
	$count = -1

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

Helps outputting debug information when running an external program from a command.

An external program can be a Process, an HTTP request, or anything else.

Author

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

Definition at line 21 of file DebugFormatterHelper.php.

Member Function Documentation

getBorder (   $id )

private

Parameters

string

$id

The id of the formatting session

Returns

string

Definition at line 115 of file DebugFormatterHelper.php.

Referenced by DebugFormatterHelper\progress(), DebugFormatterHelper\start(), and DebugFormatterHelper\stop().

getName

(

)

{Returns the canonical name of this helper.

Returns

string The canonical name

}

Implements HelperInterface.

Definition at line 123 of file DebugFormatterHelper.php.

progress	(		$id,
			$buffer,
			$error = false,
			$prefix = 'OUT',
			$errorPrefix = 'ERR'
	)

Adds progress to a formatting session.

Parameters

string	$id	The id of the formatting session
string	$buffer	The message to display
bool	$error	Whether to consider the buffer as error
string	$prefix	The prefix for output
string	$errorPrefix	The prefix for error output

Returns

string

Definition at line 54 of file DebugFormatterHelper.php.

References DebugFormatterHelper\getBorder().

start	(		$id,
			$message,
			$prefix = 'RUN'
	)

Starts a debug formatting session.

Parameters

string	$id	The id of the formatting session
string	$message	The message to display
string	$prefix	The prefix to use

Returns

string

Definition at line 36 of file DebugFormatterHelper.php.

References DebugFormatterHelper\getBorder().

stop	(		$id,
			$message,
			$successful,
			$prefix = 'RES'
	)

Stops a formatting session.

Parameters

string	$id	The id of the formatting session
string	$message	The message to display
bool	$successful	Whether to consider the result as success
string	$prefix	The prefix for the end output

Returns

string

Definition at line 95 of file DebugFormatterHelper.php.

References DebugFormatterHelper\getBorder().

Member Data Documentation

$colors = array('black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white', 'default')

private

Definition at line 23 of file DebugFormatterHelper.php.

$count = -1

private

Definition at line 25 of file DebugFormatterHelper.php.

$started = array()

private

Definition at line 24 of file DebugFormatterHelper.php.