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

Class ConsoleOutput

ConsoleOutput is the default class for all CLI output. It uses STDOUT.

This class is a convenient wrapper around StreamOutput. $output = new ConsoleOutput();

This is equivalent to: $output = new StreamOutput(fopen('php://stdout', 'w'));

Symfony\Component\Console\Output\Output implements Symfony\Component\Console\Output\OutputInterface
Extended by Symfony\Component\Console\Output\StreamOutput
Extended by Symfony\Component\Console\Output\ConsoleOutput implements Symfony\Component\Console\Output\ConsoleOutputInterface
Namespace: Symfony\Component\Console\Output
Author: Fabien Potencier fabien@symfony.com
Located at Output/ConsoleOutput.php
Methods summary
public
# __construct( integer $verbosity = self::VERBOSITY_NORMAL, boolean|null $decorated = null, Symfony\Component\Console\Formatter\OutputFormatterInterface $formatter = null )

Constructor.

Constructor.

Parameters

$verbosity
The verbosity level (one of the VERBOSITY constants in OutputInterface)
$decorated
Whether to decorate messages (null for auto-guessing)
$formatter
Output formatter instance (null to use default OutputFormatter)

Throws

InvalidArgumentException
When first argument is not a real stream

Overrides

Symfony\Component\Console\Output\StreamOutput::__construct()
public
# setDecorated( boolean $decorated )

Sets the decorated flag.

Sets the decorated flag.

Parameters

$decorated
Whether to decorate the messages

Overrides

Symfony\Component\Console\Output\Output::setDecorated()

Implementation of

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

Sets output formatter.

Sets output formatter.

Parameters

$formatter

Overrides

Symfony\Component\Console\Output\Output::setFormatter()

Implementation of

Symfony\Component\Console\Output\OutputInterface::setFormatter()
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)

Overrides

Symfony\Component\Console\Output\Output::setVerbosity()

Implementation of

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

Gets the OutputInterface for errors.

Gets the OutputInterface for errors.

Returns

Symfony\Component\Console\Output\OutputInterface

Implementation of

Symfony\Component\Console\Output\ConsoleOutputInterface::getErrorOutput()
public
# setErrorOutput( Symfony\Component\Console\Output\OutputInterface $error )

Sets the OutputInterface used for errors.

Sets the OutputInterface used for errors.

Parameters

$error

Implementation of

Symfony\Component\Console\Output\ConsoleOutputInterface::setErrorOutput()
protected boolean
# hasStdoutSupport( )

Returns true if current environment supports writing console output to STDOUT.

Returns true if current environment supports writing console output to STDOUT.

Returns

boolean
protected boolean
# hasStderrSupport( )

Returns true if current environment supports writing console output to STDERR.

Returns true if current environment supports writing console output to STDERR.

Returns

boolean
Methods inherited from Symfony\Component\Console\Output\StreamOutput
doWrite(), getStream(), hasColorSupport()
Methods inherited from Symfony\Component\Console\Output\Output
getFormatter(), getVerbosity(), isDebug(), isDecorated(), isQuiet(), isVerbose(), isVeryVerbose(), write(), writeln()
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