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 Output

Base class for output classes.

There are three levels of verbosity:
* normal: no option passed (normal output - information) * verbose: -v (more output - debug) * quiet: -q (no output)

Symfony\Component\Console\Output\Output implements Symfony\Component\Console\Output\OutputInterface

Direct known subclasses

Symfony\Component\Console\Output\NullOutput, Symfony\Component\Console\Output\StreamOutput

Indirect known subclasses

Symfony\Component\Console\Output\ConsoleOutput
Abstract
Namespace: Symfony\Component\Console\Output
Author: Fabien Potencier <fabien@symfony.com>
Api
Located at console/Symfony/Component/Console/Output/Output.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

Api

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

Sets output formatter.

Sets output formatter.

Parameters

$formatter
Symfony\Component\Console\Formatter\OutputFormatterInterface
$formatter

Api

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

Api

Implementation of

Symfony\Component\Console\Output\OutputInterface::getFormatter()
public
# setDecorated( Boolean $decorated )

Sets the decorated flag.

Sets the decorated flag.

Parameters

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

Api

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

Api

Implementation of

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

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

Api

Implementation of

Symfony\Component\Console\Output\OutputInterface::getVerbosity()
public
# writeln( string|array $messages, integer $type = 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
string|array
$messages The message as an array of lines or a single string
$type
integer
$type The type of output

Api

Implementation of

Symfony\Component\Console\Output\OutputInterface::writeln()
public
# write( string|array $messages, Boolean $newline = false, integer $type = 0 )

Writes a message to the output.

Writes a message to the output.

Parameters

$messages
string|array
$messages The message as an array of lines or a single string
$newline
Boolean
$newline Whether to add a newline or not
$type
integer
$type The type of output

Throws

InvalidArgumentException
When unknown output type is given

Api

Implementation of

Symfony\Component\Console\Output\OutputInterface::write()
abstract protected
# doWrite( string $message, Boolean $newline )

Writes a message to the output.

Writes a message to the output.

Parameters

$message
string
$message A message to write to the output
$newline
Boolean
$newline Whether to add a newline or not
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