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 FormatterHelper

The Formatter class provides helpers to format messages.

Symfony\Component\Console\Helper\Helper implements Symfony\Component\Console\Helper\HelperInterface
Extended by Symfony\Component\Console\Helper\FormatterHelper
Namespace: Symfony\Component\Console\Helper
Author: Fabien Potencier fabien@symfony.com
Located at Helper/FormatterHelper.php
Methods summary
public string
# formatSection( string $section, string $message, string $style = 'info' )

Formats a message within a section.

Formats a message within a section.

Parameters

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

Returns

string
The format section
public string
# formatBlock( string|array $messages, string $style, boolean $large = false )

Formats a message as a block of text.

Formats a message as a block of text.

Parameters

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

Returns

string
The formatter message
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