Overview

Namespaces

  • Evenement
  • None
  • Peridot
    • Console
    • Core
    • Reporter
    • Runner
    • Scope
    • Test
  • Symfony
    • Component
      • Console
        • Command
        • Descriptor
        • Event
        • Exception
        • Formatter
        • Helper
        • Input
        • Logger
        • Output
        • Question
        • Style
        • Tester
        • Tests
          • Command
          • Descriptor
          • Fixtures
          • Formatter
          • Helper
          • Input
          • Logger
          • Output
          • Style
          • Tester

Classes

  • DebugFormatterHelper
  • DescriptorHelper
  • DialogHelper
  • FormatterHelper
  • Helper
  • HelperSet
  • InputAwareHelper
  • ProcessHelper
  • ProgressBar
  • ProgressHelper
  • ProgressIndicator
  • QuestionHelper
  • SymfonyQuestionHelper
  • Table
  • TableCell
  • TableHelper
  • TableSeparator
  • TableStyle

Interfaces

  • HelperInterface
  • Overview
  • Namespace
  • Class

Class DebugFormatterHelper

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.

Symfony\Component\Console\Helper\Helper implements Symfony\Component\Console\Helper\HelperInterface
Extended by Symfony\Component\Console\Helper\DebugFormatterHelper
Namespace: Symfony\Component\Console\Helper
Author: Fabien Potencier fabien@symfony.com
Located at Helper/DebugFormatterHelper.php
Methods summary
public string
# start( string $id, string $message, string $prefix = 'RUN' )

Starts a debug formatting session.

Starts a debug formatting session.

Parameters

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

Returns

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

Adds progress to a formatting session.

Adds progress to a formatting session.

Parameters

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

Returns

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

Stops a formatting session.

Stops a formatting session.

Parameters

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

Returns

string
public string
# getName( )

Returns the canonical name of this helper.

Returns the canonical name of this helper.

Returns

string
The canonical name
Methods inherited from Symfony\Component\Console\Helper\Helper
formatMemory(), formatTime(), getHelperSet(), setHelperSet(), strlen(), strlenWithoutDecoration()
Properties inherited from Symfony\Component\Console\Helper\Helper
$helperSet
Peridot API documentation generated by ApiGen