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

  • BufferedOutput
  • ConsoleOutput
  • NullOutput
  • Output
  • StreamOutput

Interfaces

  • ConsoleOutputInterface
  • OutputInterface
  • Overview
  • Namespace
  • Class

Interface OutputInterface

OutputInterface is the interface implemented by all Output classes.

Direct known implementers

Symfony\Component\Console\Output\ConsoleOutputInterface, Symfony\Component\Console\Output\NullOutput, Symfony\Component\Console\Output\Output, Symfony\Component\Console\Style\OutputStyle

Indirect known implementers

Symfony\Component\Console\Output\BufferedOutput, Symfony\Component\Console\Output\ConsoleOutput, Symfony\Component\Console\Output\StreamOutput, Symfony\Component\Console\Style\SymfonyStyle, Symfony\Component\Console\Tests\Fixtures\DummyOutput, Symfony\Component\Console\Tests\Output\TestOutput, Symfony\Component\Console\Tests\Style\SymfonyStyleWithForcedLineLength
Namespace: Symfony\Component\Console\Output
Author: Fabien Potencier fabien@symfony.com
Located at Output/OutputInterface.php
Methods summary
public
# write( string|array $messages, boolean $newline = false, integer $options = 0 )

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
$options
A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
public
# writeln( string|array $messages, integer $options = 0 )

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
$options
A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
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)
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)
public
# setDecorated( boolean $decorated )

Sets the decorated flag.

Sets the decorated flag.

Parameters

$decorated
Whether to decorate the messages
public boolean
# isDecorated( )

Gets the decorated flag.

Gets the decorated flag.

Returns

boolean
true if the output will decorate messages, false otherwise
public
# setFormatter( Symfony\Component\Console\Formatter\OutputFormatterInterface $formatter )

Sets output formatter.

Sets output formatter.

Parameters

$formatter
public Symfony\Component\Console\Formatter\OutputFormatterInterface
# getFormatter( )

Returns current output formatter instance.

Returns current output formatter instance.

Returns

Symfony\Component\Console\Formatter\OutputFormatterInterface
Constants summary
integer VERBOSITY_QUIET
# 16
integer VERBOSITY_NORMAL
# 32
integer VERBOSITY_VERBOSE
# 64
integer VERBOSITY_VERY_VERBOSE
# 128
integer VERBOSITY_DEBUG
# 256
integer OUTPUT_NORMAL
# 1
integer OUTPUT_RAW
# 2
integer OUTPUT_PLAIN
# 4
Peridot API documentation generated by ApiGen