Class Symfony\Component\Console\Helper\DebugFormatterHelper

InheritanceSymfony\Component\Console\Helper\DebugFormatterHelper » Symfony\Component\Console\Helper\Helper
ImplementsSymfony\Component\Console\Helper\HelperInterface

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.

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$helperSet Symfony\Component\Console\Helper\Helper

Method Details

getName() public method

{@inheritdoc}

public void getName ( )
progress() public method

Adds progress to a formatting session.

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

The id of the formatting session

$buffer string

The message to display

$error bool

Whether to consider the buffer as error

$prefix string

The prefix for output

$errorPrefix string

The prefix for error output

start() public method

Starts a debug formatting session.

public string start ( $id, $message, $prefix 'RUN' )
$id string

The id of the formatting session

$message string

The message to display

$prefix string

The prefix to use

stop() public method

Stops a formatting session.

public string stop ( $id, $message, $successful, $prefix 'RES' )
$id string

The id of the formatting session

$message string

The message to display

$successful bool

Whether to consider the result as success

$prefix string

The prefix for the end output