Overview

Namespaces

  • Contrib
    • Bundle
      • CoverallsBundle
        • Console
        • Entity
      • CoverallsV1Bundle
        • Api
        • Collector
        • Command
        • Config
        • Entity
          • Git
    • Component
      • File
      • Log
      • System
        • Git
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP
  • Psr
    • Log
  • Symfony
    • Component
      • Config
        • Definition
          • Builder
          • Exception
        • Exception
        • Loader
        • Resource
        • Util
      • Console
        • Command
        • Formatter
        • Helper
        • Input
        • Output
        • Tester
      • EventDispatcher
        • Debug
      • Finder
        • Adapter
        • Comparator
        • Exception
        • Expression
        • Iterator
        • Shell
      • Stopwatch
      • Yaml
        • Exception

Classes

  • ConsoleOutput
  • NullOutput
  • Output
  • StreamOutput

Interfaces

  • ConsoleOutputInterface
  • OutputInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

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>
Api
Located at console/Symfony/Component/Console/Output/ConsoleOutput.php
Methods summary
public
# __construct( integer $verbosity = Symfony\Component\Console\Output\OutputInterface::VERBOSITY_NORMAL, Boolean $decorated = null, Symfony\Component\Console\Formatter\OutputFormatterInterface $formatter = null )

Constructor.

Constructor.

Parameters

$verbosity
integer
$verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, self::VERBOSITY_VERBOSE)
$decorated
Boolean
$decorated Whether to decorate messages or not (null for auto-guessing)
$formatter
Symfony\Component\Console\Formatter\OutputFormatterInterface
$formatter Output formatter instance

Throws

InvalidArgumentException
When first argument is not a real stream

Api

Overrides

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

Sets the decorated flag.

Sets the decorated flag.

Parameters

$decorated
Boolean
$decorated Whether to decorate the messages or not

Api

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
Symfony\Component\Console\Formatter\OutputFormatterInterface
$formatter

Api

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
integer
$level The level of verbosity

Api

Overrides

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

Implementation of

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

Returns

Symfony\Component\Console\Output\OutputInterface

Implementation of

Symfony\Component\Console\Output\ConsoleOutputInterface::getErrorOutput()
public
# setErrorOutput( Symfony\Component\Console\Output\OutputInterface $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.

IBM iSeries (OS400) exhibits character-encoding issues when writing to STDOUT and doesn't properly convert ASCII to EBCDIC, resulting in garbage output.

Returns

boolean
Methods inherited from Symfony\Component\Console\Output\StreamOutput
doWrite(), getStream(), hasColorSupport()
Methods inherited from Symfony\Component\Console\Output\Output
getFormatter(), getVerbosity(), isDecorated(), write(), writeln()
Constants inherited from Symfony\Component\Console\Output\OutputInterface
OUTPUT_NORMAL, OUTPUT_PLAIN, OUTPUT_RAW, VERBOSITY_NORMAL, VERBOSITY_QUIET, VERBOSITY_VERBOSE
php-coveralls API documentation generated by ApiGen 2.8.0