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

  • OutputStyle
  • SymfonyStyle

Interfaces

  • StyleInterface
  • Overview
  • Namespace
  • Class

Class OutputStyle

Decorates output to add console style guide helpers.

Symfony\Component\Console\Style\OutputStyle implements Symfony\Component\Console\Output\OutputInterface, Symfony\Component\Console\Style\StyleInterface

Direct known subclasses

Symfony\Component\Console\Style\SymfonyStyle

Indirect known subclasses

Symfony\Component\Console\Tests\Style\SymfonyStyleWithForcedLineLength
Abstract
Namespace: Symfony\Component\Console\Style
Author: Kevin Bond kevinbond@gmail.com
Located at Style/OutputStyle.php
Methods summary
public
# __construct( Symfony\Component\Console\Output\OutputInterface $output )

Parameters

$output
public
# newLine( integer $count = 1 )

Add newline(s).

Add newline(s).

Parameters

$count
The number of newlines

Implementation of

Symfony\Component\Console\Style\StyleInterface::newLine()
public Symfony\Component\Console\Helper\ProgressBar
# createProgressBar( integer $max = 0 )

Parameters

$max

Returns

Symfony\Component\Console\Helper\ProgressBar
public
# write( string|array $messages, boolean $newline = false, integer $type = self::OUTPUT_NORMAL )

Writes a message to the output.

Writes a message to the output.

Parameters

$messages
The message as an array of lines or a single string
$newline
Whether to add a newline
$type
$options A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL

Implementation of

Symfony\Component\Console\Output\OutputInterface::write()
public
# writeln( string|array $messages, integer $type = self::OUTPUT_NORMAL )

Writes a message to the output and adds a newline at the end.

Writes a message to the output and adds a newline at the end.

Parameters

$messages
The message as an array of lines of a single string
$type
$options A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL

Implementation of

Symfony\Component\Console\Output\OutputInterface::writeln()
public
# setVerbosity( integer $level )

Sets the verbosity of the output.

Sets the verbosity of the output.

Parameters

$level
The level of verbosity (one of the VERBOSITY constants)

Implementation of

Symfony\Component\Console\Output\OutputInterface::setVerbosity()
public integer
# getVerbosity( )

Gets the current verbosity of the output.

Gets the current verbosity of the output.

Returns

integer
The current level of verbosity (one of the VERBOSITY constants)

Implementation of

Symfony\Component\Console\Output\OutputInterface::getVerbosity()
public
# setDecorated( boolean $decorated )

Sets the decorated flag.

Sets the decorated flag.

Parameters

$decorated
Whether to decorate the messages

Implementation of

Symfony\Component\Console\Output\OutputInterface::setDecorated()
public boolean
# isDecorated( )

Gets the decorated flag.

Gets the decorated flag.

Returns

boolean
true if the output will decorate messages, false otherwise

Implementation of

Symfony\Component\Console\Output\OutputInterface::isDecorated()
public
# setFormatter( Symfony\Component\Console\Formatter\OutputFormatterInterface $formatter )

Sets output formatter.

Sets output formatter.

Parameters

$formatter

Implementation of

Symfony\Component\Console\Output\OutputInterface::setFormatter()
public Symfony\Component\Console\Formatter\OutputFormatterInterface
# getFormatter( )

Returns current output formatter instance.

Returns current output formatter instance.

Returns

Symfony\Component\Console\Formatter\OutputFormatterInterface

Implementation of

Symfony\Component\Console\Output\OutputInterface::getFormatter()
Methods inherited from Symfony\Component\Console\Style\StyleInterface
ask(), askHidden(), caution(), choice(), confirm(), error(), listing(), note(), progressAdvance(), progressFinish(), progressStart(), section(), success(), table(), text(), title(), warning()
Constants inherited from Symfony\Component\Console\Output\OutputInterface
OUTPUT_NORMAL, OUTPUT_PLAIN, OUTPUT_RAW, VERBOSITY_DEBUG, VERBOSITY_NORMAL, VERBOSITY_QUIET, VERBOSITY_VERBOSE, VERBOSITY_VERY_VERBOSE
Peridot API documentation generated by ApiGen